grumphp
v2.10.0
コードの品質を何度も守ることにうんざりしていませんか? GrumPHP が代わりにやってくれます!このコンポーザー プラグインは、パッケージ リポジトリにいくつかの git フックを登録します。誰かが変更をコミットすると、GrumPHP はコミットされたコードに対していくつかのテストを実行します。テストが失敗すると、変更をコミットできなくなります。この便利なツールは、コードベースを改善するだけでなく、チームとして決定したベスト プラクティスに従って、より良いコードを書くように同僚に教えることもできます。
GrumPHP には、一連の一般的なタスクが組み込まれています。最小限の設定で GrumPHP を使用できるようになります。
詳細を説明するつもりはありませんので、簡単に説明します。自分でインストールして、GrumPHP のパワーを解放してください。
このパッケージが動作するには、次のツールがコマンドラインで検出可能であることを確認する必要があります。
php
作曲家
git
このパッケージはコンポーザー プラグインであり、コンポーザーを使用してプロジェクトの開発依存関係にインストールする必要があります。
GrumPHP を依存関係のない phar としてインストールします。
コンポーザーには --dev phpro/grumphp-shim が必要です
GrumPHP を依存関係とともにインストールします。
composer require --dev phpro/grumphp
依存関係なしで GrumPHP をインストールし、phive を介して自動化された git フックをインストールします
phive install grumphp
パッケージがインストールされると、GrumPHP 自体がプロジェクトの git フックに接続されます。 Composer ログに次のメッセージが表示されます。
気をつけて！ GrumPHP があなたのコミットを盗聴しています。
GrumPHP は、特定のタスクの使用を強制することはありません。ニーズに合ったタスクを選択し、すぐにタスクをアクティブ化または非アクティブ化できます。 Composer.json のsuggestセクションを参照してください。
注: --no-pluginsまたは--no-scriptsを指定してcomposer install実行しない限り、GrumPHP は既存のフックを上書きします。 git フックのバックアップは作成されますが、GrumPHP をインストールする前に、カスタム フックのバックアップも作成していることを確認することをお勧めします。
GrumPHP のインストールに問題がありますか?以下の方法を確認してください。
グローバルにインストールする
珍しいプロジェクト構造でインストールする
GrumPHP の一部の内容は、プロジェクトのルート (grumphp コマンドを実行するディレクトリ) にあるgrumphp.ymlまたはgrumphp.yml.distまたはgrumphp.dist.ymlファイルで構成できます。カスタム構成ファイル名と場所は、 composer.jsonまたはコンソール コマンドの--configオプションで指定できます。
# grumphp.ymlgrumphp:hooks_dir: ~hooks_preset: localgit_hook_variables:VAGRANT_HOST_DIR: .VAGRANT_PROJECT_DIR: /var/wwwEXEC_GRUMPHP_COMMAND: execENV: {}stop_on_failure: falseignore_unstaged_changes: falsehide_circumvention_tip: falseprocess_timeout: 60ascii:failed: grumphp-grumpy.txtsucceeded: grumphp-happy.txtParallel:enabled: truemax_workers: 32fixer:enabled: truefix_by_default: falseenvironment:files: []variables: {}paths: []tasks: {}testsuites: []拡張子: []構成の詳細は次のセクションに分かれています。
パラメータ – GrumPHP 自体の構成設定。
タスク – コード検証とそれぞれの構成を実行する外部タスク。
テストスイート
拡張機能
TaskRunnerの拡張
規約チェッカー
GrumPHP は単なる CLI ツールであるため、次のコマンドをトリガーできます。
構成する
git:初期化
git:deinit
git:プリコミット
git:コミットメッセージ
走る
GrumPHP は PHP 5.6 以降で動作します。
このパッケージは、次の git クライアントでテストされています。
CLI Unix
CLI Mac
CLI ウィンドウ
PhpStorm Git
アトラシアン ソースツリー
Syntevo SmartGit
チームが優れたコードを作成できるようにするために、多くのタスクがすでに用意されています。私たちは常に新しいタスクをサポートしたいと考えています。遠慮なく問題を記録したり、忘れていたタスクのプル リクエストを作成したりしてください。
不足している機能はありますか? それともバグが見つかりましたか?問題トラッカーに記録してください。手伝いたいですか?お気軽にお問い合わせください！
よくある質問
バグと機能リクエストは GitHub で追跡されます。コードを投稿する前に、当社のルールをご覧ください。
GrumPHP は MIT ライセンスに基づいてライセンスされています。
