Skip to content

Commit ab91cce

Browse files
committed
Configuration Options: improve readability and clarity
1 parent 1a41c1e commit ab91cce

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

wiki/Configuration-Options.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
## Setting the default coding standard
2828

29-
By default, PHP_CodeSniffer will use the PEAR coding standard if no standard is supplied on the command line. You can change the default standard by setting the default_standard configuration option.
29+
By default, PHP_CodeSniffer will use the PEAR coding standard if no standard is supplied on the command line. You can change the default standard by setting the `default_standard` configuration option.
3030

3131
```bash
3232
$ phpcs --config-set default_standard Squiz
@@ -40,7 +40,7 @@ $ phpcs --config-set default_standard Squiz
4040

4141
## Setting the default report format
4242

43-
By default, PHP_CodeSniffer will use the full report format if no format is supplied on the command line. You can change the default report format by setting the report_format configuration option.
43+
By default, PHP_CodeSniffer will use the full report format if no format is supplied on the command line. You can change the default report format by setting the `report_format` configuration option.
4444

4545
```bash
4646
$ phpcs --config-set report_format summary
@@ -201,7 +201,7 @@ $ phpcs --config-set php_version 70416
201201
```
202202
203203
> [!IMPORTANT]
204-
> The format of the `php_version` value is the same as the PHP_VERSION_ID constant. e.g., 70416 for version 7.4.16.
204+
> The format of the `php_version` value is the same as the `PHP_VERSION_ID` constant. E.g. `70416` for version `7.4.16`.
205205
206206
<p align="right"><a href="#table-of-contents">back to top</a></p>
207207
@@ -239,37 +239,37 @@ $ phpcs --config-set ignore_warnings_on_exit 1
239239
240240
### Setting the path to CSSLint
241241
242-
The Generic coding standard [includes a sniff](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/src/Standards/Generic/Sniffs/Debug/CSSLintSniff.php) that will check each CSS file using [CSS Lint](http://csslint.net/). Use the `csslint_path` configuration option to tell the CSSLint sniff where to find the tool.
242+
The `Generic.Debug.CSSLint` sniff will check each CSS file using [CSS Lint](http://csslint.net/). Use the `csslint_path` configuration option to tell the CSSLint sniff where to find the tool.
243243
244244
```bash
245245
$ phpcs --config-set csslint_path /path/to/csslint
246246
```
247247
248248
### Setting the path to the Google Closure Linter
249249
250-
The Generic coding standard [includes a sniff](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/src/Standards/Generic/Sniffs/Debug/ClosureLinterSniff.php) that will check each file using the [Google Closure Linter](https://github.com/google/closure-linter), an open source JavaScript style checker from Google. Use the `gjslint_path` configuration option to tell the Google Closure Linter sniff where to find the tool.
250+
The `Generic.Debug.ClosureLinter` sniff will check each file using the [Google Closure Linter](https://github.com/google/closure-linter), an open source JavaScript style checker from Google. Use the `gjslint_path` configuration option to tell the Google Closure Linter sniff where to find the tool.
251251
252252
```bash
253253
$ phpcs --config-set gjslint_path /path/to/gjslint
254254
```
255255
256256
### Setting the path to PHP
257257
258-
The Generic coding standard [includes a sniff](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/src/Standards/Generic/Sniffs/PHP/SyntaxSniff.php) that will check the syntax of each PHP file using [the built-in PHP linter](http://php.net/manual/en/features.commandline.options.php). Use the `php_path` configuration option to tell the Syntax sniff where to find the PHP binary.
258+
The `Generic.PHP.Syntax` sniff will check the syntax of each PHP file using [the built-in PHP linter](http://php.net/manual/en/features.commandline.options.php). Use the `php_path` configuration option to tell the Syntax sniff where to find the PHP binary.
259259
260260
```bash
261261
$ phpcs --config-set php_path /path/to/php
262262
```
263263
264264
### Setting the path to JSHint
265265
266-
The Generic coding standard [includes a sniff](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/src/Standards/Generic/Sniffs/Debug/JSHintSniff.php) that will check each JavaScript file using [JSHint](http://www.jshint.com/), a tool to detect errors and potential problems in JavaScript code. Use the `jshint_path` configuration option to tell the JSHint sniff where to find the tool.
266+
The `Generic.Debug.JSHint` sniff will check each JavaScript file using [JSHint](http://www.jshint.com/), a tool to detect errors and potential problems in JavaScript code. Use the `jshint_path` configuration option to tell the JSHint sniff where to find the tool.
267267
268268
```bash
269269
$ phpcs --config-set jshint_path /path/to/jshint.js
270270
```
271271
272-
As JSHint is just JavaScript code, you also need to install [Rhino](http://www.mozilla.org/rhino/) to be able to execute it. Use the `rhino_path` configuration option to tell the JSHint sniff where to find the tool.
272+
As JSHint is just JavaScript code, you may also need to install [Rhino](http://www.mozilla.org/rhino/) to be able to execute it. Use the `rhino_path` configuration option to tell the JSHint sniff where to find the tool.
273273
274274
```bash
275275
$ phpcs --config-set rhino_path /path/to/rhino
@@ -282,21 +282,21 @@ $ phpcs --config-set rhino_path /path/to/rhino
282282
283283
### Setting the path to JSLint
284284
285-
The Squiz coding standard [includes a sniff](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/src/Standards/Squiz/Sniffs/Debug/JSLintSniff.php) that will check each JavaScript file using [JSLint](http://www.jslint.com/), a JavaScript program that looks for problems in JavaScript programs. Use the `jslint_path` configuration option to tell the JSLint sniff where to find the tool.
285+
The `Squiz.Debug.JSLint` sniff will check each JavaScript file using [JSLint](http://www.jslint.com/), a JavaScript program that looks for problems in JavaScript programs. Use the `jslint_path` configuration option to tell the JSLint sniff where to find the tool.
286286
287287
```bash
288288
$ phpcs --config-set jslint_path /path/to/jslint.js
289289
```
290290
291-
As JSLint is just JavaScript code, you also need to install [Rhino](https://developer.mozilla.org/en-US/docs/Rhino) to be able to execute it. Use the `rhino_path` configuration option to tell the JSLint sniff where to find the tool.
291+
As JSLint is just JavaScript code, you may also need to install [Rhino](https://developer.mozilla.org/en-US/docs/Rhino) to be able to execute it. Use the `rhino_path` configuration option to tell the JSLint sniff where to find the tool.
292292
293293
```bash
294294
$ phpcs --config-set rhino_path /path/to/rhino
295295
```
296296
297297
### Setting the path to JavaScript Lint
298298
299-
The Squiz coding standard [includes a sniff](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/src/Standards/Squiz/Sniffs/Debug/JavaScriptLintSniff.php) that will check each JavaScript file using [JavaScript Lint](http://www.javascriptlint.com/), a tool that checks all your JavaScript source code for common mistakes without actually running the script or opening the web page. Use the `jsl_path` configuration option to tell the JavaScript Lint sniff where to find the tool.
299+
The `Squiz.Debug.JavascriptLint` sniff will check each JavaScript file using [JavaScript Lint](http://www.javascriptlint.com/), a tool that checks all your JavaScript source code for common mistakes without actually running the script or opening the web page. Use the `jsl_path` configuration option to tell the JavaScript Lint sniff where to find the tool.
300300
301301
```bash
302302
$ phpcs --config-set jsl_path /path/to/jsl
@@ -309,7 +309,7 @@ $ phpcs --config-set jsl_path /path/to/jsl
309309
310310
### Setting the path to the Zend Code Analyzer
311311
312-
The Zend coding standard [includes a sniff](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/src/Standards/Zend/Sniffs/Debug/CodeAnalyzerSniff.php) that will check each file using the Zend Code Analyzer, a tool that comes with Zend Studio. Use the `zend_ca_path` configuration option to tell the Zend Code Analyzer sniff where to find the tool.
312+
The `Zend.Debug.CodeAnalyzer` sniff will check each file using the Zend Code Analyzer, a tool that comes with Zend Studio. Use the `zend_ca_path` configuration option to tell the Zend Code Analyzer sniff where to find the tool.
313313
314314
```bash
315315
$ phpcs --config-set zend_ca_path /path/to/ZendCodeAnalyzer

0 commit comments

Comments
 (0)