Skip to content

Commit 41f1dff

Browse files
authored
Add newline between markdown footnote definitions (#16063)
1 parent da5ad84 commit 41f1dff

3 files changed

Lines changed: 78 additions & 6 deletions

File tree

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#### Add newline between markdown footnote definitions (#16063 by @Atema)
2+
3+
<!-- prettier-ignore -->
4+
```md
5+
<!-- Input -->
6+
[^a]: Footnote A
7+
8+
[^b]: Footnote B
9+
10+
<!-- Prettier stable -->
11+
[^a]: Footnote A
12+
[^b]: Footnote B
13+
14+
<!-- Prettier main -->
15+
[^a]: Footnote A
16+
17+
[^b]: Footnote B
18+
```

src/language-markdown/printer-markdown.js

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,7 @@ import {
4141
* @typedef {import("../document/builders.js").Doc} Doc
4242
*/
4343

44-
const SIBLING_NODE_TYPES = new Set([
45-
"listItem",
46-
"definition",
47-
"footnoteDefinition",
48-
]);
44+
const SIBLING_NODE_TYPES = new Set(["listItem", "definition"]);
4945

5046
function genericPrint(path, options, print) {
5147
const { node } = path;
@@ -405,7 +401,6 @@ function genericPrint(path, options, print) {
405401
isFirst ? group([softline, print()]) : print(),
406402
}),
407403
),
408-
path.next?.type === "footnoteDefinition" ? softline : "",
409404
]),
410405
];
411406
}

tests/format/markdown/footnoteDefinition/__snapshots__/format.test.js.snap

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ proseWrap: "never"
3737
3838
=====================================output=====================================
3939
[^hello]: this is a long long long long long long long long long long long long long paragraph.
40+
4041
[^world]: this is a long long long long long long long long long long long long long paragraph. this is a long long long long long long long long long long long long long paragraph.
4142
4243
================================================================================
@@ -55,6 +56,7 @@ proseWrap: "preserve"
5556
5657
=====================================output=====================================
5758
[^hello]: this is a long long long long long long long long long long long long long paragraph.
59+
5860
[^world]:
5961
this is a long long long long long long long long long long long long long paragraph.
6062
this is a long long long long long long long long long long long long long paragraph.
@@ -75,6 +77,7 @@ tabWidth: 3
7577
7678
=====================================output=====================================
7779
[^hello]: this is a long long long long long long long long long long long long long paragraph.
80+
7881
[^world]:
7982
this is a long long long long long long long long long long long long long paragraph.
8083
this is a long long long long long long long long long long long long long paragraph.
@@ -352,31 +355,45 @@ proseWrap: "always"
352355
353356
=====================================output=====================================
354357
[^a]: a
358+
355359
[^a]: a
360+
356361
[^a]: a
362+
357363
[^a]: > 123
364+
358365
[^a]: a
366+
359367
[^a]: > 123
368+
360369
[^a]: a
370+
361371
[^a]: a
372+
362373
[^a]: a
363374
364375
---
365376
366377
[^a]: a
378+
367379
[^a]: a
380+
368381
[^a]: a
382+
369383
[^a]:
370384
> 123\\
371385
> 456
372386
373387
[^a]: a
388+
374389
[^a]:
375390
> 123\\
376391
> 456
377392
378393
[^a]: a
394+
379395
[^a]: a
396+
380397
[^a]: a
381398
382399
================================================================================
@@ -415,31 +432,45 @@ proseWrap: "never"
415432
416433
=====================================output=====================================
417434
[^a]: a
435+
418436
[^a]: a
437+
419438
[^a]: a
439+
420440
[^a]: > 123
441+
421442
[^a]: a
443+
422444
[^a]: > 123
445+
423446
[^a]: a
447+
424448
[^a]: a
449+
425450
[^a]: a
426451
427452
---
428453
429454
[^a]: a
455+
430456
[^a]: a
457+
431458
[^a]: a
459+
432460
[^a]:
433461
> 123\\
434462
> 456
435463
436464
[^a]: a
465+
437466
[^a]:
438467
> 123\\
439468
> 456
440469
441470
[^a]: a
471+
442472
[^a]: a
473+
443474
[^a]: a
444475
445476
================================================================================
@@ -478,31 +509,45 @@ proseWrap: "preserve"
478509
479510
=====================================output=====================================
480511
[^a]: a
512+
481513
[^a]: a
514+
482515
[^a]: a
516+
483517
[^a]: > 123
518+
484519
[^a]: a
520+
485521
[^a]: > 123
522+
486523
[^a]: a
524+
487525
[^a]: a
526+
488527
[^a]: a
489528
490529
---
491530
492531
[^a]: a
532+
493533
[^a]: a
534+
494535
[^a]: a
536+
495537
[^a]:
496538
> 123\\
497539
> 456
498540
499541
[^a]: a
542+
500543
[^a]:
501544
> 123\\
502545
> 456
503546
504547
[^a]: a
548+
505549
[^a]: a
550+
506551
[^a]: a
507552
508553
================================================================================
@@ -541,31 +586,45 @@ tabWidth: 3
541586
542587
=====================================output=====================================
543588
[^a]: a
589+
544590
[^a]: a
591+
545592
[^a]: a
593+
546594
[^a]: > 123
595+
547596
[^a]: a
597+
548598
[^a]: > 123
599+
549600
[^a]: a
601+
550602
[^a]: a
603+
551604
[^a]: a
552605
553606
---
554607
555608
[^a]: a
609+
556610
[^a]: a
611+
557612
[^a]: a
613+
558614
[^a]:
559615
> 123\\
560616
> 456
561617
562618
[^a]: a
619+
563620
[^a]:
564621
> 123\\
565622
> 456
566623
567624
[^a]: a
625+
568626
[^a]: a
627+
569628
[^a]: a
570629
571630
================================================================================

0 commit comments

Comments
 (0)