https://github.com/grohiro/php-ruleset
Ruleset for PHP
https://github.com/grohiro/php-ruleset
php phpcs phpmd static-analysis
Last synced: 11 months ago
JSON representation
Ruleset for PHP
- Host: GitHub
- URL: https://github.com/grohiro/php-ruleset
- Owner: grohiro
- License: mit
- Created: 2018-10-26T09:53:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-07T12:13:10.000Z (over 7 years ago)
- Last Synced: 2025-02-24T01:48:25.822Z (over 1 year ago)
- Topics: php, phpcs, phpmd, static-analysis
- Language: PHP
- Size: 8.79 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# php-ruleset
PHP のコーディングスタイルの検査, 自動整形するためのルールセット。
# Install
composer.json に Github リポジトリを追加
```
"repositories": [
{
"type": "vcs",
"url": "https://github.com/grohiro/php-ruleset"
}
]
```
インストール
```
$ composer require grohiro/php-ruleset dev-master
```
フレームワークにあわせて composer.json にスクリプトを追加。
## Laravel
ソースコードディレクトリに `app/` と `tests/` を指定。
```json
"scripts": {
"cs-check": "phpcs --colors -p --standard=vendor/grohiro/php-ruleset/ruleset/laravel/phpcs-ruleset.xml ./app ./tests",
"cs-fix": "phpcbf --colors --standard=vendor/grohiro/php-ruleset/ruleset/laravel/phpcs-ruleset.xml ./app ./tests",
"phpmd": "phpmd ./app text vendor/grohiro/php-ruleset/ruleset/laravel/phpmd-ruleset.xml"
}
```
## CakePHP3
ソースコードディレクトリに `src/` と `tests/` を指定。
```json
"scripts": {
"cs-check": "phpcs --colors -p --standard=vendor/grohiro/php-ruleset/ruleset/cakephp/phpcs-ruleset.xml ./app ./tests",
"cs-fix": "phpcbf --colors --standard=vendor/grohiro/php-ruleset/ruleset/cakephp/phpcs-ruleset.xml ./app ./tests",
"phpmd": "phpmd ./app text vendor/grohiro/php-ruleset/ruleset/cakephp/phpmd-ruleset.xml"
}
```
# Usage
コーディングスタイルの検査
```bash
$ composer run cs-check
```
コーディングスタイルの自動修正
```bash
$ composer run cs-fix
```
コードの静的解析。複雑なコード、Best Practiceに沿っていないコードの検出。
```bash
$ composer run phpmd
```