Format markdown files with Prettier

[SimenB]

Summary
Extracted from #4852 to allow that to be merged.

IMO, this is blocked by:

• Markdown: unstable lists prettier/prettier#3168
• Markdown: Long headings broken (also unstable) prettier/prettier#3169
• Markdown: Syntax highlighting sometimes removed prettier/prettier#3176

and possibly

• Markdown: Not all * is converted into _ prettier/prettier#3170
• JSON comment at the top moved into object prettier/prettier#3178

Test plan
Pretty md

[cpojer]

Wow, this is quite extreme but I like it. What do we propose to do in the meantime? Shall we close this PR and wait until prettier is done with all the fixes?

Please exclude the README.md, that one is supposed to be autogenerated from the documentation (not sure if it still is).

[azz]

Thanks for raising those issues - we'll get them sorted and publish 1.8.1 asap.

[thymikee]

Not sure why *feature* changed but *bug* didn't? Or is it manual change?

[azz]

prettier/prettier#3170

[codecov-io]

Codecov Report

Merging #4853 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4853   +/-   ##
=======================================
  Coverage   59.64%   59.64%           
=======================================
  Files         194      194           
  Lines        6502     6502           
  Branches        3        3           
=======================================
  Hits         3878     3878           
  Misses       2624     2624

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 67b4534...d97388c. Read the comment docs.

[azz]

Published prettier@1.8.1. Fixes all those issues minus prettier/prettier#3178 (you can use <!-- prettier-ignore --> before the code block to unblock this PR.)

[thymikee]

Looks, like there's a PR tackling this last issue (prettier/prettier#3187). I guess we can wait a bit more then.

[SimenB]

Pushed a new commit which is done from master, but applied on top of 1.8.0 markdown output for easier diff

[cpojer]

Let me know when this is ready to merge guys.

[SimenB]

@thymikee could you test if this makes any of the config here unnecessary?

https://github.com/facebook/jest/blob/8901f8752fe6a1369b94ea06edfaca48de3f7c8c/.vscode/settings.json#L12-L17

[SimenB]

It was cleaner to put it here instead of inline in the run script

[thymikee]

We should be safe to remove all of these except for prettier.eslintIntegration, because eslint --fix is responsible for formatting.

[SimenB]

Read the prettier-vscode docs, and the config in there is actually ignored if there's a prettier key in package.json.

https://github.com/prettier/prettier-vscode/blob/221e65c8e245aaea02dc4deb2a566680c3f73caa/README.md#prettiers-settings

(I don't use vscode, which is why I ask :))

[SimenB]

@cpojer @azz Added commit with prettier 1.8.2 (and rebased on master). Looking pretty good! Nothing jumping out at me

[SimenB]

@cpojer could you merge before conflicts arise? :D

[cpojer]

Done.

[SimenB]

Woo! Would you be opposed to commit hooks?

[thymikee]

Just a friendly reminder that commit hooks with Prettier might get terrible while rebasing.

[SimenB]

True story. Might be enough to periodically prettify

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.