Download the PHP package gild/php-fixed without Composer
On this page you can find all versions of the php package gild/php-fixed. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download gild/php-fixed
More information about gild/php-fixed
Files in gild/php-fixed
Package php-fixed
Short Description It is a library that provides a mechanism to keep the commit log clean by performing a PSR-compliant php coding check before committing.
License MIT
Informations about the package php-fixed
概要
PSRに準拠したphpのコーディングチェックをコミット前に行うことでコミットログを綺麗に保つ機構を提供するライブラリです。
導入要件
- ローカル環境PHP > ver5.4
導入方法
composer.json
に以下追加します。
check, lint, lint:fixは任意で設定するものになります。
post-autoload-dumpが重要です。
post-autoload-dump
execution.sh {triggerType}
check
commitを行わずに、単にコーディングチェックから自動修正まで一気通貫して行いたい場合に使用します。これはlint
とlint:fix
の組み合わせです。
commit時に行われる、コーディングチェックから自動修正
までの処理はcomposer check
を呼び出しているわけではありません。
checkエイリアス自体の処理は本ライブラリを組み込む際の依存関係はないものとなります。
lintとlint:ixについても同様です。
lint
commitを行わずに、単にコーディングチェックを行いたい場合に使用します。
lint:fix
commitを行わずに、単に自動修正を行いたい場合に使用します。
管理対象ファイルについて
以下は管理対象ファイルとしてください。
phpcs.xml
このファイルはリポジトリ直下に生成されます。
Laravelをベースにルール定義していますが 、独自にルールを書き換えて自由に設定可能です。
Customisable Sniff Properties
ファイル名を変更することは可能ですが、main.sh
でファイル名変更することを忘れないで下さい。
main.sh
このファイルはリポジトリ直下に生成されるgit-hooks/pre-{triggerType}配下に生成されます。
処理自体は利用者が設定管理することが可能です。 ファイル名の変更は不可です。
gitクライアントソフトを介した挙動
※ CULでgitコマンドを直接打って操作する方は必要のない手順です。
チェックスクリプトはphpコマンドを介して実行されますが、gitクライアントソフトではphpのpathを読み込まないものもある為、 チェックスクリプトの処理開始冒頭で/usr/local/bin
を読み込むようにしています。
従って、ローカル環境に導入したphpのエイリアスを/usr/local/bin
に作っていただくことになります。
以下エイリアス作成例です。
既にphp5.4以上をローカルに導入してる場合はphpが格納されている場所を調べ、そちらのエイリアスを作成します。
gitクライアントソフトを利用する方は上記設定をしていないとコーディングチェックの自動化は行えません。
注意点
出力形式やログについて
以下のような出力形式が変わるオプションはphpcs.xml
に定義してはなりません。
ログを吐き出すようにするとチェックスクリプトが警告を捉えることができません。
チェックスクリプトを介さなければ自由に設定しても構いませんので、その為にcomposer.jsonのscriptsに独自定義します。
既にgit-hookを使われてる方について
本ライブラリ導入前にgit-hookを利用しているケースで既にpre-commitやpre-pushに何かしらのスクリプトを記述している場合を想定し、削除や上書きはしておりません。
pre-commitやpre-pushは.buckup
という接尾辞を付与して退避しています。
補足
可能であればローカル環境への別途導入物はライブラリに依存すべきではないと考えていますが、git操作はローカル環境においてdocker-containerから行うケースは殆どない為、各自のローカル環境に導入要件(php5.4以上)を組み込んでいただく必要がありました。