@anylint/commitlint-config
v1.0.7
Published
Shareable Commitlint config enforcing conventional commit with workspace scopes support
Downloads
1
Maintainers
Readme
@anylint/commitlint-config
@anylint/commitlint-config is a configuration package for Commitlint designed to enforce consistent and conventional commit messages within your projects. This standardization makes it easier to track and manage changes in your codebase.
Features 🚀
Conventional Commit Messages: Promotes the use of conventional commit message formats, such as Conventional Commits, to enhance codebase manageability.
Workspace Scopes: Offers support for monorepo setups by enabling you to specify workspace scopes in commit messages.
Installation
To install, run the following command:
npm install @anylint/commitlint-config @commitlint/cli --save-dev
Prompts
To prompts install, run the following command:
npm install @commitlint/prompt-cli --save-dev
Add commit
script to your package.json
:
{
"scripts": {
"commit": "commit"
}
}
Run npm run commit
to commit your changes.
Commit Message Format
The commit message format enforced by this configuration is based on the Conventional Commits specification. This specification defines a set of rules for creating commit messages that are easy to read and parse by both humans and machines.
The following is an example of a commit message that follows the Conventional Commits specification:
feat(core): add new feature
Configuration
Monolithic Repository
Edit commitlint.config.js
:
module.exports = {
extends: ['@anylint/commitlint-config'],
rules: {
// Add additional rules here.
},
}
Monorepo Repository
Edit commitlint.config.js
:
module.exports = {
extends: ['@anylint/commitlint-config', '@anylint/commitlint-config/workspace-scopes'],
rules: {
// Add additional rules here.
},
}
Workspace scopes are automatically inferred from the workspaces
property in your package.json
file and added to the scopes
property in your commitlint.config.js
file. For example, if your package.json
file contains the following:
{
"workspaces": ["packages/core", "packages/ui"]
}
Then you should use core
and ui
as scopes in your commit messages:
$ git commit -m "feat(core): add new feature"
Additionally, you can use workspace
as a scope to indicate that your commit message applies to the entire monorepo:
$ git commit -m "feat(workspace): add new feature for all packages"