PHPCSStandards / PHP_CodeSniffer / 13348994903

79%

push

github

Help: update list of config options

Follow up on 447

I noticed while working on something else that some typical config options were missing from the list in the help text.

The difference between the previously listed ones and the additional options I'm now adding to the list, is that the original set of options are options which the `Config` class manages and for which it has a default value, while the additional options I'm now adding are used at runtime in various places by PHPCS, but do not have default value management in the `Config` class.

Whether default value handling of these options should be added to the `Config` class is up for debate, however, making it more discoverable that these options _exist_ and can be used, seems like an easy win for usability.

* `installed_paths` is probably the best known one and is used to register external standards with PHPCS. It is used in the `Util\Standards` class.
* `php_version` is a way to tell PHPCS what PHP version they code is supposed to run on. It is used by select sniffs.
* `ignore_errors_on_exit` and `ignore_warnings_on_exit` influence the exit code used by PHPCS and is used in the `Runner` class.

These additional options are all mentioned and described in more detail in the wiki: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Configuration-Options

Fixes squizlabs/PHP_CodeSniffer 2412

1 of 1 new or added line in 1 file covered. (100.0%)

24680 of 31427 relevant lines covered (78.53%)

66.31 hits per line