commitlint

commitlintは、コミットメッセージをリントするためのオープンソースツールです。メッセージがConventional Commits形式に準拠しているかどうかを検証します。通常は `type(scope?): subject` と記述され、scopeは任意で、`/`、`\`、`,` などの区切り文字を使用して複数のscopeをサポートします。一般的なtypeには、build、chore、ci、docs、feat、fix、perf、refactor、revert、style、testがあり、これらは設定によってカスタマイズできます。 このプロジェクトは、`@commitlint/cli` としてインストールされる主要なCLIと、プログラムAPIを提供します。設定は、`.commitlintrc`、`.commitlintrc.json`、`.commitlintrc.yaml`、`.commitlintrc.yml`、`.commitlintrc.js`、`.commitlintrc.cjs`、`.commitlintrc.mjs`、`.commitlintrc.ts`、`.commitlintrc.cts`、`.commitlintrc.mts`、`commitlint.config.js`、`commitlint.config.cjs`、`commitlint.config.mjs`、`commitlint.config.ts`、`commitlint.config.cts`、`commitlint.config.mts` などのファイル、または `package.json` や `package.yaml` の `commitlint` フィールドから自動的に読み込まれます。 共有設定をインストールして拡張できます。これには、@commitlint/config-angular、@commitlint/config-conventional、@commitlint/config-lerna-scopes、@commitlint/config-nx-scopes、@commitlint/config-patternplate、@commitlint/config-workspace-scopes が含まれます。カスタムの共有設定は、`extends` フィールドで短い名前で参照できるように、`commitlint-config-*` という命名パターンに従う必要があります。 APIパッケージには、format、lint、load、read が含まれており、コミットメッセージをプログラムでリントしたり、設定をロードしたり、指定された範囲または最後の編集からメッセージを読み取ったりできます。追加のツールには、commitizenアダプタとプロンプトCLIがあります。 入門ガイドでは、huskyを使用してコミット時にメッセージをリントするローカル設定と、CIビルド中にメッセージをリントするCI設定について説明しています。このプロジェクトはモノレポとして開発されており、Node.js LTS >= 22.12.0 と git >= 2.13.2 が必要です。MITライセンスの下でリリースされています。関連プロジェクトには、conventional-changelog、commitizen、create-semantic-module があります。