Formalise installing spectral/redocly and running them against example/scratch specs (zircote#1722)

Author: DerManoMann

.gitignore

@@ -8,6 +8,8 @@ docs/.vitepress/cache/
 docs/.vitepress/dist/
 docs/node_modules/
 docs/package-lock.json
+node_modules/
+package-lock.json
 scratch/
 vendor/
 .idea/

composer.json

@@ -88,9 +88,12 @@
         "lint": "Test codestyle",
         "test": "Run all PHP, codestyle and rector tests",
         "analyse": "Run static analysis (phpstan/psalm)",
-        "spectral-examples": "Run spectral lint over all .yaml files in the Examples folder",
+        "spectral-examples": "Run spectral lint over all .yaml files in the docs/examples folder",
         "spectral-scratch": "Run spectral lint over all .yaml files in the tests/Fixtures/Scratch folder",
         "spectral": "Run all spectral tests",
+        "redocly-examples": "Run redocly lint over all .yaml files in the docs/examples folder",
+        "redocly-scratch": "Run redocly lint over all .yaml files in the tests/Fixtures/Scratch folder",
+        "redocly": "Run all redocly tests",
         "docs:gen": "Rebuild reference documentation",
         "docs:dev": "Run dev server for local development of gh-pages",
         "docs:build": "Re-build static gh-pages"
@@ -110,12 +113,18 @@
             "export XDEBUG_MODE=off && phpstan analyse --memory-limit=2G",
             "export XDEBUG_MODE=off && psalm --threads=1"
         ],
-        "spectral-examples": "for ff in `find Examples -name '*.yaml'`; do spectral lint $ff; done",
-        "spectral-scratch": "for ff in `find tests/Fixtures/Scratch -name '*.yaml'`; do spectral lint $ff; done",
+        "spectral-examples": "for ff in `find docs/examples -name '*.yaml'`; do npm run spectral lint $ff; done",
+        "spectral-scratch": "for ff in `find tests/Fixtures/Scratch -name '*.yaml'`; do npm run spectral lint $ff; done",
         "spectral": [
             "@spectral-examples",
             "@spectral-scratch"
         ],
+        "redocly-examples": "for ff in `find docs/examples -name '*.yaml'`; do npm run redocly lint $ff; done",
+        "redocly-scratch": "for ff in `find tests/Fixtures/Scratch -name '*.yaml'`; do npm run redocly lint $ff; done",
+        "redocly": [
+            "@redocly-examples",
+            "@redocly-scratch"
+        ],
         "docs:gen": [
             "@php tools/refgen.php",
             "@php tools/procgen.php",

package.json

@@ -0,0 +1,13 @@
+{
+  "name": "swagger-php-tools",
+  "version": "1.0.0",
+  "license": "Apache-2.0",
+  "scripts": {
+    "spectral": "spectral",
+    "redocly": "redocly"
+  },
+  "devDependencies": {
+    "@stoplight/spectral-cli": "^6",
+    "@redocly/cli": "^1.30"
+  }
+}