@ngx-devs/commitlint-plugin-imperative
v1.1.4TypeScript
commitlint plugin to ensure that commits are made using imperative mood
0/weekUpdated 3 years agoMITUnpacked: 11.9 KB
Published by Gleison de Almeida
npm install @ngx-devs/commitlint-plugin-imperativeCommitlint Imperative Plugin
A Commitlint plugin to ensure that commits are made using imperative mood.
About •
Installation •
Usage •
Author •
License
:information_source: About
If you want to write a git commit message properly, you should use the imperative mood. This means you need to eliminate the temptation to use gerunds or past tense in your subject lines. Don't write a git commit subject line that talks about what you did, or what you are doing. Instead, describe what was done.
Use this plugin to enforce this rule.
---
:arrow_forward: Installation
``bash`
#install
npm install -D @ngx-devs/commitlint-plugin-imperative
---
:robot: Usage
Set your commitlint config to:
`bash`
{
plugins: ["@ngx-devs/commitlint-plugin-imperative"],
rules: {
"imperative-rule/en": [2, "always", ]
}
}
Example
`bash
$ git commit -m "adding a project"
⧗ input: adding a project
✖ This commit is in the gerund. Please use the imperative form. [imperative-rule/en]
✖ found 1 problems, 0 warnings
ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
``
:boy: Author
Developed with ❤️ by Gleison Almeida
👋🏽 My Contacts:
  
---
:balance_scale: License
Copyright © 2021 Gleison Almeida.
This project is licensed by MIT.