https://github.com/10up/phpcs-composer
Official 10up PHPCS rules.
https://github.com/10up/phpcs-composer
Last synced: 4 months ago
JSON representation
Official 10up PHPCS rules.
- Host: GitHub
- URL: https://github.com/10up/phpcs-composer
- Owner: 10up
- License: mit
- Created: 2018-05-09T00:56:11.000Z (over 7 years ago)
- Default Branch: trunk
- Last Pushed: 2023-12-14T21:42:58.000Z (about 2 years ago)
- Last Synced: 2025-08-07T22:59:25.520Z (5 months ago)
- Language: PHP
- Homepage:
- Size: 86.9 KB
- Stars: 50
- Watchers: 84
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 10up PHPCS Configuration
> Composer library to provide drop in installation and configuration of [WPCS](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards) and [PHPCompatibilityWP](https://github.com/PHPCompatibility/PHPCompatibilityWP), setting reasonable defaults for WordPress development with nearly zero configuration.
[](#support-level) [](https://github.com/10up/phpcs-composer/blob/master/LICENSE)
## Installation
Install the library via Composer:
```bash
$ composer require --dev 10up/phpcs-composer:"^3.0"
```
That's it!
## Usage
Lint your PHP files with the following command:
```bash
$ ./vendor/bin/phpcs .
```
If relying on Composer, edited the `composer.json` file by adding the following:
```json
"scripts": {
"lint": [
"phpcs ."
],
}
```
Then lint via:
```bash
$ composer run lint
```
### Continuous Integration
PHPCS Configuration plays nicely with Continuous Integration solutions. Out of the box, the library loads the `10up-Default` ruleset, and checks for syntax errors for PHP 8.2 or higher.
To override the default PHP version check, set the `--runtime-set testVersion 7.0-` configuration option. Example for PHP version 7.2 and above:
```bash
$ ./vendor/bin/phpcs --runtime-set testVersion 7.2-
```
See more [information about specifying PHP version](https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions).
Note that you can only overrule PHP version check from the command-line.
### IDE Integration
Some IDE integrations of PHPCS fail to register the `10up-Default` ruleset. In order to rectify this, place `.phpcs.xml.dist` at your project root:
```xml
```
## Support Level
**Active:** 10up is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome.
## Like what you see?
