Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 1.34 KB

README.md

File metadata and controls

70 lines (45 loc) · 1.34 KB

Shared commitlint configuration

The purpose of the commitlint is linting of a commit message to conform the following format:

type(scope?): subject

Contents

Setup

  • Add workspace reference to @muravjev/configs-commitlint and its peer dependencies:

    pnpm add -w @muravjev/configs-commitlint @commitlint/cli
  • Add commitlint configuration file:

    // .commitlintrc.js
    
    module.exports = require('@muravjev/configs-commitlint');
  • Add commitlint scripts:

    // package.json
    
    "scripts": {
      ...
      "commitlint": "commitlint"
      ...
    }

Automation

  • Setup ➡ husky to schedule commitlint execution on commit.

Usage

  • Automatic validation of commit message with commitlint on commit.
    In case of invalid message, commit will be rejected.

Donation

If you found this project helpful, consider
buying me a coffee, donate by paypal or just leave a star
Thanks for your support, it is much appreciated!

License

MIT © Sergey Muravjev


⬅ Back