Continuous integration/PHP CodeSniffer/ja

PHP CodeSniffer は、PHP コードのコード スタイルのエラーを検出するユーティリティです. CodeSniffer のバージョン、依存関係、実行を管理するラッパーとして、composer を使用しています.

まず、 を実行して開発の依存関係を取得します.

ほとんどの MediaWiki 拡張機能、外装、PHP ライブラリでは、 を実行すると CodeSniffer も実行されます. MediaWiki コアのサイズが大きいため、別のコマンドである  として公開されています.

Executing locally without composer
composer がタイムアウトする問題が発生した場合は、 で直接実行できます. すべての sniff が見つかるようにするため、ローカル プロジェクト リポジトリの vendor/bin に Composer でインストールされた PHP_CodeSniffer のバージョンを実行することが重要です. システムのバージョン、つまり PATH にあるものを使用しないでください.

メモリ不足のエラーが発生した場合は、メモリを増やして実行できます: .

Versioning
It is recommended that you pin a specific version in your  file. We try to adhere to the spirit of semver.org, but not the actual standard. The main thing we are concerned about is ensuring that no matter what, if when you run, it will pass if it previously passed, and not randomly fail because a new version was released. The build randomly failing is pain when you're trying to backport a patch or just trying to develop something and need to interrupt your work to fix it.

We are currently using 0 as our major version, and will bump the minor version for new sniffs, and bump the patch version for bug fixes or enhancements to existing sniffs. No stability is guaranteed for the actual PHP code included.

関連項目

 * Manual:Coding conventions/PHP
 * Extension:BoilerPlate is a skeleton extension, its  Continuous integration entry point runs PHP CodeSniffer
 * mediawiki-codesniffer (PHCS standard)
 * Continuous integration/Entry points
 * How to install - Instructions on how to install CodeSniffer for an extension
 * https://phpcs.toolforge.org/