Skip to content

Commit e9f3ce1

Browse files
author
ABaldwinHunter
committed
Add custom config example to readme
1 parent da19360 commit e9f3ce1

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

‎README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ PHP_CodeSniffer helps you detect violations of a defined coding standard.
1717
Format the values for these config options per the [PHP_CodeSniffer documentation](https://.com/squizlabs/PHP_CodeSniffer).
1818

1919
* file_extensions - This is where you can configure the file extensions for the files that you want PHP_CodeSniffer to analyze.
20-
* standard - This is the comma delimited list of standards that you want PHP_CodeSniffer to use while analyzing your files.
20+
* standard - This is the comma delimited list of standards that you want
21+
PHP_CodeSniffer to use while analyzing your files. You may optionally include
22+
a relative path to a custom phpcs ruleset.xml file.
2123
* ignore_warnings - You can hide warnings, and only report errors with this option.
2224
* encoding - By default, PHPCS uses ISO-8859-1. Use this to change it to your encoding, e.g. UTF-8.
2325

@@ -30,7 +32,7 @@ Format the values for these config options per the [PHP_CodeSniffer documentatio
3032
enabled: true
3133
config:
3234
file_extensions: "php,inc,lib"
33-
standard: "PSR1,PSR2"
35+
standard: "PSR1,PSR2,my_custom_php_ruleset.xml"
3436
ignore_warnings: true
3537
encoding: utf-8
3638
ratings:

0 commit comments

Comments
 (0)