【Flutter】Flutterプロジェクト内に、commitizenを導入する方法

お疲れ様です。

今回は、FlutterプロジェクトにCommitizenを導入する手順をわかりやすく説明します。

はじめに

FlutterプロジェクトでCommitizenを導入するには、プロジェクトのGitリポジトリにCommitizenを統合する必要があります。

ただし、Flutter自体はDartを使用しており、Node.jsやnpmとは直接関連していません。そのため、Commitizenを導入するにはNode.js環境が必要です。

以下はFlutterプロジェクトにCommitizenを導入する手順です。

前提条件

• Node.jsがインストールされていることを確認してください。
• Gitがインストールされていることを確認してください。

導入手順

1. プロジェクトディレクトリに移動

Flutterプロジェクトのルートディレクトリに移動します。

2. Commitizenをローカルにインストール

Node.jsのプロジェクトとして初期化するために、以下のコマンドを実行します（まだpackage.jsonがない場合）。

 npm init -y

次に、Commitizenを開発依存関係としてインストールします。

npm install --save-dev commitizen

3. Commitizenを初期化

npx commitizen init cz-conventional-changelog --save-dev --save-exact 

これにより、cz-conventional-changelogアダプタがプロジェクトに追加され、package.jsonに設定が保存されます。

4. コミットスクリプトをpackage.jsonに追加（オプション）

package.jsonにコミットスクリプトを追加することで、npm run commitを使用してCommitizenを起動できます。

{
  "scripts": {
    "commit": "cz"
  }
}

こちらで、下記のコードも追加することで、commitizenを日本語で利用することができます。

 "config": { 
    "commitizen": { 
       "path": "cz-conventional-changelog-ja" 
  } 
}

5. コミットの実行

これでセットアップは完了です。

コミットを行う際には、通常のgit commitの代わりにnpx czまたはnpm run commit（スクリプトを追加した場合）を使用します。

注意点

• CommitizenはFlutterのDartコードに直接関与しません。これはGitコミットメッセージの標準化のためのツールです。
• FlutterプロジェクトにNode.js関連のファイル（package.json、node_modulesフォルダなど）が追加されるため、これらを.gitignoreに追加することを検討してください（もし必要であれば）。

まとめ

Commitizenを導入することで、Flutterプロジェクトのコミットメッセージの一貫性と可読性が向上します。チームでの開発がスムーズになるため、ぜひ試してみてください。