Play nice with `` switching between prettier<>dprint

nuke-web3 commented 1 year ago

To make use of this tool easy to transition or be directly compatible with Prettier users, I would love to have https://dprint.dev/plugins/markdown/#ignore-comments be expanded to also ignore using:

https://prettier.io/docs/en/ignore.html#markdown - 
https://prettier.io/docs/en/ignore.html#range-ignore -  ...

nuke-web3 commented 1 year ago

https://dprint.dev/plugins/markdown/config/#ignoreDirective

Actually if I can get this to work, that is all I need. The playground is working for this:

## Something

Working              format

<!-- prettier-ignore -->
Ignore                 format

With config snippet:

{
  "ignoreNodeCommentText": "prettier-ignore",
}

nuke-web3 commented 1 year ago

So in collaborating with others that use prettier instead of dprint (for example via prettier setup to automatically run on an IDE), here is an example of problem:

<diagram class="mermaid limit size-40">
<!-- prettier-ignore-start -->
flowchart TD
subgraph paraA[Parachain A              .]
  executor --"success?"--> palletxcm
  palletxcm("pallet-xcm") --"execute"--> executor("xcm-executor")
end
execute("execute(xcm)") --> palletxcm
<!-- prettier-ignore-end -->
</diagram>

Prettier needs there to be no new lines to respect the inner block. But dprint formats to

<diagram class="mermaid limit size-40">
<!-- prettier-ignore-start -->

flowchart TD
subgraph paraA[Parachain A              .]
  executor --"success?"--> palletxcm
  palletxcm("pallet-xcm") --"execute"--> executor("xcm-executor")
end
execute("execute(xcm)") --> palletxcm

<!-- prettier-ignore-end -->
</diagram>

And a run of prettier after this formats the block in an untended way.

dprint / dprint-plugin-markdown

Play nice with `` switching between prettier<>dprint #83