Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/automattic/vip-coding-standards
PHP_CodeSniffer ruleset to enforce WordPress VIP coding standards.
https://github.com/automattic/vip-coding-standards
php-codesniffer phpcs ruleset vip wordpress
Last synced: 3 days ago
JSON representation
PHP_CodeSniffer ruleset to enforce WordPress VIP coding standards.
- Host: GitHub
- URL: https://github.com/automattic/vip-coding-standards
- Owner: Automattic
- License: other
- Created: 2016-10-11T11:50:11.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-08T22:16:39.000Z (7 months ago)
- Last Synced: 2024-04-08T23:32:21.865Z (7 months ago)
- Topics: php-codesniffer, phpcs, ruleset, vip, wordpress
- Language: PHP
- Homepage: https://wpvip.com/documentation/how-to-install-php-code-sniffer-for-wordpress-com-vip/
- Size: 1.63 MB
- Stars: 228
- Watchers: 11
- Forks: 41
- Open Issues: 110
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-network-stuff - **80**星
README
# VIP Coding Standards
This project contains [PHP_CodeSniffer (PHPCS) sniffs and rulesets](https://github.com/PHPCSStandards/PHP_CodeSniffer) to validate code developed for [WordPress VIP](https://wpvip.com/).
This project contains two rulesets:
- `WordPressVIPMinimum` - for use with projects on the (older) WordPress.com VIP platform.
- `WordPress-VIP-Go` - for use with projects on the (newer) VIP Go platform.
These rulesets contain only the rules which are considered to be [errors](https://docs.wpvip.com/php_codesniffer/errors/) and [warnings](https://docs.wpvip.com/php_codesniffer/warnings/) according to the WordPress VIP documentation.
The rulesets use rules from the [WordPress Coding Standards](https://github.com/WordPress/WordPress-Coding-Standards) (WPCS) project, as well as the [VariableAnalysis](https://github.com/sirbrillig/phpcs-variable-analysis) standard.
[Learn](https://docs.wpvip.com/vip-code-analysis-bot/phpcs-report/) about why violations are flagged as errors vs warnings and what the levels mean.
## Minimal requirements
* PHP 5.4+
* [PHPCS 3.8.0+](https://github.com/PHPCSStandards/PHP_CodeSniffer/releases)
* [PHPCSUtils 1.0.9+](https://github.com/PHPCSStandards/PHPCSUtils)
* [PHPCSExtra 1.2.1+](https://github.com/PHPCSStandards/PHPCSExtra)
* [WPCS 3.0.0+](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/releases)
* [VariableAnalysis 2.11.17+](https://github.com/sirbrillig/phpcs-variable-analysis/releases)
## Installation
[Composer](https://getcomposer.org/) will install the latest compatible versions of PHPCS, PHPCSUtils, PHPCSExtra, WPCS and VariableAnalysis and register the external standards with PHP_CodeSniffer.
Please refer to the [installation instructions for installing PHP_CodeSniffer for WordPress VIP](https://docs.wpvip.com/how-tos/code-review/php_codesniffer/) for more details.
As of VIPCS version 2.3.0, there is no need to `require` the [PHP_CodeSniffer Standards Composer Installer Plugin](https://github.com/PHPCSStandards/composer-installer) anymore as it is now a requirement of VIPCS itself. Permission to run the plugin will still need to be granted though when using Composer 2.2 or higher.
### Composer Project-based Installation
To install the VIP Coding Standards, run the following from the root of your project:
```bash
composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
composer require --dev automattic/vipwpcs
```
### Composer Global Installation
Alternatively, it can be installed standard globally for use across multiple projects:
```bash
composer global config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
composer global require --dev automattic/vipwpcs
```
## Contribution
Please see [CONTRIBUTION.md](.github/CONTRIBUTING.md).
## License
Licensed under [GPL-2.0-or-later](LICENSE.md).