ツール

コミットメッセージリンター

コミットメッセージを commitlint の config-conventional の Conventional Commits 規則でチェックします。規則名とメッセージも同じです。

ブラウザ内で実行コード変換1.9万
無料

入力

0 B

結果

結果はここに表示されます。

Conventional Commits(feat(api): add streaming、fix: handle empty responses など)は、semantic-release、release-please、変更履歴ジェネレーターが次のバージョンを決めてリリースノートを書くために読む形式で、commitlint はそれを強制するためにほとんどのプロジェクトが使うツールです。1 つまたは複数のメッセージを貼り付けると、このチェッカーは @commitlint/config-conventional の規則を適用します。許可された type、小文字の type、文頭大文字(sentence-case)でなくピリオドで終わらない subject、最大 100 文字のヘッダー、本文とフッターの前の空行などです。問題はそれぞれ commitlint 自身の文言と規則名で報告されるため、ここで直した内容は、コミットフックが指摘する内容とそのまま一致します。

動作のしくみ

  • 規則は commitlint を実行するのではなく、そのソースコードをもとに再実装しているため、チェックはページ内で行われます。規則セット、重大度、メッセージは config-conventional と一致します。
  • 複数のメッセージは --- だけの行で区切ります。マージコミット、revert、fixup!/squash! コミット、リリースバージョンだけのメッセージは、commitlint がデフォルトでスキップするのと同様にスキップされます。
  • 破壊的変更(type の後の !、または BREAKING CHANGE: フッター)は指摘されます。リリースツールにとってはメジャーバージョンの更新を意味するからです。
  • commitlint が行わないチェックが 1 つあります。小文字の breaking change: フッターには警告が出ます。仕様ではこのトークンを大文字で書くことが求められ、パーサーはそれ以外の綴りを無視するからです。

データの行き先

どこにも行きません。このツールは完全にブラウザ内で動作します。貼り付けたテキストはページが処理し、サーバーに送信されることも、ログに記録されることもありません。

このツールは無料で登録不要です。結果は開いているページの中にだけあり、どこにも保存されません。

必要なポイント

このツールは無料です。ログインもポイントも必要ありません。

よくある質問

どの type が使えますか?
config-conventional が受け付ける 11 種類、build、chore、ci、docs、feat、fix、perf、refactor、revert、style、test です。それ以外(大文字始まりの Fix、feature、update など)は type-enum 規則に違反します。プロジェクトは独自の commitlint 設定でリストを広げられますが、このチェッカーはデフォルトの設定を使います。
"feat: Add login page" がエラーになるのはなぜですか?
config-conventional は subject での sentence case、start case、pascal case、upper case を禁止しているため、常にその書き方をする単語でない限り、大文字で始めてはいけません。feat: add login page と書いてください。固有名詞は、引用符で囲むかバッククォートに入れれば残せます。大文字小文字のチェックはそれらを無視します。
中国語のコミットメッセージは使えますか?
はい。大文字と小文字の区別はラテン文字、ギリシャ文字、キリル文字などにしかないため、更新安装说明 のような subject は大文字小文字の規則を通過します。ただし type は英語のキーワードのいずれかでなければなりません。docs(readme): 更新安装说明 は有効ですが、文档: 更新安装说明 は無効です。
ヘッダーの上限が 72 ではなく 100 なのはなぜですか?
100 は config-conventional のデフォルトです。git log --oneline や GitHub のコミット一覧で途切れずに収まるよう 72 を好むチームも多く、その場合はヘッダーの最大長を 72 に設定すれば、その基準でチェックできます。

背後にあるオープンソース

このツールは外部ライブラリを同梱しない独自実装です。conventional-changelog/commitlint(MIT)はコードとして同じ仕事をします。自分のプログラムで同じことをしたいなら、Web ページを呼ぶのではなくそちらから始めてください。

conventional-changelog/commitlint

別の呼び方

  • コミットメッセージ チェック
  • conventional commits 書き方
  • commitlint オンライン
  • コミットメッセージ 書き方
  • conventional commits チェッカー
  • git commit message format