[GH-ISSUE #171] MD031 should ignore prettier-ignore comment #1996

New issue

Closed

opened 2026-03-07 20:03:31 +03:00 by kerem · 5 comments

kerem commented

2026-03-07 20:03:31 +03:00

Owner

Originally created by @plehnen on GitHub (Mar 13, 2019).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/171

Putting  one line above some code block will cause the error MD031 - Fenced code blocks should be surrounded by blank lines.

It should ignore html comments when checking for blank lines.

The prettier-ignore is needed, because otherwise prettier would format the code to one line, removing my intended formatting.

Originally created by @plehnen on GitHub (Mar 13, 2019). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/171 Putting `` one line above some code block will cause the error **MD031 - Fenced code blocks should be surrounded by blank lines**. It should ignore html comments when checking for blank lines. The prettier-ignore is needed, because otherwise prettier would format the code to one line, removing my intended formatting.

kerem

2026-03-07 20:03:31 +03:00

closed this issue
added the
enhancement

fixed in next
labels

kerem commented

2026-03-07 20:03:32 +03:00

Author

Owner

@DavidAnson commented on GitHub (Mar 13, 2019):

Can you show an example, please? This sounds kind of like a workaround for a bug in prettier. I may still implement this, but I’d like to see the scenario first. Thanks!

@DavidAnson commented on GitHub (Mar 13, 2019): Can you show an example, please? This sounds kind of like a workaround for a bug in prettier. I may still implement this, but I’d like to see the scenario first. Thanks!

kerem commented

2026-03-07 20:03:32 +03:00

Author

Owner

@plehnen commented on GitHub (Mar 13, 2019):

Sure! This is how the part of the file looks like:

> Settings > Editor > Live Templates > Vue

- vcomputed

<!-- prettier-ignore -->
```vue
computed: {
  $name$() {
    return this.$data$ $END$;
  },
},
```

Removing the prettier-ignore will format the code in a way which is not desired.
Leaving it there will be warned by markdownlint.
Adding a blank line between the prettier-ignore and the block code will automatically be removed by prettier.

@plehnen commented on GitHub (Mar 13, 2019): Sure! This is how the part of the file looks like: <pre> > Settings > Editor > Live Templates > Vue - vcomputed  ```vue computed: { $name$() { return this.$data$ $END$; }, }, ``` </pre> Removing the prettier-ignore will format the code in a way which is not desired. Leaving it there will be warned by markdownlint. Adding a blank line between the prettier-ignore and the block code will automatically be removed by prettier.

kerem commented

2026-03-07 20:03:32 +03:00

Author

Owner

@DavidAnson commented on GitHub (Mar 13, 2019):

Makes sense. Any idea why prettier thinks it can reformat your code fence? It probably should never do that because it’s almost certain to change the way the content renders.

@DavidAnson commented on GitHub (Mar 13, 2019): Makes sense. Any idea why prettier thinks it can reformat your code fence? It probably should never do that because it’s almost certain to change the way the content renders.

kerem commented

2026-03-07 20:03:33 +03:00

Author

Owner

@plehnen commented on GitHub (Mar 13, 2019):

No idea, sorry. I am relatively new to the world of linters ;)
But I feel that a html comment could be placed anywhere and should just be ignored by the linter.
Especially because the comment used as a ignore rule has to be directly attached to the code it belongs to.

@plehnen commented on GitHub (Mar 13, 2019): No idea, sorry. I am relatively new to the world of linters ;) But I feel that a html comment could be placed anywhere and should just be ignored by the linter. Especially because the comment used as a ignore rule has to be directly attached to the code it belongs to.

kerem commented

2026-03-07 20:03:33 +03:00

Author

Owner

@DavidAnson commented on GitHub (Mar 14, 2019):

FYI: I opened https://github.com/prettier/prettier/issues/5971 to track the unexpected reformatting in the Prettier project. I'll use this issue to track the above suggestion for markdownlint.

@DavidAnson commented on GitHub (Mar 14, 2019): FYI: I opened https://github.com/prettier/prettier/issues/5971 to track the unexpected reformatting in the `Prettier` project. I'll use this issue to track the above suggestion for `markdownlint`.