@canideploy/commitlint-config

This package provides a shared commitlint configuration.

The configuration is based on the Conventional Commits specification. The configuration will also spellcheck the commit messages using the commitlint-plugin-cspell plugin.

Installation

pnpm add @canideploy/commitlint-config commitlint -D

Usage

Create a commitlint.config.mjs file at the root of your project with the following content:

/**
 * @type {import('@commitlint/types').UserConfig}
 */
export default {
  extends: ['@canideploy/commitlint-config'],
};

Validate Setup

Verify a commit message must follow the Conventional Commits specification by running the following command:

echo "not a conventional commit" | npx --no commitlint

Verify a commit message is spellchecked by running the following command:

echo "feat(speling): demo" | npx --no commitlint