commitlint

始めましょう| Webサイト

リントはメッセージをコミットします

SVG-Term-CLIで生成されたデモ

cat docs/assets/commitlint.json | svg-term --out docs/public/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80

• 良いcommitizenになりましょう

• npm経由で構成を共有します

• conventional-changelogをタップします

コンテンツ

• 始めましょう| Webサイト

• インストールして実行します

• リリース

• Commitlintを使用することの利点

• コンテンツ

• Commitlintとは何ですか

• はじめる

• cli

• config

• 共有構成

• ドキュメント

• API

• ツール

• ロードマップ

• バージョンのサポートとリリース

• 関連プロジェクト

• ライセンス

• 発達

---

Commitlintとは何ですか

Commitlintは、コミットメッセージが従来のコミットフォーマットを満たしているかどうかを確認します。

一般的に、パターンは主に次のようになります：

タイプ（スコープ？）：件名#Scopeはオプションです。複数のスコープがサポートされています（現在の区切り文字オ​​プション： "/"、 "" "、"、 "）

現実世界の例は次のようになります：

chore: run tests on travis ci

fix(server): send cors headers

feat(blog): add comment section

Commitlint-config-Conventional（角度条約に基づく）に応じた一般的なタイプは次のとおりです。

• 建てる

• 雑用

• CI

• ドキュメント

• 偉業

• 修理

• パフォーマンス

• リファクタリング

• 戻る

• スタイル

• テスト

これらは、独自の構成によって変更できます。

Commitlintを使用することの利点

• なぜ従来のコミットを使用するのですか？

• 「コンベンションでコミットすることの特典」（トークスライド）

はじめる

• ローカルセットアップ - ハスキーとのコミットに関する糸くずメッセージ

• CIセットアップ-CIビルド中の糸くずメッセージ

cli

• Commitlintと対話する主な方法。

• npm install --save-dev @commitlint/cli

• パッケージ：CLI

config

• 構成は次のとおりです。

• .commitlintrc

• .commitlintrc.json

• .commitlintrc.yaml

• .commitlintrc.yml

• .commitlintrc.js

• .commitlintrc.cjs

• .commitlintrc.mjs

• .commitlintrc.ts

• .commitlintrc.cts

• commitlint.config.js

• commitlint.config.cjs

• commitlint.config.mjs

• commitlint.config.ts

• commitlint.config.cts

• package.jsonのcommitlintフィールド

• package.yamlのcommitlintフィールド

• パッケージ：CLI、コア

• 可能なルールの完全なリストについては、ルールを参照してください

• 例の構成は、 @commitlint/config-conventionalで見つけることができます

共有構成

commitlintでインストールして使用するために、多くの共有構成が利用できます。

• @commitlint/config-angular

• @commitlint/config-conventional

• @commitlint/config-lerna-scopes

• @commitlint/config-nx-scopes

• @commitlint/config-patternplate

• 従来のchangelog-lint-config-atom

• 従来のchangelog-lint-config-canonical

ショ和独自の共有可能な構成を公開する場合は、パターンcommitlint-config-emoji-logまたはcommitlint-config-your-config-name emoji-log沿った名前を確認してください。またはyour-config-name 。

ドキュメント

メインWebサイトを確認してください。

API

• commitlintと対話する代替のプログラム的な方法

• パッケージ：

• Format -Format Commitlintレポート

• LINT-コミットリントルールに対して文字列を並べます

• ロード - 共有Commitlint構成をロードします

• 読み取り - 指定された範囲または最後の編集からのコミットメッセージを読む

• メソッドと例の完全なリストについては、APIを参照してください

ツール

• コミットンアダプター

• プロンプト

ロードマップ

commitlintは安定していると見なされ、さまざまなプロジェクトで開発ツールとして使用されています。

アイデア：従来のChangelog/Commitlint＃94

バージョンのサポートとリリース

• node.js lts >= 18

• git >= 2.13.2

リリース

セキュリティパッチは、まだEOLではないバージョンに適用されます。
機能は、現在のメインバージョンにのみ適用されます。

リリース	初期リリース
V19	02/2024
V18	10/2023

EOLは通常、約1年後です。

私たちはスポンサー付きのOSSプロジェクトではありません。したがって、古いリリース用のパッチバージョンをタイムリーにリリースすることを約束することはできません。
古いバージョンで立ち往生していて、セキュリティパッチが必要な場合は、PRを提供できる場合は満足しています。

関連プロジェクト

• 従来のチョンゲログは、従来のコミット履歴からチェンジログを生成します

• インターネット市民のためのシンプルなコミットコンベンションをコミットします

• 新規または既存のプロジェクトに委員会とコミットリントを迅速に統合するためのセマンティックモジュールCLIを作成する

ライセンス

@Marioneblによる著作権。すべてのcommitlintパッケージは、MITライセンスの下でリリースされます。

発達

commitlintはモノリポジトリで開発されています。

インストールして実行します

git clone [email protected]：convelive-changelog/commitlint.gitcd commitlint
糸
yarn run build＃run build tasksyarn start＃run tests、on candyyarn run commitlint＃run cli

貢献方法の詳細については、寄付ガイドをご覧ください。