Commitlint Imperative Plugin

A Commitlint plugin to ensure that commits are made using imperative mood.

: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

#install
npm install -D @ngx-devs/commitlint-plugin-imperative

:robot: Usage

Set your commitlint config to:

{
    plugins: ["@ngx-devs/commitlint-plugin-imperative"],
    rules: {
        "imperative-rule/en": [2, "always", ]
    }
}

Example

$ 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.