Skip to content

Commit

Permalink
Explicitly recommend v0.3.x of the DealerDirect Composer plugin
Browse files Browse the repository at this point in the history
Version 0.4.x of the DealerDirect Composer plugin registers each standard individually as if they were root-directory standards, not a collection of standards which exposes a bug in PHPCS 3.x.

Refs:
* squizlabs/PHP_CodeSniffer/pull/1581
* PHPCSStandards/composer-installer/issues/33
  • Loading branch information
jrfnl committed Aug 1, 2017
1 parent 43b32fa commit c71684e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ For the convenience of using `phpcs` as a global command, you may want to add th
When installing the WordPress Coding Standards as a dependency in a larger project, the above mentioned step 3 will not be executed automatically.

There are two actively maintained Composer plugins which can handle the registration of standards with PHP_CodeSniffer for you:
* [composer-phpcodesniffer-standards-plugin](https://github.com/higidi/composer-phpcodesniffer-standards-plugin)
* [phpcodesniffer-composer-installer](https://github.com/DealerDirect/phpcodesniffer-composer-installer)
* [composer-phpcodesniffer-standards-plugin](https://github.com/higidi/composer-phpcodesniffer-standards-plugin). Version 0.3.x is recommended until [DealerDirect/phpcodesniffer-composer-installer#33](https://github.com/DealerDirect/phpcodesniffer-composer-installer/issues/33) has been solved.
* [phpcodesniffer-composer-installer](https://github.com/DealerDirect/phpcodesniffer-composer-installer).

It is strongly suggested to `require` one of these plugins in your project to handle the registration of external standards with PHPCS for you.

Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"squizlabs/php_codesniffer": "^2.9.0 || ^3.0.2"
},
"suggest" : {
"dealerdirect/phpcodesniffer-composer-installer": "*"
"dealerdirect/phpcodesniffer-composer-installer": "0.3.*"
},
"minimum-stability" : "RC",
"support" : {
Expand Down

0 comments on commit c71684e

Please sign in to comment.