Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spaceemotion/php-coding-standard
Combines various code quality tools into a single command with shared output for easier CI integration
https://github.com/spaceemotion/php-coding-standard
analysis automation code-quality hacktoberfest linting php
Last synced: 3 months ago
JSON representation
Combines various code quality tools into a single command with shared output for easier CI integration
- Host: GitHub
- URL: https://github.com/spaceemotion/php-coding-standard
- Owner: spaceemotion
- License: isc
- Created: 2020-03-03T22:19:10.000Z (almost 5 years ago)
- Default Branch: wip/v1
- Last Pushed: 2024-05-31T20:52:39.000Z (8 months ago)
- Last Synced: 2024-09-19T03:09:50.039Z (5 months ago)
- Topics: analysis, automation, code-quality, hacktoberfest, linting, php
- Language: PHP
- Homepage:
- Size: 203 KB
- Stars: 18
- Watchers: 3
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/spaceemotion/php-coding-standard)
[](https://packagist.org/packages/spaceemotion/php-coding-standard)
# php-coding-standard (phpcstd)
`phpcstd` combines various code quality tools (e.g. linting and static analysis)
into one, easy to use package which can be shared across teams and code bases.
There are two parts to this:
1. `phpcstd` executes all the enabled tools and returns a single per-file error output
2. In your projects, you depend on a single repository (e.g. `acme/coding-standard`)
which depends on `phpcstd` and includes the various base configurations
(e.g. phpmd.xml, ecs.yaml, ...). Your own projects then depend on your own coding standard.
`phpcstd` itself does not come with any tools preinstalled.
You can take a look at [my own coding standards](https://github.com/spaceemotion/my-php-coding-standard) as an example.
#### Tools supported
Tool | Lint | Fix | Source list | Description
-----|------|-----|-------------|-----------
⭐ [EasyCodingStandard](https://github.com/symplify/easy-coding-standard) | ✅ | ✅ | ✅ | Combination of PHP_CodeSniffer and PHP-CS-Fixer
[PHP Mess Detector](https://github.com/phpmd/phpmd) | ✅ | ❌ | ✅ | Code complexity checker
[PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) | ✅ | ✅ | ✅ | Style linter + fixer
⭐ [composer-normalize](https://github.com/ergebnis/composer-normalize) | ✅ | ✅ | ✅ | Validates and rearranges composer.json files
[phan](https://github.com/phan/phan) | ✅ | ✅ | ❌ | Static analyzer, requires the "php-ast" extension
⭐ [php-parallel-lint](https://github.com/php-parallel-lint/php-parallel-lint) | ✅ | ❌ | ✅ | Checks for PHP (syntax) errors (using `php -l`)
⭐ [phpstan](https://github.com/phpstan/phpstan) | ✅ | ❌ | ⏹ | Static analyzer, source list is optional, but not recommended
[psalm](https://github.com/vimeo/psalm) | ✅ | ✅ | ✅ | Static analyzer
⭐ [rector](https://github.com/rectorphp/rector) | ✅ | ✅ | ✅ | Code up-/downgrading and refactoring tool
[deptrac](https://github.com/qossmic/deptrac) | ✅ | ❌ | ❌ | Static analyzer that enforces rules for dependencies between software layers
_⭐ = recommended_
## Getting started
```
composer require-dev spaceemotion/php-coding-standard
```
This will install the `phpcstd` binary to your vendor folder.
### Configuration via .phpcstd(.dist).ini
To minimize dependencies, `phpcstd` uses .ini-files for its configuration.
If no `.phpcstd.ini` file can be found in your project folder,
a `.phpcstd.dist.ini` file will be used as fallback (if possible).
### Command options
```
Usage:
run [options] [--] [...]
Arguments:
files List of files to parse instead of the configured sources
Options:
-s, --skip=SKIP Disables the list of tools during the run (comma-separated list) (multiple values allowed)
-o, --only=ONLY Only executes the list of tools during the run (comma-separated list) (multiple values allowed)
--continue Run the next check even if the previous one failed
--fix Try to fix any linting errors
--hide-source Hides the "source" lines from console output
--lint-staged Uses "git diff" to determine staged files to lint
--ci Changes the output format to GithubActions for better CI integration
--no-fail Only returns with exit code 0, regardless of any errors/warnings
-h, --help Display help for the given command. When no command is given display help for the run command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
```
Instead of defining the files/folders directly (in either the config or as arguments), you can also pipe a list into it:
```
$ ls -A1 | vendor/bin/phpcstd
```
## Git Hooks
To not have to wait for CI pipelines to finish, you can use git hooks to run over the changed files before committing.
```sh
vendor/bin/phpcstd --lint-staged
```
## CI-Support
### Github Actions
The `--ci` flag returns a format that can be used by GithubActions to annotate commits and PRs
(see [their documentation on how this works](https://github.com/actions/toolkit/blob/master/docs/commands.md#problem-matchers)).
## Development
### Using Docker
1. Spin up the container using `GITHUB_PERSONAL_ACCESS_TOKEN= docker-compose up -d --build`
2. Run all commands using `docker-compose exec php `
### Using XDebug
This project uses [composer/xdebug-handler](https://github.com/composer/xdebug-handler) to improve performance
by disabling xdebug upon startup. To enable XDebug during development you need to set the following env variable:
`PHPCSTD_ALLOW_XDEBUG=1` (as written in their README).