panache 2.52.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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
use rowan::ast::AstNode;
use std::collections::HashMap;
use std::path::PathBuf;
use std::sync::Arc;
use tokio::sync::Mutex;
use tower_lsp_server::Client;
use tower_lsp_server::jsonrpc::Result;
use tower_lsp_server::ls_types::*;

use crate::lsp::DocumentState;
use crate::lsp::conversions::offset_to_position;
use crate::lsp::helpers::get_document_content_and_tree;
use crate::syntax::{CodeBlock, Document, FencedDiv, SyntaxKind, SyntaxNode, YamlMetadata};

pub async fn folding_range(
    _client: &Client,
    document_map: Arc<Mutex<HashMap<String, DocumentState>>>,
    salsa_db: Arc<Mutex<crate::salsa::SalsaDb>>,
    _workspace_root: Arc<Mutex<Option<PathBuf>>>,
    params: FoldingRangeParams,
) -> Result<Option<Vec<FoldingRange>>> {
    let uri = params.text_document.uri;

    // Use helper to get document content and tree
    let (content, syntax_tree) =
        match get_document_content_and_tree(&document_map, &salsa_db, &uri).await {
            Some(result) => result,
            None => return Ok(None),
        };

    // Build folding ranges synchronously (SyntaxNode is not Send)
    let ranges = build_folding_ranges(&syntax_tree, &content);

    if ranges.is_empty() {
        Ok(None)
    } else {
        Ok(Some(ranges))
    }
}

fn build_folding_ranges(root: &SyntaxNode, content: &str) -> Vec<FoldingRange> {
    let mut ranges = Vec::new();
    let db = crate::salsa::SalsaDb::default();
    let extensions = crate::config::Extensions::default();
    let symbol_index = crate::salsa::symbol_usage_index_from_tree(&db, root, &extensions);
    let heading_levels: std::collections::HashMap<rowan::TextRange, usize> =
        symbol_index.heading_sequence().iter().copied().collect();

    let Some(document) = Document::cast(root.clone()) else {
        return ranges;
    };

    // Track heading positions for folding sections
    let mut heading_positions: Vec<(usize, usize)> = Vec::new();

    for node in document.blocks() {
        match node.kind() {
            SyntaxKind::HEADING => {
                let level = heading_levels.get(&node.text_range()).copied().unwrap_or(1);
                let start_offset = node.text_range().start().into();
                heading_positions.push((level, start_offset));
            }
            SyntaxKind::CODE_BLOCK => {
                if let Some(code_block) = CodeBlock::cast(node.clone())
                    && let Some(range) = extract_code_block_range(&code_block, content)
                {
                    ranges.push(range);
                }
            }
            SyntaxKind::FENCED_DIV => {
                if let Some(fenced_div) = FencedDiv::cast(node.clone())
                    && let Some(range) = extract_fenced_div_range(&fenced_div, content)
                {
                    ranges.push(range);
                }
            }
            SyntaxKind::YAML_METADATA => {
                if let Some(metadata) = YamlMetadata::cast(node.clone())
                    && let Some(range) = extract_yaml_metadata_range(metadata.syntax(), content)
                {
                    ranges.push(range);
                } else if let Some(range) = extract_yaml_metadata_range(&node, content) {
                    ranges.push(range);
                }
            }
            SyntaxKind::HTML_BLOCK | SyntaxKind::HTML_BLOCK_DIV => {
                if let Some(range) = extract_html_block_range(&node, content) {
                    ranges.push(range);
                }
            }
            _ => {}
        }
    }

    // Process heading sections - fold from heading to next same/higher level heading
    for (i, &(level, start_offset)) in heading_positions.iter().enumerate() {
        // Find next heading of same or higher level
        let end_offset = if let Some(&(_, next_offset)) = heading_positions
            .iter()
            .skip(i + 1)
            .find(|(next_level, _)| *next_level <= level)
        {
            next_offset
        } else {
            // No next heading at same/higher level, fold to end of document
            content.len()
        };

        // Only create fold if there's content after the heading
        if end_offset > start_offset {
            let start_pos = offset_to_position(content, start_offset);
            let end_pos = offset_to_position(content, end_offset.saturating_sub(1));

            // Fold from the line after the heading to the last line before next heading
            if start_pos.line < end_pos.line {
                ranges.push(FoldingRange {
                    start_line: start_pos.line,
                    start_character: None,
                    end_line: end_pos.line,
                    end_character: None,
                    kind: Some(FoldingRangeKind::Region),
                    collapsed_text: None,
                });
            }
        }
    }

    ranges
}

fn extract_code_block_range(code_block: &CodeBlock, content: &str) -> Option<FoldingRange> {
    let start_offset: usize = code_block.syntax().text_range().start().into();
    let end_offset: usize = code_block.syntax().text_range().end().into();

    let start_pos = offset_to_position(content, start_offset);
    let end_pos = offset_to_position(content, end_offset.saturating_sub(1));

    // Only fold if block spans multiple lines
    if start_pos.line < end_pos.line {
        Some(FoldingRange {
            start_line: start_pos.line,
            start_character: None,
            end_line: end_pos.line,
            end_character: None,
            kind: Some(FoldingRangeKind::Region),
            collapsed_text: None,
        })
    } else {
        None
    }
}

fn extract_fenced_div_range(fenced_div: &FencedDiv, content: &str) -> Option<FoldingRange> {
    let start_offset: usize = fenced_div.syntax().text_range().start().into();
    let end_offset: usize = fenced_div.syntax().text_range().end().into();

    let start_pos = offset_to_position(content, start_offset);
    let end_pos = offset_to_position(content, end_offset.saturating_sub(1));

    // Only fold if div spans multiple lines
    if start_pos.line < end_pos.line {
        Some(FoldingRange {
            start_line: start_pos.line,
            start_character: None,
            end_line: end_pos.line,
            end_character: None,
            kind: Some(FoldingRangeKind::Region),
            collapsed_text: None,
        })
    } else {
        None
    }
}

fn extract_html_block_range(node: &SyntaxNode, content: &str) -> Option<FoldingRange> {
    let start_offset: usize = node.text_range().start().into();
    let end_offset: usize = node.text_range().end().into();

    let start_pos = offset_to_position(content, start_offset);
    let end_pos = offset_to_position(content, end_offset.saturating_sub(1));

    if start_pos.line < end_pos.line {
        Some(FoldingRange {
            start_line: start_pos.line,
            start_character: None,
            end_line: end_pos.line,
            end_character: None,
            kind: Some(FoldingRangeKind::Region),
            collapsed_text: None,
        })
    } else {
        None
    }
}

fn extract_yaml_metadata_range(node: &SyntaxNode, content: &str) -> Option<FoldingRange> {
    let start_offset: usize = node.text_range().start().into();
    let end_offset: usize = node.text_range().end().into();

    let start_pos = offset_to_position(content, start_offset);
    let end_pos = offset_to_position(content, end_offset.saturating_sub(1));

    // Only fold if metadata spans multiple lines
    if start_pos.line < end_pos.line {
        Some(FoldingRange {
            start_line: start_pos.line,
            start_character: None,
            end_line: end_pos.line,
            end_character: None,
            kind: Some(FoldingRangeKind::Region),
            collapsed_text: None,
        })
    } else {
        None
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_heading_hierarchy_folding() {
        let content = r#"# Heading 1

Some content under h1.

## Heading 2

Content under h2.

### Heading 3

More content.

## Another H2

Final content.
"#;
        let config = crate::config::Config::default();
        let tree = crate::parser::parse(content, Some(config));
        let ranges = build_folding_ranges(&tree, content);

        // Should have 4 folding ranges: h1, h2, h3, h2
        assert!(!ranges.is_empty(), "Should have folding ranges");

        // Verify we have heading folds (at least)
        let heading_folds: Vec<_> = ranges
            .iter()
            .filter(|r| r.kind == Some(FoldingRangeKind::Region))
            .collect();
        assert!(!heading_folds.is_empty(), "Should have heading folds");
    }

    #[test]
    fn test_code_block_folding() {
        let content = r#"# Test

```python
def hello():
    print("Hello, world!")
    return True
```

More text.
"#;
        let config = crate::config::Config::default();
        let tree = crate::parser::parse(content, Some(config));
        let ranges = build_folding_ranges(&tree, content);

        // Should have at least the code block fold
        let code_folds: Vec<_> = ranges
            .iter()
            .filter(|r| r.kind == Some(FoldingRangeKind::Region))
            .collect();
        assert!(!code_folds.is_empty(), "Should have code block fold");
    }

    #[test]
    fn test_fenced_div_folding() {
        let content = r#"# Test

::: {.callout-note}
This is a note.
It has multiple lines.
:::

Text after.
"#;
        let config = crate::config::Config::default();
        let tree = crate::parser::parse(content, Some(config));
        let ranges = build_folding_ranges(&tree, content);

        // Should have at least the fenced div fold
        assert!(!ranges.is_empty(), "Should have folding ranges");
    }

    #[test]
    fn test_yaml_frontmatter_folding() {
        let content = r#"---
title: "My Document"
author: "Test Author"
date: 2024-01-01
---

# Heading

Content here.
"#;
        let config = crate::config::Config::default();
        let tree = crate::parser::parse(content, Some(config));
        let ranges = build_folding_ranges(&tree, content);

        // Should have frontmatter fold + heading fold
        assert!(
            ranges.len() >= 2,
            "Should have at least 2 folds (frontmatter + heading)"
        );
    }

    #[test]
    fn test_nested_structures() {
        let content = r#"# Main Heading

Some intro text.

```rust
fn main() {
    println!("nested");
}
```

## Subheading

More content.
"#;
        let config = crate::config::Config::default();
        let tree = crate::parser::parse(content, Some(config));
        let ranges = build_folding_ranges(&tree, content);

        // Should have: h1 fold, code block fold, h2 fold
        assert!(ranges.len() >= 3, "Should have at least 3 folds");
    }

    #[test]
    fn test_empty_document() {
        let content = "";
        let config = crate::config::Config::default();
        let tree = crate::parser::parse(content, Some(config));
        let ranges = build_folding_ranges(&tree, content);

        assert!(ranges.is_empty(), "Empty document should have no folds");
    }

    #[test]
    fn test_single_heading_no_content() {
        let content = "# Heading\n";
        let config = crate::config::Config::default();
        let tree = crate::parser::parse(content, Some(config));
        let ranges = build_folding_ranges(&tree, content);

        // Single heading with no content should not create fold
        assert!(
            ranges.is_empty(),
            "Single heading with no content should have no folds"
        );
    }

    #[test]
    fn test_html_block_folding() {
        let content = r#"<details><summary>Summary</summary>

This is the hidden content.

</details>

Trailing paragraph.
"#;
        let config = crate::config::Config::default();
        let tree = crate::parser::parse(content, Some(config));
        let ranges = build_folding_ranges(&tree, content);

        assert!(
            !ranges.is_empty(),
            "Multi-line HTML block should have a fold"
        );
    }

    #[test]
    fn test_html_comment_folding() {
        let content = r#"<!-- editor: a comment
spanning multiple lines
for clarity -->

Body paragraph.
"#;
        let config = crate::config::Config::default();
        let tree = crate::parser::parse(content, Some(config));
        let ranges = build_folding_ranges(&tree, content);

        assert!(
            !ranges.is_empty(),
            "Multi-line HTML comment should have a fold"
        );
    }

    #[test]
    fn test_html_block_div_folding() {
        // Pandoc dialect lifts <div>…</div> to HTML_BLOCK_DIV.
        let content = r#"<div class="callout">
First line.
Second line.
</div>

Outside.
"#;
        let config = crate::config::Config::default();
        let tree = crate::parser::parse(content, Some(config));
        let ranges = build_folding_ranges(&tree, content);

        assert!(
            !ranges.is_empty(),
            "Multi-line HTML_BLOCK_DIV should have a fold"
        );
    }

    #[test]
    fn test_inline_html_no_fold() {
        // Single-line raw HTML in a paragraph must not produce a fold.
        let content = "Hello <span>world</span>.\n";
        let config = crate::config::Config::default();
        let tree = crate::parser::parse(content, Some(config));
        let ranges = build_folding_ranges(&tree, content);

        assert!(
            ranges.is_empty(),
            "Inline HTML inside a single-line paragraph should not fold"
        );
    }

    #[test]
    fn test_no_foldable_content() {
        let content = r#"Just a paragraph.

Another paragraph.

And one more.
"#;
        let config = crate::config::Config::default();
        let tree = crate::parser::parse(content, Some(config));
        let ranges = build_folding_ranges(&tree, content);

        assert!(ranges.is_empty(), "Plain paragraphs should have no folds");
    }
}