panache 2.41.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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375

use panache::{
    config::{Config, Extensions, Flavor},
    format,
};

fn quarto_config() -> Config {
    let flavor = Flavor::Quarto;
    Config {
        flavor,
        extensions: Extensions::for_flavor(flavor),
        ..Default::default()
    }
}

fn rmarkdown_config() -> Config {
    let flavor = Flavor::RMarkdown;
    Config {
        flavor,
        extensions: Extensions::for_flavor(flavor),
        ..Default::default()
    }
}

#[test]
fn r_chunk_with_comma_separated_options() {
    let input = "```{r, echo=FALSE}\n1 + 1\n```\n";
    let output = format(input, Some(quarto_config()), None);

    // Should convert to hashpipe format in Quarto
    assert!(output.contains("```{r}"));
    assert!(output.contains("#| echo: false"));
    assert!(
        !output.contains("echo=\"FALSE\""),
        "Should not add quotes to boolean FALSE"
    );
}

#[test]
fn r_chunk_with_multiple_options() {
    let input = "```{r, echo=FALSE, warning=TRUE, message=FALSE}\nx <- 1\n```\n";
    let output = format(input, Some(quarto_config()), None);

    // All boolean values should be converted to hashpipe with lowercase
    assert!(output.contains("#| echo: false"));
    assert!(output.contains("#| warning: true"));
    assert!(output.contains("#| message: false"));
}

#[test]
fn r_chunk_with_quoted_string() {
    let input = "```{r, label=\"my chunk\", echo=FALSE}\ny <- 2\n```\n";
    let output = format(input, Some(quarto_config()), None);

    // Quoted strings should be converted to hashpipe, preserving quotes
    assert!(output.contains("#| label: \"my chunk\""));
    assert!(output.contains("#| echo: false"));
    assert!(!output.contains("echo=\"FALSE\""));
}

#[test]
fn r_chunk_without_spaces_after_commas() {
    let input = "```{r,echo=TRUE,warning=FALSE}\na <- 4\n```\n";
    let output = format(input, Some(quarto_config()), None);

    // Should convert to hashpipe format
    assert!(output.contains("#| echo: true"));
    assert!(output.contains("#| warning: false"));
}

#[test]
fn chunk_idempotency() {
    let input = "```{r, echo=FALSE, warning=TRUE}\nx <- 1\n```\n";
    let output1 = format(input, Some(quarto_config()), None);
    let output2 = format(&output1, Some(quarto_config()), None);

    assert_eq!(output1, output2, "Formatting should be idempotent");
}

#[test]
fn chunk_with_numeric_value() {
    let input = "```{r, fig.width=7, fig.height=5}\nplot(x)\n```\n";
    let output = format(input, Some(quarto_config()), None);

    // Numeric values should be converted to hashpipe with normalized names
    assert!(output.contains("#| fig-width: 7"));
    assert!(output.contains("#| fig-height: 5"));
}

#[test]
fn display_block_vs_executable_chunk() {
    let input_display = "```python\nprint('hello')\n```\n";
    let input_exec = "```{python}\nprint('hello')\n```\n";

    let output_display = format(input_display, Some(quarto_config()), None);
    let output_exec = format(input_exec, Some(quarto_config()), None);

    // Display blocks use shortcut syntax in Quarto flavor
    assert!(output_display.starts_with("```python"));
    assert!(!output_display.contains("{python}"));

    // Executable chunks keep braces
    assert!(output_exec.contains("```{python}"));
}

#[test]
fn rcpp_chunk_label_is_rendered_as_hashpipe_label_in_rmarkdown() {
    let input = "```{Rcpp, rcpp-sum-ref}\n// [[Rcpp::export]]\ndouble sum_cpp_ref(Rcpp::NumericVector& x) {\n  return 0.0;\n}\n```\n";
    let output = format(input, Some(rmarkdown_config()), None);

    assert!(output.contains("```{Rcpp}"));
    assert!(output.contains("//| label: rcpp-sum-ref"));
    assert!(!output.contains("```{Rcpp, rcpp-sum-ref}"));
}

#[test]
fn deprecated_code_block_style_config_is_noop() {
    let config: Config = toml::from_str(
        r#"
        flavor = "quarto"

        [format.code-blocks]
        attribute-style = "preserve"
    "#,
    )
    .unwrap();
    let input = "```{r,echo=FALSE}\n1 + 1\n```\n";
    let output = format(input, Some(config), None);

    // Deprecated option is ignored; executable chunks still use normalized output.
    assert!(output.contains("```{r}"));
    assert!(output.contains("#| echo: false"));
}

#[test]
fn r_chunk_label_with_spaces_stays_single_label() {
    let input = "```{r several words}\n#\n```\n";
    let output = format(input, Some(quarto_config()), None);

    assert!(output.contains("#| label: several words"));
    assert_eq!(output.matches("#| label:").count(), 1);
}

#[test]
fn inline_options_override_existing_hashpipe_options() {
    let input = "```{r, echo=TRUE}\n#| echo: false\n#| label: \"from-content\"\nx <- 1\n```\n";
    let output = format(input, Some(quarto_config()), None);

    assert_eq!(output.matches("#| echo:").count(), 1);
    assert!(output.contains("#| echo: true"));
    assert_eq!(output.matches("#| label:").count(), 1);
    assert!(output.contains("#| label: \"from-content\""));
}

#[test]
fn complex_inline_option_overrides_hashpipe_option_and_stays_inline() {
    let input = "```{r, fig.cap=knitr::current_input(), echo=TRUE}\n#| fig-cap: \"from-content\"\n#| warning: false\nx <- 1\n```\n";
    let output = format(input, Some(quarto_config()), None);

    assert!(output.contains("```{r, fig.cap=knitr::current_input()}"));
    assert!(output.contains("#| echo: true"));
    assert!(output.contains("#| warning: false"));
    assert!(!output.contains("#| fig-cap:"));
}

#[test]
fn complex_inline_option_remains_inline_when_hashpipe_header_exists() {
    let input = "```{r, results=knitr::asis_output(\"ok\")}\n#| echo: false\nx <- 1\n```\n";
    let output = format(input, Some(quarto_config()), None);

    assert!(output.contains("```{r, results=knitr::asis_output(\"ok\")}"));
    assert!(output.contains("#| echo: false"));
    assert!(!output.contains("#| results:"));
}

#[test]
fn multiline_hashpipe_value_continuation_is_not_dropped() {
    let input = "```{r}\n#| fig-cap: \"A multiline caption\n#|  that spans multiple lines and demonstrates\n#|  wrapping.\"\na <- 1\n```\n";
    let output = format(input, Some(quarto_config()), None);

    assert!(output.contains("#| fig-cap: \"A multiline caption"));
    assert!(output.contains("#|   that spans multiple lines and demonstrates"));
    assert!(output.contains("#|   wrapping.\""));
    assert!(output.contains("a <- 1"));
}

#[test]
fn inline_options_override_hashpipe_block_scalar_without_leaking_old_lines() {
    let input = "```{r, fig.cap=\"Inline caption\"}\n#| fig-cap: |\n#|   A caption\n#|   spanning some lines\na <- 1\n```\n";
    let output = format(input, Some(quarto_config()), None);

    assert!(output.contains("#| fig-cap: \"Inline caption\""));
    assert!(!output.contains("#| fig-cap: |"));
    assert!(!output.contains("#|   A caption"));
    assert!(!output.contains("#|   spanning some lines"));
    assert!(output.contains("a <- 1"));
}

#[test]
fn inline_options_override_hashpipe_folded_block_scalar_without_leaking_old_lines() {
    let input = "```{r, fig.cap=\"Inline caption\"}\n#| fig-cap: >-\n#|   A folded caption\n#|   spanning some lines\na <- 1\n```\n";
    let output = format(input, Some(quarto_config()), None);

    assert!(output.contains("#| fig-cap: \"Inline caption\""));
    assert!(!output.contains("#| fig-cap: >-"));
    assert!(!output.contains("#|   A folded caption"));
    assert!(!output.contains("#|   spanning some lines"));
    assert!(output.contains("a <- 1"));
}

#[test]
fn hashpipe_indented_yaml_value_is_preserved_as_hashpipe_header() {
    let input = "```{r}\n#| list:\n#|   - a\n#|   - b\na <- 1\n```\n";
    let output = format(input, Some(quarto_config()), None);

    assert!(output.contains("#| list:"));
    assert!(output.contains("#|   - a"));
    assert!(output.contains("#|   - b"));
    assert!(output.contains("a <- 1"));
}

#[test]
fn hashpipe_block_scalar_formatting_is_idempotent() {
    let input =
        "```{r}\n#| fig-cap: |\n#|   A caption\n#|   spanning some lines\nplot(1:10)\n```\n";
    let output1 = format(input, Some(quarto_config()), None);
    let output2 = format(&output1, Some(quarto_config()), None);

    assert_eq!(output1, output2, "Formatting should be idempotent");
    assert!(output2.contains("#| fig-cap: |"));
    assert!(output2.contains("#|   A caption"));
    assert!(output2.contains("#|   spanning some lines"));
}

#[test]
fn hashpipe_folded_block_scalar_formatting_is_idempotent() {
    let input = "```{r}\n#| fig-cap: >-\n#|   A folded caption\n#|   spanning some lines\nplot(1:10)\n```\n";
    let output1 = format(input, Some(quarto_config()), None);
    let output2 = format(&output1, Some(quarto_config()), None);

    assert_eq!(output1, output2, "Formatting should be idempotent");
    assert!(output2.contains("#| fig-cap: >-"));
    assert!(output2.contains("#|   A folded caption"));
    assert!(output2.contains("#|   spanning some lines"));
}

#[test]
fn hashpipe_yaml_wrap_accounts_for_comment_prefix_width() {
    let input = "```{r}\n#| fig-cap: This is a very long caption that should be truncated in the output to ensure that it does not take up too much space in the rendered document. The caption continues with more details about the figure and its significance in the context of the analysis being performed.\n```\n";
    let config = quarto_config();
    let output = format(input, Some(config.clone()), None);

    for line in output.lines() {
        if line.starts_with("#|") {
            assert!(
                line.len() <= config.line_width,
                "hashpipe line exceeded width ({} > {}): {}",
                line.len(),
                config.line_width,
                line
            );
        }
    }
}

#[test]
fn hashpipe_fig_cap_list_value_is_idempotent() {
    let input = "```{r}\n#| fig-cap:\n#|   - A\n#|   - B\n```\n";
    let output1 = format(input, Some(quarto_config()), None);
    let output2 = format(&output1, Some(quarto_config()), None);

    assert_eq!(output1, output2, "Formatting should be idempotent");
    assert_eq!(output2.matches("#|   - A").count(), 1);
    assert_eq!(output2.matches("#|   - B").count(), 1);
}

#[test]
fn hashpipe_long_quoted_fig_cap_stays_idempotent() {
    let input = "```{r}\n#| fig-cap: \"Relationship between inflation and GDP growth for Australia, Ethiopia, India, and the United States\"\n1+1\n```\n";
    let output1 = format(input, Some(quarto_config()), None);
    let output2 = format(&output1, Some(quarto_config()), None);

    assert_eq!(output1, output2, "Formatting should be idempotent");
}

#[test]
fn hashpipe_multiline_flow_collection_is_preserved_and_idempotent() {
    let input = "```{r}\n#| categories: [\n#|   \"alpha\",\n#|   \"beta\"\n#| ]\nx <- 1\n```\n";
    let output1 = format(input, Some(quarto_config()), None);
    let output2 = format(&output1, Some(quarto_config()), None);

    assert_eq!(output1, output2, "Formatting should be idempotent");
    assert!(output2.contains("#| categories: ["));
    assert!(output2.contains("#|   \"alpha\","));
    assert!(output2.contains("#|   \"beta\""));
    assert!(output2.contains("#| ]"));
    assert!(output2.contains("x <- 1"));
}

#[test]
fn hashpipe_indented_map_continuation_for_empty_value_is_preserved() {
    let input = "```{r}\n#| metadata:\n#|   author: Jane Doe\n#|   topic: YAML\nx <- 1\n```\n";
    let output1 = format(input, Some(quarto_config()), None);
    let output2 = format(&output1, Some(quarto_config()), None);

    assert_eq!(output1, output2, "Formatting should be idempotent");
    assert!(output2.contains("#| metadata:"));
    assert!(output2.contains("author: Jane Doe"));
    assert!(output2.contains("topic: YAML"));
    assert!(output2.contains("x <- 1"));
}

#[test]
fn hashpipe_options_have_exactly_one_blank_line_before_code() {
    let input = "```{r}\n#| include: false\n\n1 + 2\n```\n";
    let output1 = format(input, Some(quarto_config()), None);
    let output2 = format(&output1, Some(quarto_config()), None);

    assert!(
        output1.contains("#| include: false\n\n1 + 2"),
        "expected exactly one blank line between options and code:\n{output1}"
    );
    assert!(
        !output1.contains("#| include: false\n1 + 2"),
        "expected code not to follow options immediately:\n{output1}"
    );
    assert_eq!(output1, output2, "Formatting should be idempotent");
}

#[test]
fn hashpipe_continuation_marker_stays_attached_to_header() {
    let input = "```{r}\n#| fig-cap: \"Two scatterplots of the relationship between `x` and `y`.\"\n#|\n### x\nx <- rnorm(n)\n```\n";
    let output1 = format(input, Some(quarto_config()), None);
    let output2 = format(&output1, Some(quarto_config()), None);

    assert!(
        output1.contains(
            "#| fig-cap: \"Two scatterplots of the relationship between `x` and `y`.\"\n\n### x"
        ),
        "expected marker-only separator to normalize to one blank line:\n{output1}"
    );
    assert!(
        !output1.contains(
            "#| fig-cap: \"Two scatterplots of the relationship between `x` and `y`.\"\n#|"
        ),
        "expected marker-only separator line to be removed:\n{output1}"
    );
    assert_eq!(output1, output2, "Formatting should be idempotent");
}

#[test]
fn hashpipe_prefix_variants_are_used_for_executable_chunk_languages() {
    let input = "```{r, echo=FALSE}\n1 + 1\n```\n\n```{cpp, echo=FALSE}\nint x = 1;\n```\n\n```{sql, echo=FALSE}\nSELECT 1;\n```\n";
    let output = format(input, Some(quarto_config()), None);

    assert!(output.contains("```{r}"));
    assert!(output.contains("#| echo: false"));
    assert!(output.contains("```{cpp}"));
    assert!(output.contains("//| echo: false"));
    assert!(output.contains("```{sql}"));
    assert!(output.contains("--| echo: false"));
}

#[test]
fn cpp_hashpipe_block_scalar_continuation_is_idempotent() {
    let input =
        "```{cpp}\n//| fig-cap: |\n//|   A caption line\n//|   Continued line\nint x = 1;\n```\n";
    let output1 = format(input, Some(quarto_config()), None);
    let output2 = format(&output1, Some(quarto_config()), None);

    assert_eq!(output1, output2, "Formatting should be idempotent");
    assert!(output2.contains("//| fig-cap: |"));
    assert!(output2.contains("//|   A caption line"));
    assert!(output2.contains("//|   Continued line"));
    assert!(output2.contains("int x = 1;"));
}