This is a tool for validating commit messages - to ensure they have a consistent format and the required information.
npm install --save-dev @bigcommerce/validate-commitsYour commit message needs to have the following format:
task(scope): JIRA-1234 My commit message
You might also want to include a message body to provide additional information, for example, a breaking change.
task(scope): JIRA-1234 My commit message
BREAKING CHANGE: ABC has been renamed to XYZ.
Below is a list of supported tasks:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug nor adds a feature
- perf: A code change that improves performance
- test: Adding missing or correcting existing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
You need to add commit-validation.json to the root of your project in order to configure a list of supported scopes. i.e.:
{
"scopes": [
"payment",
"checkout",
"orders"
]
}To run the validator in Terminal:
npx validate-commits- Node:
>=6
MIT