diff --git a/wiki/About-Standards-for-PHP_CodeSniffer.md b/wiki/About-Standards-for-PHP_CodeSniffer.md index d84a1a9..7a6111d 100644 --- a/wiki/About-Standards-for-PHP_CodeSniffer.md +++ b/wiki/About-Standards-for-PHP_CodeSniffer.md @@ -34,14 +34,14 @@ The typical differences between project-specific rulesets and standards are: | Will automatically be used when no standard is provided on the command line ? | Yes | No | | Can have custom sniffs ? | No | Yes | | Can be installed ? | No | Yes | -| Reusability by other projects ? | Limited | Yes | +| Re-usability by other projects ? | Limited | Yes | -For optimal reusability, it is in most cases a good idea for a standard to be in its own repository and to be maintained as a separate project. +For optimal re-usability, it is in most cases a good idea for a standard to be in its own repository and to be maintained as a separate project. A `[.]phpcs.xml[.dist]` file and a `ruleset.xml` file can largely contain the same type of directives. The [Annotated ruleset](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Annotated-Ruleset) page contains information on all the directives you can use. -Keep in mind that for a _standard_ to be optimally reusable, it should not contain project specific information, such as `` directives or ``, while a project specific `[.]phpcs.xml[.dist]` ruleset file _can_ contain that information. +Keep in mind that for a _standard_ to be optimally re-usable, it should not contain project specific information, such as `` directives or ``, while a project specific `[.]phpcs.xml[.dist]` ruleset file _can_ contain that information. You may also find the [Customisable Sniff Properties](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Customisable-Sniff-Properties) page a handy reference for customisations which can be made to PHP_CodeSniffer native sniffs. @@ -253,7 +253,7 @@ use PHP_CodeSniffer\Sniffs\Sniff; class OperatorSpacingSniff implements Sniff {...} ``` -:x: Not following the required directory structure (missing `[CategoryName]` subdirectory): +:x: Not following the required directory structure (missing `[CategoryName]` sub-directory): ```php back to top

@@ -351,13 +351,13 @@ Array

back to top

-## Printing Verbose Tokeniser Output +## Printing Verbose Tokenizer Output This feature is provided for debugging purposes only. Using this feature will dramatically increase screen output and script running time. -PHP_CodeSniffer contains multiple verbosity levels. Level 2 (indicated by the command line argument `-vv`) will print all verbosity information for level 1 (file specific token and line counts with running times) as well as verbose tokeniser output. +PHP_CodeSniffer contains multiple verbosity levels. Level 2 (indicated by the command line argument `-vv`) will print all verbosity information for level 1 (file specific token and line counts with running times) as well as verbose tokenizer output. -The output of the PHP_CodeSniffer tokeniser shows the step-by-step creation of the scope map and the level map. +The output of the PHP_CodeSniffer tokenizer shows the step-by-step creation of the scope map and the level map. ### The Scope Map @@ -456,7 +456,7 @@ The level map is most commonly used to determine indentation rules (e.g., a toke This feature is provided for debugging purposes only. Using this feature will dramatically increase screen output and script running time. -PHP_CodeSniffer contains multiple verbosity levels. Level 3 (indicated by the command line argument `-vvv`) will print all verbosity information for level 1 (file specific token and line counts with running times), level 2 (tokeniser output) as well as token processing output with sniff running times. +PHP_CodeSniffer contains multiple verbosity levels. Level 3 (indicated by the command line argument `-vvv`) will print all verbosity information for level 1 (file specific token and line counts with running times), level 2 (tokenizer output) as well as token processing output with sniff running times. The token processing output is best explained with an example. For the following file: diff --git a/wiki/Annotated-Ruleset.md b/wiki/Annotated-Ruleset.md index 7924264..239eb76 100644 --- a/wiki/Annotated-Ruleset.md +++ b/wiki/Annotated-Ruleset.md @@ -133,7 +133,7 @@ The following sample file documents the ruleset.xml format and shows you the com directory because it does not exist inside the PHP_CodeSniffer install directory. --> - + - +