Adds spelling mistakes check

raphaelstolt · Feb 4, 2025 · cfabaf3 · cfabaf3
1 parent ac217a4
commit cfabaf3
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 1 deletion.
diff --git a/.gitattributes b/.gitattributes
@@ -16,6 +16,7 @@ CHANGELOG.md export-ignore
 example/ export-ignore
 LICENSE.md export-ignore
 lpv-logo.png export-ignore
+peck.json export-ignore
 phpstan.neon.dist export-ignore
 phpunit.xml.dist export-ignore
 README.md export-ignore

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -30,3 +30,6 @@ jobs:
 
             -   name: Check leanness of package
                 run: composer run-script lpv:validate-gitattributes
+
+            -   name: Check for spelling mistakes of package
+                run: sudo apt-get install aspell aspell-en && composer run-script lpv:spell-check
diff --git a/composer.json b/composer.json
@@ -49,11 +49,13 @@
         "lpv:application-phar-version-guard": "php bin/application-version --verify-tag-match=phar",
         "lpv:static-analyse": "phpstan analyse --configuration phpstan.neon.dist",
         "lpv:validate-gitattributes": "bin/lean-package-validator validate",
+        "lpv:spell-check": "./vendor/bin/peck",
         "lpv:pre-commit-check": [
             "@lpv:test",
             "@lpv:cs-lint",
             "@lpv:static-analyse",
-            "@lpv:application-version-guard"
+            "@lpv:application-version-guard",
+            "@lpv:spell-check"
         ]
     },
     "config": {
@@ -64,6 +66,7 @@
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.0",
         "mockery/mockery": "^1.0",
+        "peckphp/peck": "^0.1.2",
         "phlak/semver": "^4.1 || ^6.0",
         "php-mock/php-mock-phpunit": "^2.7||^1.1",
         "phpstan/phpstan": "^2.0",

diff --git a/peck.json b/peck.json
@@ -0,0 +1,32 @@
+{
+    "preset": "base",
+    "ignore": {
+        "words": [
+            "php",
+            "gitattributes",
+            "analyser",
+            "analyse",
+            "windowsish",
+            "lpv",
+            "readme",
+            "pathnames",
+            "gitignore",
+            "eol",
+            "nosort",
+            "nocheck",
+            "onlydir",
+            "noescape",
+            "errline",
+            "errfile",
+            "errno",
+            "initialise",
+            "errstr",
+            "delegator",
+            "gitignored",
+            "str",
+            "postfix",
+            "autoconfiguration"
+        ],
+        "paths": []
+    }
+}