Merge remote-tracking branch 'origin/8.3.x' into replace-namespace-qualify

Author: klausi

.cspell.json

@@ -0,0 +1,62 @@
+{
+    // Version of the setting file.  Always 0.2
+    "version": "0.2",
+    // language - current active spelling language
+    "language": "en-US",
+    "ignorePaths": [
+        "composer.*",
+        "tests",
+        "vendor"
+    ],
+    "dictionaries": [
+        "dictionary",
+        "drupal",
+        "companies",
+        "fonts",
+        "html",
+        "php",
+        "softwareTerms"
+    ],
+    // words - list of words to be always considered correct
+    "words": [
+        "addtogroup",
+        "autoloader",
+        "codesniffer",
+        "ColourDefinitionSniff",
+        "CURLOPT_SSL_VERIFYPEER",
+        "datestamp",
+        "defgroup",
+        "drush",
+        "endcode",
+        "endlink",
+        "heredocs",
+        "Kernighan",
+        "Komodo",
+        "multibyte",
+        "Netbeans",
+        "phpcbf",
+        "Ritchie",
+        "ruleset",
+        "sirbrillig",
+        "squizlabs",
+        "Squiz",
+        "startOfLine",
+        "Superglobal",
+        "T_ASPERAND",
+        "T_COLOUR",
+        "T_CONSTANT_ENCAPSED_STRING",
+        "T_DNUMBER",
+        "T_LNUMBER",
+        "T_NULLSAFE_OBJECT_OPERATOR",
+        "tableselect",
+        "ungreedy",
+        "unserialized",
+        "webform"
+    ],
+    // flagWords - list of words to be always considered incorrect
+    // This is useful for offensive words and common spelling errors.
+    // For example "hte" should be "the"
+    "flagWords": [
+        "hte"
+    ]
+}

.gitattributes

@@ -1,5 +1,5 @@
+/.cspell.json export-ignore
 /.gitattributes export-ignore
-/.travis.yml export-ignore
 /README.md export-ignore
 /phpcs.xml.dist export-ignore
 /phpunit.xml.dist export-ignore

.github/workflows/testing.yml

@@ -7,44 +7,48 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-versions: ['7.2', '7.3', '7.4', '8.0', '8.1']
-        phpstan: ['0']
-        # We only need to run PHPStan once on the latest PHP version.
+        php-versions: ['7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3']
+        extra-tests: ['0']
+        # We only need to run PHPStan and Drupal core regression tests once on
+        # the latest PHP version.
         include:
-          - php-versions: '8.2'
-            phpstan: '1'
+          - php-versions: '8.4'
+            extra-tests: '1'
     steps:
       - name: Checkout Coder
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
       - name: Setup PHP, with composer and extensions
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-versions }}
           extensions: mbstring
           # Disable Xdebug for better performance.
           coverage: none
+
       - name: Get composer cache directory
         id: composercache
         run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ steps.composercache.outputs.dir }}
           # Use composer.json for key, if composer.lock is not committed.
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
           restore-keys: ${{ runner.os }}-composer-
+
       - name: Install Composer dependencies
         # Running composer install without a lock file will also update cached
         # dependencies in vendor.
-        # Remove the PHPStan dependency from composer.json if it should not be
-        # run for this PHP version.
-        run: |
-          if [[ ${{ matrix.phpstan }} == "0" ]]; then sed -i "/phpstan/d" composer.json; fi
-          composer install --no-progress --prefer-dist --optimize-autoloader
+        run: composer install --no-progress --prefer-dist --optimize-autoloader
+
       - name: Run PHPUnit
         run: ./vendor/bin/phpunit
+
       - name: Run PHPCS
         run: ./vendor/bin/phpcs
+
       - name: Check custom standard autoloading
         # Ensure that a custom standard can be invoked and the auto-loading of
         # abstract classes works.
@@ -53,5 +57,31 @@ jobs:
         run: |
           ./vendor/bin/phpcs -p --standard=tests/Drupal/phpcs-ruleset.xml tests/Drupal/good/ --ignore=tests/Drupal/good/GoodUnitTest.php
           ./vendor/bin/phpcs -p --standard=coder_sniffer/DrupalPractice tests/DrupalPractice/good/ --ignore=tests/DrupalPractice/good/GoodUnitTest.php
+
       - name: Run PHPStan
-        run: if [[ ${{ matrix.phpstan }} == "1" ]]; then ./vendor/bin/phpstan analyse; fi
+        if: ${{ matrix.extra-tests == '1' }}
+        run: ./vendor/bin/phpstan analyse
+
+      - name: Run Cspell
+        if: ${{ matrix.extra-tests == '1' }}
+        uses: streetsidesoftware/cspell-action@v6
+        with:
+          incremental_files_only: false
+
+      - name: Checkout Drupal core
+        if: ${{ matrix.extra-tests == '1' }}
+        uses: actions/checkout@v3
+        with:
+          repository: drupal/drupal
+          ref: "11.x"
+          path: drupal
+
+      - name: Run PHPCS on Drupal core for regressions
+        if: ${{ matrix.extra-tests == '1' }}
+        # In case Drupal core files have known problems that should be
+        # ignored temporarily, add them with the --ignore option.
+        # @todo Remove ignore option once Coder 8.3.27 is released and Drupal
+        # core is updated to that version.
+        run: |
+          cd drupal/core
+          ../../vendor/bin/phpcs -p -s --ignore=lib/Drupal/Core/Entity/EntityType.php,lib/Drupal/Core/Recipe/RecipeInputFormTrait.php,lib/Drupal/Core/Form/FormState.php,modules/migrate/src/Plugin/Migration.php,modules/views/src/ViewExecutable.php,modules/views/src/Plugin/views/style/StylePluginBase.php

README.md

@@ -73,8 +73,8 @@ phpcs.xml.dist file in your project like this:
 
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
-<ruleset name="myproject">
-  <description>PHP CodeSniffer configuration for myproject development.</description>
+<ruleset name="example">
+  <description>PHP CodeSniffer configuration for example development.</description>
   <!-- Check all files in the current directory and below. -->
   <file>.</file>
   <arg name="extensions" value="php,module,inc,install,test,profile,theme,css,info,txt,md,yml"/>
@@ -139,7 +139,7 @@ Then execute the coding standards checker on Coder itself:
 
 Then execute static analysis:
 
-    ./vendor/bin/phpstan analyse
+    ./vendor/bin/phpstan
 
 
 ## Contributing
@@ -154,6 +154,8 @@ Thank you!
 
 ## Maintainers
 
+[//]: # cspell:ignore Pieter Frenssen Welford
+
 - Pieter Frenssen, https://www.drupal.org/u/pfrenssen
 - Michael Welford, https://www.drupal.org/u/mikejw
 - Klaus Purer, https://www.drupal.org/u/klausi

coder_sniffer/Drupal/Docs/Functions/FunctionCallArgumentSpacingStandard.xml

@@ -31,11 +31,13 @@ class ArraySniff implements Sniff
     /**
      * The limit that the length of a line should not exceed.
      *
-     * This can be configured to have a different value but the default is 80.
+     * This can be configured to have a different value but the default is 120.
+     * We don't enforce 80 characters by default because that can make array
+     * definitions in nested arrays or function calls less readable.
      *
      * @var integer
      */
-    public $lineLimit = 80;
+    public $lineLimit = 120;
 
 
     /**

coder_sniffer/Drupal/Docs/Functions/FunctionCallSignatureStandard.xml

@@ -98,7 +98,8 @@ public function process(File $phpcsFile, $stackPtr)
                 && in_array($tokens[($i - 1)]['code'], [T_WHITESPACE, T_COMMA]) === false
             ) {
                 $error = 'Selectors must be on a single line';
-                $fix   = $phpcsFile->addFixableError($error, $i, 'SeletorSingleLine');
+                // cspell:ignore SeletorSingleLine
+                $fix = $phpcsFile->addFixableError($error, $i, 'SeletorSingleLine');
                 if ($fix === true) {
                     $phpcsFile->fixer->replaceToken($i, str_replace($phpcsFile->eolChar, ' ', $tokens[$i]['content']));
                 }

coder_sniffer/Drupal/Docs/Functions/ValidDefaultValueStandard.xml

@@ -15,7 +15,7 @@
 /**
  * \Drupal\Sniffs\CSS\ColourDefinitionSniff.
  *
- * Ensure colours are defined in lower-case.
+ * Ensure colors are defined in lower-case.
  *
  * @category PHP
  * @package  PHP_CodeSniffer
@@ -56,14 +56,14 @@ public function register()
     public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
-        $colour = $tokens[$stackPtr]['content'];
+        $color  = $tokens[$stackPtr]['content'];
 
-        $expected = strtolower($colour);
-        if ($colour !== $expected) {
-            $error = 'CSS colours must be defined in lowercase; expected %s but found %s';
+        $expected = strtolower($color);
+        if ($color !== $expected) {
+            $error = 'CSS colors must be defined in lowercase; expected %s but found %s';
             $data  = [
                 $expected,
-                $colour,
+                $color,
             ];
             $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NotLower', $data);
             if ($fix === true) {