- Notifications
You must be signed in to change notification settings - Fork0
Shareable commitlint configuration
License
MorevM/commitlint-config
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Shareablecommitlint configuration.
yarn add @morev/commitlint-config
npm install @morev/commitlint-config
pnpm add @morev/commitlint-config
Create a.commitlintrc.cjs file in the project root:
echo -e"module.exports = {\n\textends: ['@morev/commitlint-config'],\n\trules: {},\n};"> .commitlintrc.cjs
The command above will create a.commitlintrc.cjs file with the following content:
module.exports={extends:['@morev/commitlint-config'],rules:{},};
It's recommended to create
.commitlintrc.cjsfile instead ofcommitlint.config.jsbecause by usingthis naming strategy you can keep your Commitlint configuration file consistent across packagesregardless of whether the package has"type": "module"or"type": "commonjs".
If you need fine-grained control, you can import the entire config directly and manipulate it as a JavaScript object:
constconfig=require('@morev/commitlint-config');// Replace the `header-min-length` rule with custom settingsconfig.rules['header-min-length']=[2,'always',5];module.exports=config;
Also you can use the built-in utility to modifytype-enum rule for each project in a more elegant way:
const{ modifyTypeEnum}=require('@morev/commitlint-config/utils');constconfig=require('@morev/commitlint-config');module.exports=modifyTypeEnum(config,{add:['temp'],remove:['nvm'],});// Now you can use `temp` as a type and cannot use `nvm`, rest types remain as is.
| type | Description |
|---|---|
feat | A new feature related to a production code. |
fix | A bug fix related to a production code. |
refactor | A production code change that neither fixes a bug nor adds a feature. |
perf | A less generic subset ofrefactor, a code change that improves performance. |
test | Adding new/missing tests or correcting existing tests. |
docs | Documentation changes. |
chore | Updating accompanying code (linters, builders, library versions, etc.) without affecting the production code. |
ci | A less generic subset ofchore related to CI changes only. |
release | A less generic subset ofchore related to changes that only bumps the version and updateCHANGELOG.md. |
revert | Used for commits that revert another commit. |
wip | Shortened form ofwork in progress For commits that should be in the public repository but represent a feature that is not yet ready. |
nvm | Shortened form ofnevermind For commits that have no value to other developers, which can be skipped when analyzing changes. |
build | Not recommended to use nowadays. Used for legacy projects that provide build artifacts as part of the repository. |
About
Shareable commitlint configuration
Topics
Resources
License
Contributing
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors2
Uh oh!
There was an error while loading.Please reload this page.