タイプ後のコロンまたはスペースの欠落
Conventional Commitsのよくあるミス:タイプの後のコロンやスペースの忘れ。正しい区切り形式とリンターがこれを検出する方法を学びます。
Common Mistakes
詳細な説明
コロン+スペースルール
Conventional Commitsで最もよくあるミスの1つは、コロン、コロンの後のスペース、またはその両方を省略することです。仕様では、タイプ(およびオプションのスコープ/バン)の直後にコロンが必要で、説明の前に1つのスペースが続きます。
無効な例
feat add user login
コロンが完全に欠落しています。これがないと、メッセージはConventional Commitとして解析できません。
feat:add user login
コロンはありますがスペースが欠落しています。一部のツールはこれを解析できるかもしれませんが、仕様に違反しており、リンターはエラーとしてフラグを立てます。
有効な形式
feat: add user login
正しい形式は、タイプの直後にコロンがあり、その後に正確に1つのスペースが続きます。
なぜこれが重要か
自動化ツール(変更ログジェネレーター、CI/CDパイプライン、バージョンバンパー)は: 区切りを解析してタイプと説明を抽出します。区切りが欠落または不正な場合、これらのツールは:
- コミットを正しく分類できない
- 変更ログでコミットをスキップする
- 不正確なバージョンバンプを生成する
- コミットリンティングが強制されている場合にCI失敗をトリガーする
自動修正
Conventional Commitsリンターは、コロンはあるがスペースが欠落している場合を検出し、修正版を提案します。Copy correctedをクリックして修正されたメッセージをコピーしてください。
関連する区切りの問題
- コロン前の余分なスペース:
feat : description— 一部のリンターはこれを拒否します。 - コロン後の複数スペース:
feat: description— 仕様では正確に1つのスペースが必要です。 - スペースの代わりにタブ:
feat:\tdescription— 通常のスペースを使用してください。
ユースケース
このルールは、Conventional Commitsを採用する際の最も頻繁なフォーマットエラーの1つを検出します。自由形式のコミットメッセージから移行する開発者が正確な区切り構文を忘れがちな場合に特によく見られます。