Repolode
slevomat

slevomat/coding-standard

PHP_CodeSniffer用の多数のsniffを収録し、自動修正にも対応した、より安全で読みやすく一貫性のあるPHPコードを実現するルールセット。

スター
1,478
フォーク
197
未解決の Issue
93
最終コミット
一昨日

これは何?

Slevomat Coding Standardは、PHPのソースコードがコーディング規約に準拠しているかを検査するツールPHP_CodeSniffer用のルールセットです。多数の個別sniffを収録し、安全性や動作を改善する機能ルール、不要なコードを検出するクリーンアップルール、コードの見た目を統一するフォーマットルールの3分野に分類しています。

多くのsniffが、attributes、enums、union types、named arguments、constructor property promotionなど、近年のPHP機能に対応しています。修正可能と明記されたsniffはphpcbfで自動適用できます。また、プロジェクトで例外が必要な場合は、@phpcsSuppressアノテーションを使って一部のsniffを局所的に抑制できます。

この標準は、Composerのdev dependencyとしてインストールします。推奨される方法は、プロジェクト独自のruleset.xmlで必要なsniffだけを指定することです。ルールセット全体を読み込み、特定のsniffを除外することもできます。

主な機能

  • 01配列、クラス、制御構造、関数、名前空間、型ヒントなどを網羅。
  • 02多数のsniffで、phpcbfによる違反の自動修正が可能。
  • 03未使用の変数、パラメーター、importなどの不要なコードを検出。
  • 04attributes、enums、union typesなど、近年のPHP構文に対応。
  • 05個別のsniffを選択したり、特定のsniffを除外したりできる。

ユースケース

  • チームのプロジェクト全体でPHPのコードスタイルを統一する。
  • 継続的インテグレーションで未使用コードやリスクのある構文を検出する。
  • phpcbfでレガシーなPHPコードベースを自動的に整理する。
  • 厳選したsniffを組み合わせて、独自のPHPコーディング規約を作成する。

クイックスタート

  1. 1

    Composer でコーディング規約を開発用依存関係としてインストールします

    composer require --dev slevomat/coding-standard
  2. 2

    PHP_CodeSniffer がこのコーディング規約を使うように設定し、コードに対して実行します

使う前に知っておきたいこと

  • 依存関係として PHP_CodeSniffer が必要なため、PHP と Composer の環境が必要です。

収録されている特集

トピック

#php#code-style#linting#phpcs#static-analysis#coding-standard#php7#php8#phpcodesniffer

よくある質問

coding-standard とは?
PHP_CodeSniffer用の多数のsniffを収録し、自動修正にも対応した、より安全で読みやすく一貫性のあるPHPコードを実現するルールセット。 Slevomat Coding Standardは、PHPのソースコードがコーディング規約に準拠しているかを検査するツールPHP_CodeSniffer用のルールセットです。多数の個別sniffを収録し、安全性や動作を改善する機能ルール、不要なコードを検出するクリーンアップルール、コードの見た目を統一するフォーマットルールの3分野に分類しています。
coding-standard は無料で使えますか?ライセンスは?
coding-standard は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
coding-standard は今もメンテナンスされていますか?
活発にメンテナンス中。coding-standard の最終コミットは 2026年11月5日 です。
coding-standard は何に使えますか?
チームのプロジェクト全体でPHPのコードスタイルを統一する。 継続的インテグレーションで未使用コードやリスクのある構文を検出する。 phpcbfでレガシーなPHPコードベースを自動的に整理する。 厳選したsniffを組み合わせて、独自のPHPコーディング規約を作成する。
coding-standard のインストール方法は?
Composer でコーディング規約を開発用依存関係としてインストールします: composer require --dev slevomat/coding-standard PHP_CodeSniffer がこのコーディング規約を使うように設定し、コードに対して実行します
coding-standard はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/slevomat/coding-standard

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト