@commitlint/config-angular-type-enum

What is @commitlint/config-angular-type-enum?

@commitlint/config-angular-type-enum is a configuration package for Commitlint that enforces commit message conventions based on the Angular commit message guidelines. It helps ensure that commit messages are consistent and follow a predefined format, which is particularly useful for maintaining a clean and understandable project history.

What are @commitlint/config-angular-type-enum's main functionalities?

Enforcing Commit Message Types

This feature allows you to enforce specific commit message types such as 'feat', 'fix', 'docs', etc., based on Angular's commit message conventions. By extending the configuration, you ensure that all commit messages adhere to these types.

{
  "extends": ["@commitlint/config-angular-type-enum"]
}

Customizing Commit Message Types

This feature allows you to customize the list of allowed commit message types. You can add or remove types as needed to fit your project's requirements.

{
  "rules": {
    "type-enum": [
      2,
      "always",
      [
        "feat",
        "fix",
        "docs",
        "style",
        "refactor",
        "perf",
        "test",
        "build",
        "ci",
        "chore",
        "revert"
      ]
    ]
  }
}

Other packages similar to @commitlint/config-angular-type-enum

@commitlint/config-conventional

@commitlint/config-conventional is another configuration package for Commitlint that enforces conventional commit message guidelines. It is similar to @commitlint/config-angular-type-enum but follows the broader Conventional Commits specification rather than Angular's specific guidelines.

commitizen

Commitizen is a tool that helps you write commit messages following a standard convention. It provides an interactive CLI to guide you through the commit process, ensuring that your messages are formatted correctly. While it serves a similar purpose to @commitlint/config-angular-type-enum, it focuses more on the user experience of writing commits rather than just enforcing rules.

semantic-release

semantic-release automates the versioning and package publishing process based on commit messages. It uses commit message conventions to determine the type of release (major, minor, patch) and generates changelogs automatically. While it includes commit message validation, its primary focus is on automating the release workflow.

README

@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-type-enum @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()],
  },
};

Changelog

19.5.0 (2024-09-11)

Features

• cli: use special errorCode for missing rules/config #4142 (#4143) (d7070d8)