Merge branch 'master' into feature/support-generics

Author: tm1000

.github/workflows/phpstan.yml

@@ -20,7 +20,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install PHP
         uses: shivammathur/setup-php@v2
@@ -33,7 +33,7 @@ jobs:
       # Dependencies need to be installed to make sure the PHPUnit classes are recognized.
       # @link https://github.com/marketplace/actions/install-composer-dependencies
       - name: Install Composer dependencies
-        uses: "ramsey/composer-install@v1"
+        uses: "ramsey/composer-install@v2"
 
       - name: Run PHPStan
         run: phpstan analyse --configuration=phpstan.neon

.github/workflows/test.yml

@@ -26,7 +26,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -39,7 +39,7 @@ jobs:
         run: php scripts/build-phar.php
 
       - name: Upload the PHPCS phar
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         if: ${{ success() && matrix.php == '8.0' }}
         with:
           name: phpcs-phar
@@ -48,7 +48,7 @@ jobs:
           retention-days: 28
 
       - name: Upload the PHPCBF phar
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         if: ${{ success() && matrix.php == '8.0' }}
         with:
           name: phpcbf-phar
@@ -89,19 +89,19 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup ini config
         id: set_ini
         run: |
           # Set the "short_open_tag" ini to make sure specific conditions are tested.
           # Also turn on error_reporting to ensure all notices are shown.
           if [[ ${{ matrix.custom_ini }} == true && "${{ matrix.php }}" == '5.5' ]]; then
-            echo '::set-output name=PHP_INI::error_reporting=-1, display_errors=On, date.timezone=Australia/Sydney, short_open_tag=On, asp_tags=On'
+            echo 'PHP_INI=error_reporting=-1, display_errors=On, date.timezone=Australia/Sydney, short_open_tag=On, asp_tags=On' >> $GITHUB_OUTPUT
           elif [[ ${{ matrix.custom_ini }} == true && "${{ matrix.php }}" == '7.0' ]]; then
-            echo '::set-output name=PHP_INI::error_reporting=-1, display_errors=On, date.timezone=Australia/Sydney, short_open_tag=On'
+            echo 'PHP_INI=error_reporting=-1, display_errors=On, date.timezone=Australia/Sydney, short_open_tag=On' >> $GITHUB_OUTPUT
           else
-            echo '::set-output name=PHP_INI::error_reporting=-1, display_errors=On'
+            echo 'PHP_INI=error_reporting=-1, display_errors=On' >> $GITHUB_OUTPUT
           fi
 
       - name: Install PHP
@@ -116,12 +116,12 @@ jobs:
       # @link https://github.com/marketplace/actions/install-composer-dependencies
       - name: Install Composer dependencies - normal
         if: ${{ matrix.php < '8.0' }}
-        uses: "ramsey/composer-install@v1"
+        uses: "ramsey/composer-install@v2"
 
       # For PHP 8.0+, we need to install with ignore platform reqs as PHPUnit 7 is still used.
       - name: Install Composer dependencies - with ignore platform
         if: ${{ matrix.php >= '8.0' }}
-        uses: "ramsey/composer-install@v1"
+        uses: "ramsey/composer-install@v2"
         with:
           composer-options: --ignore-platform-reqs
 
@@ -159,7 +159,7 @@ jobs:
         run: composer validate --no-check-all --strict
 
       - name: Download the PHPCS phar
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
         with:
           name: phpcs-phar
 

.github/workflows/validate.yml

@@ -22,10 +22,12 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install xmllint
-        run: sudo apt-get install --no-install-recommends -y libxml2-utils
+        run: |
+          sudo apt-get update
+          sudo apt-get install --no-install-recommends -y libxml2-utils
 
       - name: Retrieve XML Schema
         run: curl -O https://www.w3.org/2012/04/XMLSchema.xsd
@@ -63,7 +65,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install PHP
         uses: shivammathur/setup-php@v2

README.md

@@ -33,9 +33,9 @@ php phpcbf.phar -h
 
 ### Composer
 If you use Composer, you can install PHP_CodeSniffer system-wide with the following command:
-
-    composer global require "squizlabs/php_codesniffer=*"
-
+```bash
+composer global require "squizlabs/php_codesniffer=*"
+```
 Make sure you have the composer bin dir in your PATH. The default value is `~/.composer/vendor/bin/`, but you can check the value that you need to use by running `composer global config bin-dir --absolute`.
 
 Or alternatively, include a dependency for `squizlabs/php_codesniffer` in your `composer.json` file. For example:
@@ -49,47 +49,48 @@ Or alternatively, include a dependency for `squizlabs/php_codesniffer` in your `
 ```
 
 You will then be able to run PHP_CodeSniffer from the vendor bin directory:
-
-    ./vendor/bin/phpcs -h
-    ./vendor/bin/phpcbf -h
-
+```bash
+./vendor/bin/phpcs -h
+./vendor/bin/phpcbf -h
+```
 ### Phive
 If you use Phive, you can install PHP_CodeSniffer as a project tool using the following commands:
-
-    phive install phpcs
-    phive install phpcbf
-
+```bash
+phive install phpcs
+phive install phpcbf
+```
 You will then be able to run PHP_CodeSniffer from the tools directory:
-
-    ./tools/phpcs -h
-    ./tools/phpcbf -h
-
+```bash
+./tools/phpcs -h
+./tools/phpcbf -h
+```
 ### PEAR
 If you use PEAR, you can install PHP_CodeSniffer using the PEAR installer. This will make the `phpcs` and `phpcbf` commands immediately available for use. To install PHP_CodeSniffer using the PEAR installer, first ensure you have [installed PEAR](http://pear.php.net/manual/en/installation.getting.php) and then run the following command:
-
-    pear install PHP_CodeSniffer
-
+```bash
+pear install PHP_CodeSniffer
+```
 ### Git Clone
 You can also download the PHP_CodeSniffer source and run the `phpcs` and `phpcbf` commands directly from the Git clone:
-
-    git clone https://github.com/squizlabs/PHP_CodeSniffer.git
-    cd PHP_CodeSniffer
-    php bin/phpcs -h
-    php bin/phpcbf -h
-
+```bash
+git clone https://github.com/squizlabs/PHP_CodeSniffer.git
+cd PHP_CodeSniffer
+php bin/phpcs -h
+php bin/phpcbf -h
+```
 ## Getting Started
 
 The default coding standard used by PHP_CodeSniffer is the PEAR coding standard. To check a file against the PEAR coding standard, simply specify the file's location:
-
-    $ phpcs /path/to/code/myfile.php
-
+```bash
+phpcs /path/to/code/myfile.php
+```
 Or if you wish to check an entire directory you can specify the directory location instead of a file.
-
-    $ phpcs /path/to/code-directory
-
+```bash
+phpcs /path/to/code-directory
+```
 If you wish to check your code against the PSR-12 coding standard, use the `--standard` command line argument:
-
-    $ phpcs --standard=PSR12 /path/to/code-directory
+```bash
+phpcs --standard=PSR12 /path/to/code-directory
+```
 
 If PHP_CodeSniffer finds any coding standard errors, a report will be shown after running the command.
 

composer.json

@@ -4,7 +4,8 @@
     "type": "library",
     "keywords": [
         "phpcs",
-        "standards"
+        "standards",
+        "static analysis"
     ],
     "homepage": "https://github.com/squizlabs/PHP_CodeSniffer",
     "license": "BSD-3-Clause",