Skip to content

Commit

Permalink
Merge pull request #706 from Automattic/feature/readme-update-for-com…
Browse files Browse the repository at this point in the history
…poser-2.2
  • Loading branch information
GaryJones authored Jan 1, 2022
2 parents d7d453e + 3f1b970 commit c4ffa53
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,23 @@ Go to https://docs.wpvip.com/technical-references/code-review/phpcs-report/ to l

## Installation

`composer require automattic/vipwpcs`, or `composer g require automattic/vipwpcs` if installing globally.
To install the VIP Coding Standards, run:
```bash
composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
composer require automattic/vipwpcs
```

or if installing globally:
```bash
composer g config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
composer g require automattic/vipwpcs
```

This will install the latest compatible versions of PHPCS, WPCS and VariableAnalysis and register the external standards with PHP_CodeSniffer.

Please refer to the [installation instructions for installing PHP_CodeSniffer for WordPress.com 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/Dealerdirect/phpcodesniffer-composer-installer) anymore as it is now a requirement of VIPCS itself.
As of VIPCS version 2.3.0, there is no need to `require` the [PHP_CodeSniffer Standards Composer Installer Plugin](https://github.com/Dealerdirect/phpcodesniffer-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.

## Contribution

Expand Down

0 comments on commit c4ffa53

Please sign in to comment.