Commitizenの導入手順
Commitizenとは
Commitizen commitizen/cz-cli: The commitizen command line utility. #BlackLivesMatter
gitコメントのテンプレを提供してくれるCLIツールです。 導入することでコミットメッセージに盛り込む内容に悩む必要がなくなります。
インストール
Homebrewでインストールすると日本語化プラグインが認識されないので、npmでグローバルインストールする。
$ npm i -g commitizen
日本語化設定
日本語化モジュールをインストールする
$ npm install -g cz-conventional-changelog-ja
設定を追加する
# dotfiles管理下に設定ファイルをつくる touch ~/dotfiles/.czrc
{ "path": "cz-conventional-changelog-ja" }
# dotfiles管理下の設定ファイルを参照させる ln -snfv /Users/HOGE/Documents/github.com/shootacean/dotfiles/.czrc ~/.czrc
日本語化完了
$ git cz cz-cli@4.2.4, cz-conventional-changelog-ja@0.0.2 1行目は100文字で切り取られ、超過分は次行以降に記載されます。 ? コミットする変更タイプを選択: (Use arrow keys) ❯ feat: 新機能 fix: バグ修正 docs: ドキュメントのみの変更 style: フォーマットの変更(コードの動作に影響しないスペース、フォーマット、セミコロンなど) refactor: リファクタリングのための変更(機能追加やバグ修正を含まない) perf: パフォーマンスの改善のための変更 test: 不足テストの追加や既存テストの修正