Javascript quality guidelines

In order to enforcing SNGULAR style guidelines. We created the following packages to help projects implement linters easily.

• @sngular/commitlint-config
• @sngular/eslint-config
• @sngular/lint-staged-config
• @sngular/prettier-config
• @sngular/semantic-release-config
• @sngular/tsconfig

You can also configure .editorconfig file to ensure your code editor follow the style guide.

Some of the packages (commitlint & lint-staged) are created to work with husky to make git hook easy. We recommend to follow the manual installation and then add the following hooks to your project:

• Hook for lint commit messages:

npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'

• Hook for lint your files before commit

npx husky add .husky/pre-commit 'npx --no -- lint-staged'