style(cspell): Fix cspell spelling and enable cspell testing (#3418190)

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

@@ -62,6 +62,12 @@ jobs:
         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

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

@@ -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/FunctionCallSignatureStandard.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) {

coder_sniffer/Drupal/Docs/Functions/ValidDefaultValueStandard.xml

@@ -82,10 +82,10 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         $previous        = $phpcsFile->findPrevious(T_WHITESPACE, ($openingBrace - 1), null, true);
-        $decalrationLine = $tokens[$previous]['line'];
+        $declarationLine = $tokens[$previous]['line'];
         $braceLine       = $tokens[$openingBrace]['line'];
 
-        $lineDifference = ($braceLine - $decalrationLine);
+        $lineDifference = ($braceLine - $declarationLine);
 
         if ($lineDifference > 0) {
             $error = 'Opening brace should be on the same line as the declaration';