alef 0.25.3

Opinionated polyglot binding generator for Rust libraries
Documentation
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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
use super::*;
use crate::core::config::Language;

#[test]
fn test_clean_doc_strips_examples() {
    let doc = "Does something.\n\n# Examples\n\n```rust\nfoo();\n```\n";
    let cleaned = clean_doc(doc, Language::Python);
    assert!(!cleaned.contains("Examples"));
    assert!(!cleaned.contains("foo()"));
    assert!(cleaned.contains("Does something"));
}

#[test]
fn test_clean_doc_strips_arguments() {
    let doc = "Does something.\n\n# Arguments\n\n* html - The HTML string\n\nMore text.";
    let cleaned = clean_doc(doc, Language::Python);
    assert!(!cleaned.contains("Arguments"));
    assert!(!cleaned.contains("html - The HTML string"));
    assert!(cleaned.contains("Does something"));
    assert!(cleaned.contains("More text"));
}

#[test]
fn test_clean_doc_rust_links() {
    let doc = "See [`field`](Self::field) for details.";
    let cleaned = clean_doc(doc, Language::Python);
    assert_eq!(cleaned, "See `field` for details.");
}

#[test]
fn test_clean_doc_bare_rust_links() {
    let doc = "See [`ParseOptions`] for details.";
    let cleaned = clean_doc(doc, Language::Python);
    assert_eq!(cleaned, "See `ParseOptions` for details.");
}

#[test]
fn test_extract_param_docs() {
    let doc = "Convert markup conversion.\n\n# Arguments\n\n* html - The HTML string to convert\n* options - Conversion options\n";
    let params = extract_param_docs(doc);
    assert_eq!(
        params.get("html").map(String::as_str),
        Some("The HTML string to convert")
    );
    assert_eq!(params.get("options").map(String::as_str), Some("Conversion options"));
}

#[test]
fn test_clean_doc_empty_string_all_languages() {
    for lang in [Language::Python, Language::Go, Language::Node, Language::Rust] {
        assert_eq!(clean_doc("", lang), "", "empty doc for {lang:?} must stay empty");
    }
}

#[test]
fn test_clean_doc_multiline_prose_all_paragraphs_preserved() {
    let doc = "First line.\n\nSecond paragraph.\n\nThird paragraph.";
    let cleaned = clean_doc(doc, Language::Python);
    assert!(cleaned.contains("First line."));
    assert!(cleaned.contains("Second paragraph."));
    assert!(cleaned.contains("Third paragraph."));
}

#[test]
fn test_clean_doc_none_becomes_nil_for_go_ruby_elixir() {
    let doc = "Returns `None` when nothing is found.";
    assert_eq!(clean_doc(doc, Language::Go), "Returns `nil` when nothing is found.");
    assert_eq!(clean_doc(doc, Language::Ruby), "Returns `nil` when nothing is found.");
    assert_eq!(clean_doc(doc, Language::Elixir), "Returns `nil` when nothing is found.");
}

#[test]
fn test_clean_doc_none_becomes_null_for_node_java_csharp_php() {
    let doc = "Returns `None` on failure.";
    assert_eq!(clean_doc(doc, Language::Node), "Returns `null` on failure.");
    assert_eq!(clean_doc(doc, Language::Java), "Returns `null` on failure.");
    assert_eq!(clean_doc(doc, Language::Csharp), "Returns `null` on failure.");
    assert_eq!(clean_doc(doc, Language::Php), "Returns `null` on failure.");
}

#[test]
fn test_clean_doc_none_stays_none_for_python_and_rust() {
    let doc = "Returns `None` when empty.";
    assert_eq!(clean_doc(doc, Language::Python), "Returns `None` when empty.");
    assert_eq!(clean_doc(doc, Language::Rust), "Returns `None` when empty.");
}

#[test]
fn test_clean_doc_none_becomes_null_uppercase_for_r_and_ffi() {
    let doc = "Returns `None` when empty.";
    assert_eq!(clean_doc(doc, Language::R), "Returns `NULL` when empty.");
    assert_eq!(clean_doc(doc, Language::Ffi), "Returns `NULL` when empty.");
}

#[test]
fn test_clean_doc_python_booleans_capitalised() {
    let doc = "Pass `true` to enable or `false` to disable.";
    let cleaned = clean_doc(doc, Language::Python);
    assert_eq!(cleaned, "Pass `True` to enable or `False` to disable.");
}

#[test]
fn test_clean_doc_non_python_booleans_lowercase_unchanged() {
    let doc = "Pass `true` to enable or `false` to disable.";
    assert_eq!(clean_doc(doc, Language::Go), doc);
    assert_eq!(clean_doc(doc, Language::Node), doc);
    assert_eq!(clean_doc(doc, Language::Java), doc);
}

#[test]
fn test_clean_doc_rust_path_becomes_dot_notation_for_python() {
    let doc = "Call `Foo::bar()` to create one.";
    let cleaned = clean_doc(doc, Language::Python);
    assert!(cleaned.contains("Foo.bar()"), "expected dot notation: {cleaned}");
    assert!(!cleaned.contains("Foo::bar()"));
}

#[test]
fn test_clean_doc_rust_path_stays_double_colon_for_php() {
    let doc = "Call `Foo::bar()` to create one.";
    let cleaned = clean_doc(doc, Language::Php);
    assert!(cleaned.contains("Foo::bar()"), "PHP keeps :: notation: {cleaned}");
}

#[test]
fn test_clean_doc_non_rust_code_block_preserved() {
    let doc = "Example:\n\n```python\nresult = convert(html)\n```\n";
    let cleaned = clean_doc(doc, Language::Python);
    assert!(cleaned.contains("```python"));
    assert!(cleaned.contains("result = convert(html)"));
}

#[test]
fn test_clean_doc_rust_code_block_stripped() {
    let doc = "Example:\n\n```rust\nuse foo::Bar;\nBar::new().unwrap();\n```\n\nAfter block.";
    let cleaned = clean_doc(doc, Language::Python);
    assert!(!cleaned.contains("use foo::Bar"), "Rust use statement must be stripped");
    assert!(cleaned.contains("After block."));
}

#[test]
fn test_clean_doc_errors_section_heading_becomes_bold() {
    let doc = "Summary.\n\n# Errors\n\nMay fail.\n";
    let cleaned = clean_doc(doc, Language::Python);
    assert!(cleaned.contains("**Errors:**"), "heading must become bold: {cleaned}");
    assert!(!cleaned.contains("# Errors"), "raw # heading must be gone: {cleaned}");
}

#[test]
fn test_clean_doc_returns_section_heading_becomes_bold() {
    let doc = "Summary.\n\n# Returns\n\nSome value.\n";
    let cleaned = clean_doc(doc, Language::Python);
    assert!(cleaned.contains("**Returns:**"));
    assert!(!cleaned.contains("# Returns"));
}

#[test]
fn test_clean_doc_crate_references_replaced_with_library() {
    let doc = "Available in this crate as a public API.";
    assert_eq!(
        clean_doc(doc, Language::Python),
        "Available in this library as a public API."
    );
}

#[test]
fn test_clean_doc_inline_code_spans_survive_for_rust() {
    let doc = "Use `None` or `false` to skip.";
    let cleaned = clean_doc(doc, Language::Rust);
    assert!(cleaned.contains("`None`"));
    assert!(cleaned.contains("`false`"));
}

#[test]
fn test_clean_doc_inline_empty_string() {
    assert_eq!(clean_doc_inline("", Language::Python), "");
    assert_eq!(clean_doc_inline("", Language::Go), "");
}

#[test]
fn test_clean_doc_inline_collapses_multiline_to_single_line() {
    let doc = "First sentence.\nSecond sentence.";
    let result = clean_doc_inline(doc, Language::Python);
    assert!(!result.contains('\n'), "inline output must be single-line: {result}");
    assert!(result.contains("First sentence."));
    assert!(result.contains("Second sentence."));
}

#[test]
fn test_clean_doc_inline_does_not_escape_pipes() {
    // clean_doc_inline must NOT escape pipes; callers use escape_table_cell for that.
    let doc = "Value between 0 | 1.";
    let result = clean_doc_inline(doc, Language::Python);
    assert!(
        !result.contains("\\|"),
        "pipe must not be pre-escaped by clean_doc_inline: {result}"
    );
    assert!(
        result.contains(" | "),
        "raw pipe must be preserved for caller to escape: {result}"
    );
    // The full pipeline (what lib.rs does) escapes exactly once:
    let cell = crate::docs::formatting::escape_table_cell(&result);
    assert!(
        cell.contains("\\|"),
        "caller escape_table_cell must escape the pipe: {cell}"
    );
    assert!(!cell.contains("\\\\|"), "pipe must not be double-escaped: {cell}");
}

#[test]
fn test_clean_doc_inline_applies_language_terminology() {
    let doc = "Returns `None` when empty.";
    assert_eq!(clean_doc_inline(doc, Language::Go), "Returns `nil` when empty.");
    assert_eq!(clean_doc_inline(doc, Language::Node), "Returns `null` when empty.");
}

#[test]
fn test_clean_doc_inline_strips_argument_sections() {
    let doc = "Summary.\n\n# Arguments\n\n* foo - bar\n";
    let result = clean_doc_inline(doc, Language::Python);
    assert!(!result.contains("Arguments"));
    assert!(!result.contains("foo - bar"));
    assert!(result.contains("Summary."));
}

#[test]
fn test_clean_doc_inline_filters_blank_only_lines() {
    let doc = "\n\n  \n\nActual content.\n\n  \n";
    let result = clean_doc_inline(doc, Language::Python);
    assert_eq!(result, "Actual content.");
}

/// Regression test for MD056 double-escaping.
///
/// `clean_doc_inline` must NOT escape pipes itself. All call sites in
/// `lib.rs` pass the result through `escape_table_cell`, so internal pipe
/// escaping inside `clean_doc_inline` causes double-escaping:
///   `||`  →  `\|\|`  (clean_doc_inline)  →  `\\|\\|`  (escape_table_cell)
/// The CommonMark parser then sees `\\` as an escaped backslash (literal `\`)
/// followed by an unescaped `|` (cell separator), splitting one cell into two
/// and triggering MD056.
///
/// The correct output after the full pipeline is `\|\|` (each pipe escaped
/// exactly once by `escape_table_cell`).
#[test]
fn test_clean_doc_inline_does_not_double_escape_pipes_in_logical_or() {
    let doc = "The length of this vec is ≤ rows * cols. An empty table (rows == 0 || cols == 0) produces an empty vec.";
    let raw = clean_doc_inline(doc, Language::Python);
    // clean_doc_inline must NOT have pre-escaped the pipes
    assert!(
        !raw.contains("\\|"),
        "clean_doc_inline must not escape pipes (double-escaping bug): {raw}"
    );
    // The caller (lib.rs) escapes once via escape_table_cell
    let cell = crate::docs::formatting::escape_table_cell(&raw);
    assert!(
        cell.contains("\\|\\|"),
        "after escape_table_cell the || must become \\|\\|, got: {cell}"
    );
    assert!(
        !cell.contains("\\\\|"),
        "double-escaped \\\\| must not appear, got: {cell}"
    );
}

#[test]
fn test_wrap_bare_urls_plain_https() {
    let text = "See https://example.com for details.";
    assert_eq!(wrap_bare_urls(text), "See <https://example.com> for details.");
}

#[test]
fn test_wrap_bare_urls_plain_http() {
    let text = "Visit http://example.com today.";
    assert_eq!(wrap_bare_urls(text), "Visit <http://example.com> today.");
}

#[test]
fn test_wrap_bare_urls_skips_already_angle_bracketed() {
    let text = "See <https://example.com> already wrapped.";
    assert_eq!(wrap_bare_urls(text), text);
}

#[test]
fn test_wrap_bare_urls_skips_markdown_link_url() {
    let text = "See [docs](https://example.com/docs) for more.";
    assert_eq!(wrap_bare_urls(text), text);
}

#[test]
fn test_wrap_bare_urls_multiple_bare_urls() {
    let text = "A: https://a.com B: https://b.com";
    assert_eq!(wrap_bare_urls(text), "A: <https://a.com> B: <https://b.com>");
}

#[test]
fn test_wrap_bare_urls_mixed_bare_and_already_wrapped() {
    let text = "Visit <https://wrapped.com> or https://bare.com";
    assert_eq!(
        wrap_bare_urls(text),
        "Visit <https://wrapped.com> or <https://bare.com>"
    );
}

#[test]
fn test_wrap_bare_urls_url_at_start_of_string() {
    let text = "https://example.com is the homepage.";
    assert_eq!(wrap_bare_urls(text), "<https://example.com> is the homepage.");
}

#[test]
fn test_wrap_bare_urls_url_at_end_of_string() {
    let text = "Homepage: https://example.com";
    assert_eq!(wrap_bare_urls(text), "Homepage: <https://example.com>");
}

#[test]
fn test_wrap_bare_urls_no_urls() {
    let text = "No links here, just prose.";
    assert_eq!(wrap_bare_urls(text), text);
}

#[test]
fn test_wrap_bare_urls_empty_string() {
    assert_eq!(wrap_bare_urls(""), "");
}

#[test]
fn test_demote_headings_single_level() {
    let doc = "# Heading 1\n\nSome text.\n\n## Heading 2";
    let demoted = demote_headings(doc, 1);
    assert!(demoted.contains("## Heading 1"), "H1 should become H2");
    assert!(demoted.contains("### Heading 2"), "H2 should become H3");
}

#[test]
fn test_demote_headings_multiple_levels() {
    let doc = "# Heading 1\n## Heading 2\n### Heading 3";
    let demoted = demote_headings(doc, 2);
    assert!(demoted.contains("### Heading 1"), "H1 should become H3");
    assert!(demoted.contains("#### Heading 2"), "H2 should become H4");
    assert!(demoted.contains("##### Heading 3"), "H3 should become H5");
}

#[test]
fn test_demote_headings_skips_code_blocks() {
    let doc = "# Heading\n\n```rust\n# Not a heading\n```\n\nMore text.";
    let demoted = demote_headings(doc, 1);
    assert!(demoted.contains("## Heading"), "H1 outside code should become H2");
    assert!(
        demoted.contains("# Not a heading"),
        "content inside code block should not be modified"
    );
}

#[test]
fn test_demote_headings_zero_levels_unchanged() {
    let doc = "# Heading\n## Subheading";
    let demoted = demote_headings(doc, 0);
    assert_eq!(demoted, doc, "zero demotion should return unchanged");
}

#[test]
fn test_demote_headings_caps_at_h6() {
    let doc = "##### Heading 5";
    let demoted = demote_headings(doc, 5);
    assert!(demoted.contains("###### Heading 5"), "should not exceed H6");
    let h6 = demote_headings("###### Heading 6", 1);
    assert!(h6.contains("###### Heading 6"), "H6 should stay at H6");
}

#[test]
fn test_demote_headings_preserves_trailing_content() {
    let doc = "# Title\n\nParagraph text.\n\n## Section\n\nMore text.";
    let demoted = demote_headings(doc, 1);
    assert!(demoted.contains("## Title"));
    assert!(demoted.contains("Paragraph text."));
    assert!(demoted.contains("### Section"));
    assert!(demoted.contains("More text."));
}

#[test]
fn test_check_monotonic_headings_valid_increments() {
    let doc = "## Page\n\n### Section\n\n#### Item\n\n##### Subitem";
    assert!(check_monotonic_headings(doc).is_ok());
}

#[test]
fn test_check_monotonic_headings_valid_skips_down() {
    let doc = "## Page\n\n### Section\n\n## Another Section\n\nText.";
    assert!(check_monotonic_headings(doc).is_ok());
}

#[test]
fn test_check_monotonic_headings_detects_skip_up() {
    let doc = "## Page\n\n#### Item (skip H3)";
    let result = check_monotonic_headings(doc);
    assert!(result.is_err(), "should detect skip from H2 to H4");
    assert!(result.unwrap_err().contains("skip of 2"));
}

#[test]
fn test_check_monotonic_headings_ignores_code_blocks() {
    let doc = "## Page\n\n```markdown\n#### This is not a real heading\n```";
    assert!(
        check_monotonic_headings(doc).is_ok(),
        "headings in code blocks should be ignored"
    );
}

#[test]
fn test_demote_headings_maintains_monotonic_increments() {
    let doc = "## Sub-page\n\n### Section\n\n#### Item";
    let demoted = demote_headings(doc, 2);
    // After demotion: #### Page, ##### Section, ###### Item
    assert!(
        check_monotonic_headings(&demoted).is_ok(),
        "demoted headings should maintain monotonic increments"
    );
}

#[test]
fn test_doc_comment_with_internal_headings_demoted() {
    let doc_comment = "Main description.\n\n## Stream Limits\n\nDetailed info about limits.";
    let cleaned = clean_doc(doc_comment, Language::Python);
    let demoted = demote_headings(&cleaned, 2);
    // After demotion, ## becomes ####
    // Structure should be: (parent at ####) → (doc content at ####) → (internal heading at ####)
    assert!(
        demoted.contains("#### Stream Limits"),
        "internal heading should be demoted to #### (was ##)"
    );
    // Verify monotonic increments
    assert!(
        check_monotonic_headings(&demoted).is_ok(),
        "demoted doc comment should have monotonic heading increments"
    );
}

// --- MD032: lists preceded by blank line ---

#[test]
fn test_ensure_blank_before_lists_inserts_blank_after_prose() {
    let doc = "For a typical element like `<div>`:\n1. Open tag\n2. Close tag\n";
    let result = ensure_blank_before_lists(doc);
    assert_eq!(
        result, "For a typical element like `<div>`:\n\n1. Open tag\n2. Close tag\n",
        "blank line must be inserted before the ordered list"
    );
}

#[test]
fn test_ensure_blank_before_lists_unordered_after_prose() {
    let doc = "Available options:\n- one\n- two\n";
    let result = ensure_blank_before_lists(doc);
    assert_eq!(result, "Available options:\n\n- one\n- two\n");
}

#[test]
fn test_ensure_blank_before_lists_preserves_existing_blank_line() {
    let doc = "Intro.\n\n- one\n- two\n";
    let result = ensure_blank_before_lists(doc);
    assert_eq!(result, "Intro.\n\n- one\n- two\n", "must not add a second blank line");
}

#[test]
fn test_ensure_blank_before_lists_keeps_contiguous_list_items_tight() {
    let doc = "- one\n- two\n- three\n";
    let result = ensure_blank_before_lists(doc);
    assert_eq!(result, doc, "contiguous list items must remain tight");
}

#[test]
fn test_ensure_blank_before_lists_ignores_lists_inside_fenced_code() {
    let doc = "Code:\n\n```\nintro\n- not a list\n```\n";
    let result = ensure_blank_before_lists(doc);
    assert_eq!(result, doc, "content inside fenced code blocks must not be touched");
}

#[test]
fn test_ensure_blank_before_lists_does_not_split_emphasis_markers() {
    // `*bold*` without trailing space must NOT be treated as a list marker.
    let doc = "Plain text.\n*not a list item*\n";
    let result = ensure_blank_before_lists(doc);
    assert_eq!(result, "Plain text.\n*not a list item*\n");
}

#[test]
fn test_ensure_blank_before_lists_handles_ordered_with_paren() {
    let doc = "Steps:\n1) first\n2) second\n";
    let result = ensure_blank_before_lists(doc);
    assert_eq!(result, "Steps:\n\n1) first\n2) second\n");
}

#[test]
fn test_clean_doc_inserts_blank_line_before_list_md032() {
    // Regression: visitor trait docstrings emit lists without preceding blank lines.
    let doc = "# Execution Order\n\nFor a typical element like `<div>`:\n1. Step one\n2. Step two\n";
    let cleaned = clean_doc(doc, Language::Python);
    // After the prose line ending with `:`, a blank line must precede `1.`
    assert!(
        cleaned.contains(":\n\n1."),
        "blank line must separate prose from list: {cleaned}"
    );
}

#[test]
fn test_normalize_list_markers_converts_asterisk_to_dash() {
    let doc = "Items:\n* First item\n* Second item";
    let normalized = normalize_list_markers(doc);
    assert!(normalized.contains("- First item"), "* should be converted to -");
    assert!(normalized.contains("- Second item"), "* should be converted to -");
    assert!(!normalized.contains("* First"), "* marker should be replaced");
}

#[test]
fn test_normalize_list_markers_preserves_emphasis() {
    let doc = "Text with *emphasis* and *more emphasis*.";
    let normalized = normalize_list_markers(doc);
    assert!(normalized.contains("*emphasis*"), "emphasis markers must be preserved");
    assert!(!normalized.contains("- emphasis"), "emphasis must not become a list");
}

#[test]
fn test_normalize_list_markers_preserves_bold() {
    let doc = "Text with **bold** content.";
    let normalized = normalize_list_markers(doc);
    assert!(normalized.contains("**bold**"), "bold markers must be preserved");
}

#[test]
fn test_normalize_list_markers_indented_lists() {
    let doc = "Parent:\n* Item 1\n  * Nested item";
    let normalized = normalize_list_markers(doc);
    assert!(normalized.contains("- Item 1"));
    assert!(
        normalized.contains("- Nested item"),
        "indented asterisk must also convert"
    );
}

#[test]
fn test_normalize_list_markers_skips_code_blocks() {
    let doc = "Text:\n\n```markdown\n* Item in code block\n```\n\n* Real list item";
    let normalized = normalize_list_markers(doc);
    assert!(
        normalized.contains("* Item in code block"),
        "code block content must be preserved"
    );
    assert!(
        normalized.contains("- Real list item"),
        "real list items must be converted"
    );
}

#[test]
fn test_collapse_whitespace_multiline() {
    let s = "First line\nSecond line\nThird line";
    let collapsed = collapse_whitespace(s);
    assert_eq!(collapsed, "First line Second line Third line");
    assert!(!collapsed.contains('\n'));
}

#[test]
fn test_collapse_whitespace_with_empty_lines() {
    let s = "First\n\n\nSecond";
    let collapsed = collapse_whitespace(s);
    assert_eq!(collapsed, "First Second");
}

#[test]
fn test_collapse_whitespace_with_extra_spaces() {
    let s = "Text   with    multiple     spaces";
    let collapsed = collapse_whitespace(s);
    // split_whitespace handles multiple spaces
    assert!(
        collapsed.contains("Text with multiple spaces") || collapsed.contains("Text  with"),
        "extra spaces should be normalized"
    );
}

#[test]
fn test_collapse_whitespace_empty() {
    assert_eq!(collapse_whitespace(""), "");
    assert_eq!(collapse_whitespace("   \n\n  "), "");
}

// MD038 (spaces inside code span), MD055/MD056 (table cell count mismatch)
#[test]
fn test_field_default_with_multiline_collapsed() {
    // Simulates a default value with embedded newlines
    let raw = "value_line_1\nvalue_line_2";
    let collapsed = collapse_whitespace(raw);
    let formatted = format!("`{collapsed}`");
    assert_eq!(formatted, "`value_line_1 value_line_2`");
    assert!(!formatted.contains('\n'), "backtick code span must be single-line");
}

// MD004 (list marker style)
#[test]
fn test_clean_doc_normalizes_asterisk_list_markers_to_dash() {
    let doc = "Summary.\n\n* First item\n* Second item";
    let cleaned = clean_doc(doc, Language::Python);
    assert!(
        cleaned.contains("- First item"),
        "asterisk lists should be normalized to dash: {cleaned}"
    );
    assert!(
        !cleaned.contains("* First"),
        "raw asterisk list markers should not remain"
    );
}