commitlint-config-laozhu

Shareable commitlint configuration used by laozhu

Installation

Use npx to install peerdeps automatically or install peerDependencies with npm/yarn manually.

# Install with npx
$ npx install-peerdeps --dev commitlint-config-laozhu

# Install with yarn
$ yarn add --dev @commitlint/cli commitlint-config-laozhu

Usage

Reference it in package.json of your projects:

{
  "name": "my-project",
  "version": "1.0.0",
  "commitlint": {
    "extends": ["laozhu"]
  }
}

You can override configs after require module in commitlint.config.js.

module.exports = {
  extends: ['laozhu'],
  // Override commitlint rules below
  rules: {},
};

For lerna-managed monorepo, extending laozhu/lerna will enabled scope check for package name.

module.exports = {
  extends: ['laozhu/lerna'],
  // Override commitlint rules below
  rules: {},
};

With husky

Husky makes commitline works automatically as you run git commit.

{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}

License

MIT License