Prettier reindenting json code blocks in .md files to 4 spaces.

[Aquaticat]

Found this out after changing Prettier format script in package.json to properly include all .md files in subdirectories.

Before:

    "format": "run-z +z --then prettier --write \"**.{json,md}\"",

After:

    "format": "run-z +z --then prettier --write \"**/*.{json,md}\"",

Before:

{
  "scripts": {
    "test": "run-z +z jest",
    "z": "run-z +test/--runInBand"
  }
}

After:

{
    "scripts": {
        "test": "run-z +z jest",
        "z": "run-z +test/--runInBand"
    }
}

Clearly, this is unwanted. Not submitting formatted files in pull request because of this issue.

[surol]

This is unavoidable due to prettier/prettier#5378
It seems using Prettier for all files is not an option.

[Aquaticat]

@surol I don't think this issue can be closed in its current state. Either we should just let Prettier format json inside markdown that way or we should whitelist markdown from Prettier.

[Aquaticat]

Also, the npm script is not working properly. You should either fix it or remove it.

[surol]

There is no perfect solution for this. Prettier is better to have, sometimes. E.g. I had to reformat the README file with Prettier, as you requested. Still, it is clean that Prettier is not a good thing everywhere.

[Aquaticat]

So what solution do you propose?

[surol]

Leave it be. Just ignore Prettier.

[Aquaticat]

Just to confirm: Are you saying not using Prettier to format these markdown files is the solution?

[surol]

Just to confirm: Are you saying not using Prettier to format these markdown files is the solution?

Yes, don't use Prettier for formatting. You were right about it. It brings more problems than solves.

[Aquaticat]

Alright. I'll update .../styleguide/markdown.md to make sure I know it's not to be used in the future. Also I'll update #61 to include language names in code blocks.

[Aquaticat]

How do you feel about removing that npm script? I feel like removing that script is the right decision.

[surol]

Alright, you can remove it. But don't remove the devDependency. It could be useful. Occasionally.