Install

1 - clone the repository

2 - install the dependencies

  • npm i

Libs

How it works?

npm run test

It searches the entire repository for testable files and runs the tests.

npm run lint:fix

It looks for eligible files to apply the patch. If not, it will notify you in the terminal.

Commit

During the commit, it will attempt to perform lint fixes and tests on the staging files. The commit will only be performed if these two steps are completed successfully.

Thanks to lib git-commit-msg-linter, commits must follow the conventional commits pattern. Otherwise, it also raises an error. Check the lib page for more information.

Eslint

This project uses the Airbnb style guide.

For non-Airbnb styled codes to be tagged visually, you need to install the extension ESLint.

To apply corrections, you can type ctrl+shift+p and look for option ESLint: fix all auto-fixable Problems. If you click on the gear, you can set hotkeys.