panache 2.43.1

An LSP, formatter, and linter for Markdown, Quarto, and R Markdown
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

---
title: "Integrations"
description: >
  This section provides instructions for integrating Panache with other tools,
  such as pre-commit hooks and GitHub actions, to automatically format and lint
  your documents on commit or pull request.
---

## Pre-Commit

[pre-commit](https://pre-commit.com/) is a framework for managing and
maintaining multi-language pre-commit hooks. It runs checks on your code before
each commit to ensure quality and consistency.

Create a `.pre-commit-config.yaml` file in your repository root:

```yaml
repos:
  - repo: https://github.com/jolars/panache
    rev: v{{< meta version >}}
    hooks:
      - id: panache-format
      - id: panache-lint
```

Then install the hooks:

```bash
pre-commit install
```

Panache provides two hook IDs:

`panache-format`
:   Automatically formats files according to Panache's formatting rules

`panache-lint`
:   Lints files and automatically applies fixes where possible

Pass additional arguments to Panache:

```yaml
repos:
  - repo: https://github.com/jolars/panache
    rev: v{{< meta version >}}
    hooks:
      - id: panache-format
        args: [--config, custom-config.toml]
```

### File Patterns

By default, hooks run on `.qmd`, `.md`, `.markdown`, `.mdown`, `mkd`, and `.Rmd`
files. You can override this with `files`, for instance to only run on `.qmd`
and `.Rmd`:

```yaml
repos:
  - repo: https://github.com/jolars/panache
    rev: v{{< meta version >}}
    hooks:
      - id: panache-format
        files: '\.(qmd|Rmd)$'
```

## GitHub Actions

Use the dedicated Panache action for a one-line setup:

```yaml
name: panache
on:
  pull_request:
  push:
    branches: [main]

jobs:
  format-and-lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: jolars/panache-action@v1
```

This workflow:

1. Installs Panache from official releases
2. Checks that all files are formatted (`--check` mode)
3. Runs the linter in CI mode (`--check` mode)

Both steps will fail (exit code 1) if issues are found, causing the workflow to
fail.

### Common options

Pin a specific Panache CLI release:

```yaml
- uses: jolars/panache-action@v1
  with:
    panache-version: v2.23.0
```

Run only one check:

```yaml
- uses: jolars/panache-action@v1
  with:
    lint: "false" # format only
```

```yaml
- uses: jolars/panache-action@v1
  with:
    format: "false" # lint only
```

### Manual setup (advanced)

If you prefer installing via Rust directly, you can keep using a manual
workflow:

```yaml
name: panache
on:
  pull_request:
  push:
    branches: [main]

jobs:
  format-and-lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Install Rust
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: 1.94

      - name: Cache cargo
        uses: actions/cache@v5
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
          key: ${{ runner.os }}-cargo-panache-${{ hashFiles('**/Cargo.lock') }}
      - name: Install panache
        run: cargo install panache --locked
      - name: Check formatting
        run: panache format --check .
      - name: Run linter
        run: panache lint --check .
```