Closed
Description
Integrate lint-staged to run linters against staged Git files to prevent to add code that violates any style guide into the code base.
Configuration
The configuration file lint-staged.config.js
will be placed in the project root and includes the command that should be run for matching file extensions (globs). It will include at least the three following entries with the same order as listed here:
prettier --list-different
- Run Prettier (Prettier #37) against*.{json,md,yml}
to ensure all files are formatted correctly. The--list-different
prints the found files that are not conform to the Prettier configuration.remark --no-stdout
- Run remark-lint (remark-lint #36) against*.md
to ensure all Markdown files are compliant to the style guide. The--no-stdout
flag suppresses the output of the parsed file content.
Tasks
- Install lint-staged package.
- Implement
lint-staged.config.js
configuration file.