panache 2.42.0

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

# Panache

A language server for Markdown, Quarto, and R Markdown.

## Quick start

1. Install the **Panache** extension.
2. Open a regular Markdown (`.md`, Pandoc-style), Quarto (`.qmd`), or R Markdown
   (`.Rmd`, `.rmd`) file.
3. The extension starts `panache lsp` automatically.

By default, the extension downloads a platform-specific `panache` binary from
GitHub releases on first use.

## Features

- Starts `panache lsp` automatically when you open supported documents.
- Formats documents using Panache's formatter, including Pandoc-style constructs
  such as fenced divs, tables, math, citations, and attributes.
- Surfaces Panache diagnostics and code actions in the editor (including
  auto-fixable lint rules such as heading hierarchy).
- Works for regular Markdown (`.md`, Pandoc-style), Quarto (`.qmd`), and R
  Markdown (`.Rmd`, `.rmd`).

## Commands

- `Panache: Restart Server` --- stops and restarts the Panache language server
  (re-reads settings and re-resolves the binary). Useful if the LSP gets wedged
  or after changing settings such as `panache.version` or
  `panache.executablePath`.

## Binary Installation

By default, the extension downloads a platform-specific `panache` binary from
GitHub releases and uses that binary for the language server. This is controlled
by `panache.executableStrategy`, which has three modes:

- `bundled` (default) --- download a platform-specific binary from GitHub
  releases.
- `environment` --- look for `panache` on the system `PATH`.
- `path` --- use the binary at `panache.executablePath`.

When `panache.version` is set to `latest`, the extension automatically skips
component-only tags and selects the most recent stable CLI release that contains
a matching platform asset.

You can also provide your own path to the binary:

```json
{
  "panache.executableStrategy": "path",
  "panache.executablePath": "/usr/local/bin/panache"
}
```

## Common setup examples

Use a local binary at a fixed path:

```json
{
  "panache.executableStrategy": "path",
  "panache.executablePath": "/usr/local/bin/panache"
}
```

Use whatever `panache` is on your `PATH`:

```json
{
  "panache.executableStrategy": "environment"
}
```

Pin to a specific release from a specific repository:

```json
{
  "panache.version": "2.20.0",
  "panache.githubRepo": "jolars/panache"
}
```

Use `panache.releaseTag` only if you need an exact tag override:

```json
{
  "panache.releaseTag": "v2.20.0"
}
```

## Requirements and troubleshooting

- **NixOS**: auto-download is skipped by default unless explicitly configured.
  Set `panache.executableStrategy` to `path` and provide
  `panache.executablePath`, or set it to `environment` if `panache` is on your
  `PATH`.
- **Offline / restricted networks / proxies**: set `panache.executableStrategy`
  to `path` (with `panache.executablePath`) or `environment`.
- If download fails, the extension shows a warning and falls back to looking up
  `panache` on the system `PATH`.
- The extension contributes `quarto` (`.qmd`) and `rmarkdown` (`.Rmd`, `.rmd`)
  language registrations, so it works even without installing a separate Quarto
  extension. If Quarto is also installed, both can coexist.

## Settings

Panache registers itself as the default formatter for `[quarto]` and
`[rmarkdown]` files. Plain `[markdown]` is left alone --- opt in with
`"editor.defaultFormatter": "jolars.panache"` in your settings if you want it.

- `panache.executableStrategy`: how to locate the `panache` binary --- `bundled`
  (default), `environment`, or `path`.
- `panache.executablePath`: path to the binary, used only when
  `executableStrategy` is `path`.
- `panache.version`: version to install (default: `"latest"`)
- `panache.releaseTag`: advanced exact tag override (takes precedence if
  explicitly set)
- `panache.githubRepo`: GitHub repo for downloads (default: `"jolars/panache"`)
- `panache.downloadBinary` *(deprecated)*: superseded by
  `panache.executableStrategy`.
- `panache.commandPath` *(deprecated)*: superseded by `panache.executablePath`
  (with `executableStrategy` set to `path`).
- `panache.serverArgs`: extra args after `panache lsp`
- `panache.serverEnv`: extra environment variables
- `panache.extraPath`: extra PATH entries prepended for the language server
  process
- `panache.logLevel`: log level for the language server, mapped to `RUST_LOG`
  (`off`, `error`, `warn`, `info`, `debug`, `trace`; unset by default).
  `panache.serverEnv.RUST_LOG` overrides this if both are set.
- `panache.trace.server`: LSP trace level (`off`, `messages`, `verbose`)
- `panache.experimental.incrementalParsing`: enable experimental incremental
  parsing in LSP (default: `false`)

If external tools (for example `air` for R code chunks) work in your terminal
but not inside the editor, set `panache.extraPath` to include their install
directory:

```json
{
  "panache.extraPath": ["C:\\Users\\<you>\\.local\\bin"]
}
```

## Security and trust

When `panache.executableStrategy` is `bundled` (the default), binaries are
downloaded from GitHub releases configured by `panache.githubRepo` and either
`panache.version` or `panache.releaseTag` (if explicitly set).

## Links

- Main repository: <https://github.com/jolars/panache>
- Documentation: <https://panache.bz/>