commitlint-config-aron

Getting Started

Skip if you have already run npm install aronrepo:

npm install commitlint-config-aron -D

Configuration

Create a .commitlintrc.yml file in your project root and extend aron:

extends: aron

Set up Husky

Use Husky to register Git Hooks to automatically check whether it is legal before committing.

npx husky install

npx husky add .husky/commit-msg 'npx --no -- commitlint --edit ${1}'

Check if the .husky is successfully generated in the project root:

+ └── .husky
+     ├─── _
+     └─── commit-msg

From now on, you just need to commit; the check happens after the commit. If everything is legal, there will be no prompts.

package.json

Pre-commit checks via Git Hook are only enabled when other team members clone the project and run npm install.

Save commit-check and husky install commands for teamwork and CI:

{
    "scripts": {
        "install": "husky install",
        "commit-check": "commitlint --from=HEAD~1 --verbose"
    }
}

npm run commit-check:

Continuous Integration

Typically, you double-check commits before publishing and on relevant workflows, using GitHub Actions as an example:

Create a workflow for commit check /.github/workflows/commit-check.yml:

name: Commit Check
on:
    push:
        branches:
            - '**'
    pull_request_target:
        types:
            - opened
            - reopened
            - edited
            - synchronize

jobs:
    check:
        timeout-minutes: 15
        runs-on: ubuntu-20.04
        strategy:
            matrix:
                node-version: [18.12.1]
        steps:
            - uses: actions/checkout@v3
              with:
                  fetch-depth: 0
            - uses: actions/setup-node@v3
              with:
                  node-version: ${{ matrix.node-version }}
                  cache: 'npm'
            - run: npm ci
            - run: npm run commit-check

Commit Header Format

The header has a particular format that includes a Type, a Target, and a Summary:

Type(Target): Summary
  ┊     ┊
  ┊     └─⫸ Target: Workspace, Package or Role
  ┊
  └─⫸ Type: Bump, Feat, New, Perf, Add, Update, Improve, Fix, Depreciate, Drop, Docs, Upgrade, Revert, Example, Test, Refactor, Chore, Misc

For the full documentation, check out the Aron's conventional commits