Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
CHANGELOG.md
README.md
index.js
license.md
package.json

README.md

@commitlint/config-angular-type-enum

Shareable commitlint config enforcing the angular commit convention types. Use with @commitlint/cli and @commitlint/prompt-cli.

See @commitlint/config-angular for full angular conventions.

Getting started

npm install --save-dev @commitlint/config-angular-types @commitlint/cli
echo "module.exports = {extends: ['@commitlint/config-angular-type-enum']};" > commitlint.config.js

Usage

echo "foo: bar" | commitlint # fails
echo "build: bar" | commitlint # passes

Examples

// commitlint.config.js
const types = require("@commitlint/config-angular-type-enum");

// Use as rule creating errors for non-allowed types
module.exports = {
  rules: {
    ...types.rules
  }
};

// Warn for non-allowed types
module.exports = {
  rules: {
    'type-enum': [1, 'always', types.values()]
  }
};
You can’t perform that action at this time.