EasyBuild.CommitLinter 2.0.0

EasyBuild.CommitLinter

EasyBuild.CommitLinter is a .NET tool to lint your commit messages. It checks if the commit message follows the commit format described below.

[!TIP] EasyBuild.CommitLinter has a companion tool called EasyBuild.ChangelogGen which generates a changelog based on the Git history.

Usage

# Install the tool
dotnet tool install EasyBuild.CommitLinter

# Run the tool
dotnet commit-linter --help

DESCRIPTION:
Lint your commit message based on EasyBuild.CommitLinter conventions

Learn more at https://github.com/easybuild-org/EasyBuild.CommitLinter

USAGE:
    commit-linter <commit-file> [OPTIONS]

ARGUMENTS:
    <commit-file>    Path to the commit message file

OPTIONS:
    -h, --help       Prints help information
    -v, --version    Prints version information
    -c, --config     Path to the configuration file

Husky Integration

If you are using Husky, you can register the CLI as a commit-msg hook to validate your commit messages by running:

dotnet husky add commit-msg -c 'dotnet commit-linter "$1"'
# $1 is provided by Husky and contains the path to the commit message file

Commit Format

[!NOTE] EasyBuild.CommitParser format is based on Conventional Commits

It add a special Tag footer, allowing it to be used in a mono-repo context.

Tools like EasyBuild.ChangelogGen can use the tag to filter the commits to include in the changelog.

<type>[optional scope][optional !]: <description>

[optional body]

[optional footer]

• [optional body] is a free-form text.

  This is a single line body.
  

  This is a
  
  multi-line body.
  

• [optional footer] is inspired by git trailer format key: value but also allows key #value

  BREAKING CHANGE: <description>
  Signed-off-by: Alice <alice@example.com>
  Signed-off-by: Bob <bob@example.com>
  Refs #123
  Tag: cli
  

  💡 The Tag footer can be provided multiple times.

Configuration

EasyBuild.CommitParser comes with a default configuration to validate your commit.

The default configuration allows the following commit types with no tags required:

• feat - A new feature
• fix - A bug fix
• ci - Changes to CI/CD configuration
• chore - Changes to the build process or auxiliary tools and libraries such as documentation generation
• docs - Documentation changes
• test - Adding missing tests or correcting existing tests
• style - Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• refactor - A code change that neither fixes a bug nor adds a feature
• perf - A code change that improves performance
• revert - Reverts a previous commit
• build - Changes that affect the build system or external dependencies

If needed, you can provide a custom configuration either by code directly or by using a configuration file using JSON format.

Configuration File Format

The configuration file is a JSON file with the following properties:

types

• Required: ✅
• Type: { name: string, description?: string, skipTagFooter?: bool } []

List of accepted commit types.

tags

• Required: ❌
• Type: string []

List of accepted commit tags.

Examples

{
    "types": [
        { "name": "feat", "description": "A new feature", "skipTagFooter": false },
        { "name": "perf", "description": "A code change that improves performance", "skipTagFooter": false },
        { "name": "fix", "description": "A bug fix", "skipTagFooter": false },
        { "name": "docs", "description": "Documentation changes", "skipTagFooter": false },
        { "name": "test", "description": "Adding missing tests or correcting existing tests", "skipTagFooter": false },
        { "name": "style", "description": "Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)", "skipTagFooter": false },
        { "name": "refactor", "description": "A code change that neither fixes a bug nor adds a feature", "skipTagFooter": false },
        { "name": "ci", "description": "Changes to CI/CD configuration" },
        { "name": "chore", "description": "Changes to the build process or auxiliary tools and libraries such as documentation generation" }
        { "name": "revert", "description": "Reverts a previous commit" }
        { "name": "build", "description": "Changes that affect the build system or external dependencies" }
    ],
    "tags": [
        "cli",
        "converter"
    ]
}