Add ESLint config to docs/sources #1411
Merged
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
In this commit we add a rule to the lint-staged configuration file at the root of the repository to ensure that all the markdown files contained in the docs/sources folder are formatted using our prettier config. Although not absolutely necessary, we enforce prettier to use the markdown parser, and have it write the result directly to staged files.
mstoykov
approved these changes
Nov 14, 2023
|
@jdbaldry I'm not sure about what has been made or not before, but considering we already had rules to maintain the formatting/linting prior to the switch, I would expect them to already be formatted 👍🏻 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
This Pull Request reintroduces the Prettier and ESLint configurations previously utilized in our Gatsby-based documentation site.
It reinstates the effective workflow combining husky and lint-staged, specifically designed to ensure that JavaScript code blocks within markdown files adhere to our code quality standards.
Impact
Post-merge, any changes to the
docs/sourcesfolder will be automatically vetted.Commits containing JavaScript code blocks that don't meet our Prettier and ESLint standards will be flagged, ensuring continuous adherence to our code quality benchmarks.