心配をやめ、gitフックが大好きであることを学んだ方法

Gitは強力なバージョン制御システムですが、Commitの品質を本質的に保証するものではありません。エラー、役に立たないメッセージ、またはフォーマット不良でコードをコミットできます。 Gitフックはソリューションを提供します。このチュートリアルでは、コミット基準を実施するためにGitフックを実装し、よりクリーンなコードベースとよりスムーズなコラボレーションを確保する方法を示しています。

特定の基準を満たすことのみを許可するフックを作成します。チェックに失敗すると、有益なエラーメッセージが修正に向けてガイドされます。ボーナスとして、通過するコミットは自動的にフォーマットされます。

前提条件

node.js、npm、およびgitに対する基本的な知識が想定されています。 package.jsonまたはgit commit -m [message]について確信が持てない場合は、先に進む前に関連するドキュメントを参照してください。

私たちのアプローチ

依存関係をインストールし、3つのコミットチェックを設定します。

1. 糸くず：コードには糸くずエラーがない必要があります。
2. 単体テスト：関連する単体テストが合格する必要があります。
3. メッセージフォーマットのコミット：メッセージは事前定義された形式（従来のコミット形式）に付着する必要があります。

最後に、通過するコミットは、Prettierを使用して自動的にフォーマットされます。重要なことに、これらのチェックは段階的なファイルでのみ実行され、オーバーヘッドを最小限に抑えます。このプロセスはスタックに依存しています。好みのツール（冗談の代わりにモカ）に適応します。

依存関係のインストール

まず、ハスキー（フックの管理用）と糸くずのステージ（ステージファイルでリナーを実行するため）をインストールします。

 npm iハスキーリントステージ -  save-dev

次に、Commitメッセージの検証のためにcommitlintをインストールします。

 npm install @commitlint/{config-conventional、cli}  -  save-dev

Windowsユーザーの場合：

 npmインストール @commitlint/config-conventional @commitlint/cli  -  save-dev

従来の形式を使用するようにcommitlintを構成します。

 echo "module.exports = {extends：['@commitlint/config-conventional']}"> commitlint.config.js

コミット前のフックの実装

これらのスクリプトを使用してpackage.jsonを想定しましょう（プロジェクトに調整します）：

 「スクリプト」：{
  "start"： "webpack-dev-server -config ./webpack.dev.js  - モード開発"、
  「ビルド」：「webpack -config ./webpack.prod.js  - モード制作」、
  「テスト」：「jest」、
  「LINT」：「TSC -NoeMit」、
  "prettier"： "prettier  - -single-quote  -  print-width 80 \" **/*。{js、ts} \ "-write"
}

package.jsonでハスキーと糸くずの段階を構成します：

 「ハスキー」：{
  「フック」：{
    「事前コミット」：「Lint-Staged」
  }
}、
「リントステージ」：{
  "./**/*. {Ts}"：[
    「NPM Run Lint」、
    「npm run ittier」
  ]
}

これにより、各コミットの前に段階的なタイプスクリプトファイルでlintとprettierなります。ユニットテストを含めるには、Jestを追加します。

 「リントステージ」：{
  "./**/*. {Ts}"：[
    「NPM Run Lint」、
    「jest  -  bail  -  coverage  -  findrelatedtests」、
    「npm run ittier」
  ]
}

メッセージメッセージの検証については、Huskyにcommit-msgフックを追加します。

 「ハスキー」：{
  「フック」：{
    「commit -msg」：「commitlint -e huskky_git_params」、
    「事前コミット」：「Lint-Staged」
  }
}、

これで、糸くずエラー、テストの失敗、または不適切にフォーマットされたコミットメッセージが検出された場合、コミットは失敗します。きれいな人は、通過するコミットを自動的にフォーマットします。この合理化されたワークフローにより、コードの品質とチームのコラボレーションが大幅に向上します。

以上が心配をやめ、gitフックが大好きであることを学んだ方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。