commitlint-plugin-imperative

commitlint plugin to ensure that commits are made using imperative mood using NLP model

About

This plugin is based off of ngx-devs/commitlint-plugin-imperative, which has been unmaintained for quite a long time and produces false positives very frequently · (Issue #2).

This plugin uses NLP tools instead of relying on simple checks to achieve greater accuracy.

Installation

1#install
2npm install -D @ragav-ks/commitlint-plugin-imperative

And then, in your commitlint config:

1{
2    plugins: ["@ngx-devs/commitlint-plugin-imperative"],
3    rules: {
4        "imperative-subject": [2, "always", ]
5    }
6}

Usage

Commitlint automatically checks for the subject to be in imperative mood.

Sample commit messages that has a valid subject:

chore(README): add the description about the extension
feat(extension): implement the core logic for the extension
feat(ci): change the pipeline name to better suit it's purpose
fix(ci): revert "feat(ci): change pipeline name to better suit its purpose"
chore(something): merge the pull request #123 from someuser/somebranch

Examples of invalid commit messages:

1$ git commit -m "chore(README): adding description about the extension"
2
3⧗   input: chore(README): adding description about the extension
4✖   The subject is not in imperative form. [imperative-subject]
5
6✖   found 1 problems, 0 warnings

1$ git commit -m "chore(README): added description about the extension"
2
3⧗   input: chore(README): added description about the extension
4✖   The subject is not in imperative form. [imperative-subject]
5
6✖   found 1 problems, 0 warnings

License

This project is licensed under the MIT License. See the LICENSE file for more details.