This repository has been archived by the owner on Feb 6, 2023. It is now read-only.
Prettify docs files #2275
Closed
Prettify docs files #2275
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
@yangshun has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
|
Oh this is cool. Ideally yeah, let's enforce it in |
There was a problem hiding this comment.
@yangshun has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
yangshun
commented
Dec 7, 2019
| @@ -26,8 +26,10 @@ | |||
| "dev": "gulp dev", | |||
| "postbuild": "node node_modules/fbjs-scripts/node/check-lib-requires.js lib", | |||
| "lint": "eslint .", | |||
| "lint-docs": "alex .", | |||
| "lint-docs": "alex . && yarn format-docs:diff", | |||
There was a problem hiding this comment.
Not sure if prettier differences are considered part of linting?
There was a problem hiding this comment.
Yep that's legit, the && enforces a clean Alex pass before Prettier
| { | ||
| files: '*.js', | ||
| options: { | ||
| parser: 'flow', |
There was a problem hiding this comment.
Use Flow only for JS so that other filetypes can be formatted by Prettier using their respective parsers.
There was a problem hiding this comment.
Are there other files that should be formatted by flow? e.g. .json or inlined into .html files?
There was a problem hiding this comment.
@yangshun has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
claudiopro
reviewed
Dec 7, 2019
| If you have changed any documentation, before submitting your PR, please run the following command from the root of the directory to use Prettier to format the documentation. | ||
|
|
||
| ``` | ||
| $ yarn format-docs |
There was a problem hiding this comment.
@yangshun has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
mmissey
pushed a commit
to mmissey/draft-js
that referenced
this pull request
Mar 24, 2020
Summary: **Summary** Prettier can also be used to format more than just JS files, it can format Markdown files too. Instead of using Flow parser for all files in `prettier.config.js`, we can just limit Flow parser for JS files and let Prettier find the default parsers for the various file formats. Hence I tweaked the Prettier config and added overrides for: - JS format - Use Flow parser - Markdown format - Restrict to 80 characters so that it's easier to read I then ran Prettier on all the docs. I've added a `prettier:diff` command into the `lint-docs` step, ran alongside with Alex that will fail when there are unformatted docs. It's not part of the CI step as I think that might be a bit too strict given that some people (including myself) edit docs in the GitHub UI and that might cause formatting issues which can be fixed by running the `format-docs` command every now and then. The formatting is only restricted to the docs now and not code as it's potentially dangerous to format code that gets synced with internal FB repos. **Test Plan** Load website. Pull Request resolved: facebookarchive#2275 Reviewed By: mrkev Differential Revision: D18807420 Pulled By: yangshun fbshipit-source-id: b3f34282c2a2cad8e89cd90e8f3f6b3860b747fc
vilemj-Viclick
pushed a commit
to kontent-ai/draft-js
that referenced
this pull request
Jul 16, 2020
Summary: **Summary** Prettier can also be used to format more than just JS files, it can format Markdown files too. Instead of using Flow parser for all files in `prettier.config.js`, we can just limit Flow parser for JS files and let Prettier find the default parsers for the various file formats. Hence I tweaked the Prettier config and added overrides for: - JS format - Use Flow parser - Markdown format - Restrict to 80 characters so that it's easier to read I then ran Prettier on all the docs. I've added a `prettier:diff` command into the `lint-docs` step, ran alongside with Alex that will fail when there are unformatted docs. It's not part of the CI step as I think that might be a bit too strict given that some people (including myself) edit docs in the GitHub UI and that might cause formatting issues which can be fixed by running the `format-docs` command every now and then. The formatting is only restricted to the docs now and not code as it's potentially dangerous to format code that gets synced with internal FB repos. **Test Plan** Load website. Pull Request resolved: facebookarchive#2275 Reviewed By: mrkev Differential Revision: D18807420 Pulled By: yangshun fbshipit-source-id: b3f34282c2a2cad8e89cd90e8f3f6b3860b747fc
alicayan008
pushed a commit
to alicayan008/draft-js
that referenced
this pull request
Jul 4, 2023
Summary: **Summary** Prettier can also be used to format more than just JS files, it can format Markdown files too. Instead of using Flow parser for all files in `prettier.config.js`, we can just limit Flow parser for JS files and let Prettier find the default parsers for the various file formats. Hence I tweaked the Prettier config and added overrides for: - JS format - Use Flow parser - Markdown format - Restrict to 80 characters so that it's easier to read I then ran Prettier on all the docs. I've added a `prettier:diff` command into the `lint-docs` step, ran alongside with Alex that will fail when there are unformatted docs. It's not part of the CI step as I think that might be a bit too strict given that some people (including myself) edit docs in the GitHub UI and that might cause formatting issues which can be fixed by running the `format-docs` command every now and then. The formatting is only restricted to the docs now and not code as it's potentially dangerous to format code that gets synced with internal FB repos. **Test Plan** Load website. Pull Request resolved: facebookarchive/draft-js#2275 Reviewed By: mrkev Differential Revision: D18807420 Pulled By: yangshun fbshipit-source-id: b3f34282c2a2cad8e89cd90e8f3f6b3860b747fc
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Prettier can also be used to format more than just JS files, it can format Markdown files too. Instead of using Flow parser for all files in
prettier.config.js, we can just limit Flow parser for JS files and let Prettier find the default parsers for the various file formats.Hence I tweaked the Prettier config and added overrides for:
I then ran Prettier on all the docs. I've added a
prettier:diffcommand into thelint-docsstep, ran alongside with Alex that will fail when there are unformatted docs. It's not part of the CI step as I think that might be a bit too strict given that some people (including myself) edit docs in the GitHub UI and that might cause formatting issues which can be fixed by running theformat-docscommand every now and then.The formatting is only restricted to the docs now and not code as it's potentially dangerous to format code that gets synced with internal FB repos.
Test Plan
Load website.