Beheer: verplaats linter configuratie

Hiermee bereiken we twee doelen:
1. De naamgeving is niet gelimiteerd aan Spectral, omdat ook andere
tooling deze configuratie kan gebruiken
2. Omdat het nu in `media/` staat, publiceren we deze configuratie
nu ook op een aparte plek. Hierdoor is het mogelijk om voor andere
tooling om automatisch het bestand te pakken, in plaats van die
uit een bijlage van het standaarddocument te halen

Uiteindelijk zorgen we ervoor dat tooling zoals developer.overheid.nl
nu naar deze configuratie kunnen verwijzen en ook automatisch
up-to-date zijn met wijzigingen die we aanbrengen.

Author: TimvdLippe

examples/run-spectral-linter.sh

@@ -7,4 +7,4 @@ if ! [ -f "$1" ]; then
   exit 1
 fi
 
-spectral lint -r $CURRENT_DIRECTORY/../linter/spectral.yml $1
+spectral lint -r $CURRENT_DIRECTORY/../media/linter.yml $1

js/config.mjs

@@ -24,7 +24,7 @@ async function initializeHighlightJSYaml() {
 
 let spectralConfiguration;
 async function fetchSpectralConfiguration() {
-  const spectralResponse = await fetch('linter/spectral.yml');
+  const spectralResponse = await fetch('media/linter.yml');
   spectralConfiguration = await spectralResponse.text();
 }
 

linter/run-linter-tests.mjs

@@ -11,7 +11,7 @@ const readFile = utils.promisify(fs.readFile);
 const readdir = utils.promisify(fs.readdir);
 const writeFile = utils.promisify(fs.writeFile);
 
-const SPECTRAL_RULESET_LOCATION = path.join(__dirname, 'spectral.yml');
+const SPECTRAL_RULESET_LOCATION = path.join(__dirname, '..', 'media', 'linter.yml');
 
 function computeTestCommand(apiLocation) {
     return `spectral lint -r ${SPECTRAL_RULESET_LOCATION} ${apiLocation}/openapi.json || true`

linter/spectral.yml media/linter.ymllinter/spectral.yml renamed to media/linter.yml

@@ -13,8 +13,8 @@
 #
 # ```
 # npm install -g @stoplight/spectral-cli
-# curl -L https://static.developer.overheid.nl/adr/ruleset.yaml > .spectral.yml
-# spectral lint -r .spectral.yml $OAS_URL_OR_FILE
+# curl -L https://static.developer.overheid.nl/adr/ruleset.yaml > .linter.yml
+# spectral lint -r .linter.yml $OAS_URL_OR_FILE
 # ```
 
 extends: spectral:oas