お疲れ様です。

今回は、commitzenに似た機能を実現できる、シェルスクリプトを作成しましたので、共有します。

commitzenの問題

コミットメッセージを標準化する方法として、「commitzen」が挙げられると思います。

GitHub - commitizen/cz-cli: The commitizen command line utility. #BlackLivesMatter

The commitizen command line utility. #BlackLivesMatter - commitizen/cz-cli

github.com

しかし、このツールは、毎回インストールする手間や、Node.jsベースで、プロジェクトによっては追加の依存関係が必要になったりします。

そのような際、別の選択肢を一から探すのは手間です。

そのため、今回、シェルスクリプトを作成して、いかなるプロジェクトでも、同様のコミットメッセージを導入できるようにしました。

スクリプト

#!/bin/bash

# コミットタイプを尋ねる
echo "コミットのタイプを選択してください:"
echo "1. feat (新機能)"
echo "2. fix (バグ修正)"
echo "3. docs (ドキュメントの変更)"
echo "4. style (コードのスタイル変更、フォーマット等)"
echo "5. refactor (リファクタリング)"
echo "6. test (テスト関連)"
echo "7. chore (その他、ビルドプロセスや補助ツールの変更)"
echo "8. perf (パフォーマンス改善)"
echo "9. build (ビルドシステムや外部依存関係の変更)"
echo "10. ci (CI設定ファイルやスクリプトの変更)"
read -p "番号を入力してください: " type

case $type in
  1) type="feat";;
  2) type="fix";;
  3) type="docs";;
  4) type="style";;
  5) type="refactor";;
  6) type="test";;
  7) type="chore";;
  8) type="perf";;
  9) type="build";;
  10) type="ci";;
  *) echo "無効な選択肢です"; exit 1;;
esac

# スコープを尋ねる
read -p "変更のスコープ (コンポーネントやファイル名等) を入力してください: " scope

# コミットメッセージの概要を尋ねる
read -p "コミットメッセージの概要を簡潔に記述してください: " summary

# コミットメッセージの本文を尋ねる（オプション）
read -p "詳細なコミットメッセージを入力してください (オプション): " body

# コミットメッセージを組み立てる
commit_message="$type($scope): $summary"
if [ -n "$body" ]; then
  commit_message="$commit_message\\n\\n$body"
fi

# コミットを実行
git commit -m "$commit_message"

実行方法

上記のスクリプトの実行方法は、下記のコマンドを入力してください。

// ファイル名が「commit.sh」の場合
chmod +x commit.sh

そして、以下のコマンドで、スクリプトを実行してコミットを行います。

./commit.sh

おわり

今回のスクリプトは、基本的な機能しか持っていません。

プロジェクトのニーズに合わせて、カスタマイズしていってください。

The post 【Git】commitzenをシェルスクリプトで実行 first appeared on AichiLog.

良いコミットメッセージは、変更の内容を明確に伝え、他の開発者がプロジェクトの履歴を理解するのを助けます。

ここで、Commitizenというツールの出番です。Commitizenは、標準化されたコミットメッセージのフォーマットを簡単に作成するためのツールです。

Commitizenの始め方

インストール

Commitizenを使い始めるには、まず以下のコマンドでグローバルにインストールします。

npm install -g commitizen

これにより、git commitの代わりに使用するgit czコマンドが利用可能になります。

次に、日本語でコミットメッセージを作成するためのアダプターcz-conventional-changelog-jaをインストールします。

npm install -g cz-conventional-changelog-ja

設定の追加

プロジェクトのpackage.jsonファイルに以下の設定を追加します。

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

この設定により、Commitizenは日本語でのコミットメッセージの作成をサポートするようになります。

コミットの作成

設定が完了したら、コミットを作成するために以下のコマンドを使用します。

git cz

このコマンドを実行すると、コミットの種類を選択するためのリストが表示されます。例えば、新しい機能の追加、バグ修正、ドキュメントの更新など、変更の種類に応じて適切なオプションを選ぶことができます。

Commitizenのメリット

• 標準化: Commitizenを使用すると、プロジェクト全体で一貫したコミットメッセージのフォーマットを維持できます。
• 自動化: コミットメッセージのフォーマットを手動で記憶する必要がなく、プロンプトに従って入力するだけで良い形式のメッセージを作成できます。
• チームワークの向上: 新しい開発者がプロジェクトに参加したときに、コミットメッセージのフォーマットに迅速に適応できます。

まとめ

Commitizenは、コミットメッセージの品質を維持し、開発プロセスをスムーズにするための素晴らしいツールです。

設定は簡単で、使い始めることも容易です。

日本語でのコミットメッセージをサポートするcz-conventional-changelog-jaを使えば、日本の開発チームでも効率的に活用することができます。

プロジェクトの歴史が読みやすくなり、チーム内のコミュニケーションが向上するでしょう。

参考文献

Commitizenを使ってgitのコミットメッセージをしっかり書こう | DevelopersIO

dev.classmethod.jp

The post Commitizenでプロフェッショナルなコミットメッセージを作成しよう first appeared on AichiLog.

ここでは、日常的によく使うGitコマンドをわかりやすくまとめてみました。これらのコマンドは、開発の効率を上げるのに役立ちます。

push

変更をプッシュした後に前の状態に戻す

プッシュ後に「あ、間違えた！」と思ったことはありませんか？以下のコマンドで、特定のコミットに戻って再度プッシュできます。

git log --oneline  // コミットハッシュを取得
git reset --hard <commit-hash>  // 特定のコミットハッシュに戻る
git push origin <branch-name> --force  // 強制的にリモートにプッシュ

クローン後、新しいリポジトリにpushする

既存のリポジトリをクローンして、新しいリポジトリにプッシュする方法です。

git remote set-url origin <新しいリポジトリのURL>
git remote -v
git branch -M main
git push -u origin main

commit

コミットを消す

コミットを取り消したい場合はresetコマンドを使います。取り消すコミットを確認するためにlogコマンドとセットで使われることが多いです。

git log --oneline
git reset オプション コミットID

# オプション
–soft
コミットされていない変更として残ります。
主に「コミットの内容を変更したい」時に使います。

–hard
こちらのオプションでは変更も全て削除されます。
「途中まで対応していたが結局対応不要になった」時などに使います。

他にもrevertコマンドがあります。

git revert コミットID

最後のcommitの状態に戻す

作業ディレクトリの変更を取り消したい場合は、以下のコマンドが便利です。

git checkout .  // 直前の状態に戻す
git checkout <ファイル名>  // 特定のファイルの変更を取り消す

プッシュしていないコミットを一覧表示

プッシュ前のコミットを確認するには、このコマンドを使います。

git log @{u}..

merge

マージを削除する

マージを取り消し、最初のmergeコマンドを実行する前の状態に戻ります。

git merge --abort

他のブランチを、mainブランチと同じ状態にする

特定のブランチをmainブランチと同期させたい場合は、以下のようにします。

git fetch origin
git checkout ブランチ名
git merge origin/main

リモートの特定ブランチから、ローカルの特定のブランチへ変更を取り込む方法
git fetch origin
git cehckout 反映させたいブランチ
git merge origin/feature/Issues_#16

リモート

リモート上の、ファイル名変更

リモートリポジトリ上でファイル名を変更する方法です。

git mv 古いファイル名 新しいファイル名
// このコマンドは以下の3つのコマンドと同じ意味を持つ
mv 古いファイル名 新しいファイル名
git rm 古いファイル名
git add 新しいファイル名

リモート上の、ファイルを削除

リモートリポジトリからファイルを削除する方法です。

git rm  // ワークツリーとローカルリポジトリの両方から削除
git rm --cached ファイル名  // ローカルリポジトリからのみ削除
git rm -r ディレクトリ名  // ディレクトリごと削除

リモートのリポジトリ名を変更した時、ローカル環境のリポジトリ名も変更

リモートリポジトリのURLが変更された場合、ローカルリポジトリのURLも更新する必要があります。

git remote set-url origin 新しいリポジトリURL

おわり

これらのコマンドは、日々の開発作業をスムーズに進めるために非常に役立ちます。Gitのコマンドは多岐にわたりますが、これらは特に頻繁に使われるものです。適切に使いこなすことで、開発の効率が大きく向上します。

The post Gitのよく使うコマンドまとめ：日常開発で役立つコマンド集 first appeared on AichiLog.