コードを送信する前に、コミット前のフックスクリプトを使用して、最新の PHP コード仕様に準拠していない問題を自動的にチェックして修正するにはどうすればよいですか?-PHPチュートリアル-php.cn

コードを送信する前に、コミット前のフックスクリプトを使用して、最新の PHP コード仕様に準拠していない問題を自動的にチェックして修正するにはどうすればよいですか?

WBOY

リリース： 2023-09-05 11:10:02

オリジナル

1024 人が閲覧しました

プリコミットフックスクリプトを使用して、コードを送信する前に最新の PHP コード仕様に準拠していない問題を自動的にチェックして修正するにはどうすればよいですか?

ソフトウェア開発プロセスでは、コードの品質は非常に重要な側面です。適切なコード仕様により、コードが読みやすく、理解しやすく、保守しやすくなります。たとえば、PHP コードの場合、PSR (PHP 標準推奨事項) 仕様に従うと、コードの可読性と保守性が向上します。

チームメンバーがコードを送信する前にコードの品質を確保するために、Git フックのプリコミット (コミット前) フックスクリプトを使用して、最新のコードに準拠していない問題を自動的にチェックして修正できます。 PHPコードの仕様。これにより、チームメンバーはコードをコミットする前にコード仕様の問題を即座に特定して解決できるため、コード全体の品質が向上します。

コミット前フックスクリプトには、各コミットの前に実行できる任意の実行可能スクリプトファイルを使用できます。この例では、PHP_CodeSniffer ツールを使用してコード仕様をチェックし、PHP-CS-Fixer を使用して問題を自動的に修正します。

以下は、PHP_CodeSniffer と PHP-CS-Fixer を使用するコミット前フックスクリプトの例です。

#!/bin/sh

# Run PHP_CodeSniffer
./vendor/bin/phpcs --standard=PSR2 --colors --ignore=vendor/,tests/ --report=emacs

# Run PHP-CS-Fixer
./vendor/bin/php-cs-fixer fix --rules=@PSR2 --using-cache=no --verbose --dry-run

# Check the exit code of the previous commands
if [ $? -ne 0 ]; then
  echo "Code style check failed. Please fix the issues before committing."
  exit 1
fi

ログイン後にコピー

上記のスクリプトは、最初に PHP_CodeSniffer を使用してコード仕様をチェックします (-- 標準) =PSR2 は、チェックに PSR2 仕様を使用し、--ignore=vendor/,tests/ パラメーターを使用してベンダーディレクトリとテストディレクトリを無視することを意味します。 --colors はカラー出力を使用することを意味し、--report=emacs は Emacs の読みやすいレポート形式を使用することを意味します。

次に、スクリプトは PHP-CS-Fixer を使用して、コード仕様の問題を自動的に修正します。 --rules=@PSR2 は修復に PSR2 仕様を使用することを意味し、--using-cache=no はキャッシュを使用しないことを意味し、--verbose --dry-run 詳細な修復情報を出力するが、実際にはファイルを変更しないことを示します。

最後に、スクリプトは上記の 2 つのコマンドの終了コードをチェックします。問題がある場合、スクリプトはエラーメッセージを出力して終了します。

このコミット前フックスクリプトを使用するには、.git/hooks/pre-commit ファイルとして保存し、実行可能にする必要があります。 PHP_CodeSniffer と PHP-CS-Fixer もインストールする必要があります。上記のスクリプトでは、これら 2 つのツールが Composer を介して vendor/bin ディレクトリにインストールされていることを前提としています。

コードを送信すると、このコミット前フックスクリプトが自動的に実行され、コードの仕様がチェックされます。不適合の問題がある場合、スクリプトは対応するエラーメッセージをコマンドラインに出力し、コードが送信されなくなります。コードを正常に送信するには、これらの問題を解決する必要があります。

コミット前のフックスクリプトを使用してコード仕様の問題を自動的にチェックして修正すると、コードをコミットする前にチームメンバーが最新の PHP コード仕様に従っていることを確認できるため、コード全体の品質が向上します。これは、コードレビューの作業負荷を軽減し、開発効率を向上させ、潜在的なバグのリスクを軽減できるため、大規模なプロジェクトやチームにとって特に重要です。この例を使用すると、コミット前のフックスクリプトをチームのニーズや特定のコーディング規約に合わせて調整できます。

以上がコードを送信する前に、コミット前のフックスクリプトを使用して、最新の PHP コード仕様に準拠していない問題を自動的にチェックして修正するにはどうすればよいですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。