4.0 | Wiki: updates for change of the default standard from PEAR to PSR12

Author: jrfnl

.github/workflows/basic-qa.yml

@@ -76,7 +76,7 @@ jobs:
 
       # Note: if less issues than expected were found, these numbers should be updated in the PR which fixes the issues!
       - name: Fail the build when more spelling issues were found than expected
-        if: ${{ always() && ( steps.spellcheck.outputs.number_of_issues != 5 || steps.spellcheck.outputs.number_of_files_with_issues != 3 ) }}
+        if: ${{ always() && ( steps.spellcheck.outputs.number_of_issues != 4 || steps.spellcheck.outputs.number_of_files_with_issues != 2 ) }}
         run: exit 1
 
   shellcheck:

build/wiki-code-samples/home/path/to/code/fileA.php

@@ -0,0 +1,14 @@
+<?php
+/**
+ * File docblock.
+ */
+
+namespace Foo;
+
+class Bar {
+    public function baz(Type  $param)
+    {
+        echo 'hello' . 'world and a lot more text to make this line way too long - trying to reach 120 characters, but that takes work';
+    return FALSE;
+    }
+}

build/wiki-code-samples/home/path/to/code/fileB.php

@@ -0,0 +1,7 @@
+<?php
+
+NAMESPACE Foo;
+
+if ($foo) {
+} else if ($bar) {
+}

wiki/About-Standards-for-PHP_CodeSniffer.md

@@ -50,7 +50,7 @@ You may also find the [Customisable Sniff Properties](https://github.com/PHPCSSt
 3. If no (project) ruleset file is found, PHP_CodeSniffer will check if a default standard has been set via `--config-set default_standard [Name]`.
     If so, PHP_CodeSniffer will use that standard.
     :warning: Setting the default standard is a user-specific setting, so should not be relied upon.
-4. If no system-default standard was set, PHP_CodeSniffer will apply the PEAR standard.
+4. If no system-default standard was set, PHP_CodeSniffer will apply the PSR12 standard.
 
 <p align="right"><a href="#table-of-contents">back to top</a></p>
 

wiki/Advanced-Usage.md

@@ -326,7 +326,7 @@ To view the currently set configuration options, use the `--config-show` command
 $ phpcs --config-show
 Array
 (
-    [default_standard] => PEAR
+    [default_standard] => PSR12
     [report_width] => 150
 )
 ```

wiki/Configuration-Options.md

@@ -7,7 +7,7 @@
 
 ## Setting the default coding standard
 
-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.
+By default, PHP_CodeSniffer will use the PSR12 coding standard if no standard is supplied on the command line. You can change the default standard by setting the `default_standard` configuration option.
 
 ```bash
 $ phpcs --config-set default_standard Squiz
@@ -16,6 +16,9 @@ $ phpcs --config-set default_standard Squiz
 > [!NOTE]
 > This configuration option cannot be set using the `--runtime-set` command line argument. To set the coding standard for a single run only, use the `--standard` command line argument.
 
+> [!NOTE]
+> Prior to PHP_CodeSniffer 4.0.0, PHP_CodeSniffer would default to the PEAR coding standard.
+
 <p align="right"><a href="#table-of-contents">back to top</a></p>
 
 

wiki/Home.md

@@ -6,49 +6,21 @@ PHP_CodeSniffer is an essential development tool that ensures your code remains
 
 A coding standard in PHP_CodeSniffer is a collection of sniff files. Each sniff file checks one part of the coding standard only. Each sniff can yield multiple error codes, a different one for each aspect of the code which was checked and found non-compliant.
 
-Multiple coding standards can be used within PHP_CodeSniffer so that the one installation can be used across multiple projects. The default coding standard used by PHP_CodeSniffer is the PEAR coding standard.
+Multiple coding standards can be used within PHP_CodeSniffer so that the one installation can be used across multiple projects.
+As of PHP_CodeSniffer 4.0.0, the default coding standard used by PHP_CodeSniffer is the PSR12 coding standard (previously, this was the PEAR standard).
 
 ## Example
 
-To check a file against the PEAR coding standard, simply specify the file's location.
+To check a file against the PSR12 coding standard, simply specify the file's location.
 
 ```bash
-$ phpcs /path/to/code/myfile.php
-
-FILE: /path/to/code/myfile.php
---------------------------------------------------------------------------------
-FOUND 5 ERROR(S) AFFECTING 2 LINE(S)
---------------------------------------------------------------------------------
-  2 | ERROR | Missing file doc comment
- 20 | ERROR | PHP keywords must be lowercase; expected "false" but found "FALSE"
- 47 | ERROR | Line not indented correctly; expected 4 spaces but found 1
- 51 | ERROR | Missing function doc comment
- 88 | ERROR | Line not indented correctly; expected 9 spaces but found 6
---------------------------------------------------------------------------------
+$ phpcs path/to/code/fileA.php
+{{COMMAND-OUTPUT "phpcs --parallel=1 --basepath=build/wiki-code-samples/home --no-colors build/wiki-code-samples/home/path/to/code/fileA.php"}}
 ```
 
 Or, if you wish to check an entire directory, you can specify the directory location instead of a file.
 
 ```bash
 $ phpcs /path/to/code
-
-FILE: /path/to/code/myfile.php
---------------------------------------------------------------------------------
-FOUND 5 ERROR(S) AFFECTING 5 LINE(S)
---------------------------------------------------------------------------------
-  2 | ERROR | Missing file doc comment
- 20 | ERROR | PHP keywords must be lowercase; expected "false" but found "FALSE"
- 47 | ERROR | Line not indented correctly; expected 4 spaces but found 1
- 51 | ERROR | Missing function doc comment
- 88 | ERROR | Line not indented correctly; expected 9 spaces but found 6
---------------------------------------------------------------------------------
-
-FILE: /path/to/code/yourfile.php
---------------------------------------------------------------------------------
-FOUND 1 ERROR(S) AND 1 WARNING(S) AFFECTING 1 LINE(S)
---------------------------------------------------------------------------------
- 21 | ERROR   | PHP keywords must be lowercase; expected "false" but found
-    |         | "FALSE"
- 21 | WARNING | Equals sign not aligned with surrounding assignments
---------------------------------------------------------------------------------
+{{COMMAND-OUTPUT "phpcs --parallel=1 --basepath=build/wiki-code-samples/home --no-colors build/wiki-code-samples/home/path/to/code"}}
 ```

wiki/Reporting.md

@@ -357,7 +357,7 @@ To use PHP_CodeSniffer with Emacs, make sure you have installed PHP mode for Ema
 ```emacs
 (require 'compile)
 (defun my-php-hook-function ()
- (set (make-local-variable 'compile-command) (format "phpcs --report=emacs --standard=PEAR %s" (buffer-file-name))))
+ (set (make-local-variable 'compile-command) (format "phpcs --report=emacs --standard=PSR12 %s" (buffer-file-name))))
 (add-hook 'php-mode-hook 'my-php-hook-function)
 ```
 

wiki/Usage.md

@@ -14,7 +14,7 @@ Running PHP_CodeSniffer with the `-h` or `--help` command line arguments will pr
 ```
 
 > [!NOTE]
-> The `--standard` command line argument is optional, even if you have more than one coding standard installed. If no coding standard is specified, PHP_CodeSniffer will default to checking against the _PEAR_ coding standard, or the standard you have set as the default. [View instructions for setting the default coding standard](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Configuration-Options#setting-the-default-coding-standard).
+> The `--standard` command line argument is optional, even if you have more than one coding standard installed. If no coding standard is specified, PHP_CodeSniffer will default to checking against the _PSR12_ coding standard, or the standard you have set as the default. [View instructions for setting the default coding standard](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Configuration-Options#setting-the-default-coding-standard).
 
 <p align="right"><a href="#table-of-contents">back to top</a></p>
 
@@ -148,7 +148,7 @@ With verbose output enabled, PHP_CodeSniffer will print the file that it is chec
 ```bash
 $ phpcs /path/to/code/CodeSniffer -v
 
-Registering sniffs in PEAR standard... DONE (28 sniffs registered)
+Registering sniffs in PSR12 standard... DONE (60 sniffs registered)
 Creating file list... DONE (158 files in queue)
 Changing into directory src/Standards/Generic/Sniffs/Arrays
 Processing ArrayIndentSniff.php [1409 tokens in 193 lines]... DONE in 39ms (4 errors, 20 warnings)
@@ -167,10 +167,10 @@ Processing OpeningBraceSameLineSniff.php [936 tokens in 123 lines]... DONE in 26
 
 PHP_CodeSniffer can have multiple coding standards installed to allow a single installation to be used with multiple projects. When checking PHP code, PHP_CodeSniffer can be told which coding standard to use. This is done using the `--standard` command line argument.
 
-The example below checks the `myfile.inc` file for violations against the _PEAR_ coding standard (installed by default).
+The example below checks the `myfile.inc` file for violations against the _PSR12_ coding standard (installed by default).
 
 ```bash
-$ phpcs --standard=PEAR /path/to/code/myfile.inc
+$ phpcs --standard=PSR12 /path/to/code/myfile.inc
 ```
 
 You can also tell PHP_CodeSniffer to use an external standard by specifying the full path to the standard's root directory on the command line. An external standard is one that is stored outside of PHP_CodeSniffer's `Standards` directory.
@@ -182,7 +182,7 @@ $ phpcs --standard=/path/to/MyStandard /path/to/code/myfile.inc
 Multiple coding standards can be checked at the same time by passing a list of comma separated standards on the command line. A mix of external and installed coding standards can be passed if required.
 
 ```bash
-$ phpcs --standard=PEAR,Squiz,/path/to/MyStandard /path/to/code/myfile.inc
+$ phpcs --standard=PSR12,Squiz,/path/to/MyStandard /path/to/code/myfile.inc
 ```
 
 <p align="right"><a href="#table-of-contents">back to top</a></p>