Merge pull request #479 from CPS-IT/task/linting

[TASK] Add linting scripts for configuration schema

.github/workflows/cgl.yaml

@@ -46,6 +46,8 @@ jobs:
         run: composer lint:composer
       - name: Lint Editorconfig
         run: composer lint:editorconfig
+      - name: Lint JSON
+        run: composer lint:json
       - name: Lint PHP
         run: composer lint:php -- --format=checkstyle | cs2pr
 
@@ -56,3 +58,7 @@ jobs:
       # Migration
       - name: Rector migration
         run: composer migration:rector -- --dry-run
+
+      # Schema
+      - name: Validate configuration schema
+        run: composer validate-schema

CONTRIBUTING.md

@@ -29,6 +29,7 @@ composer lint
 # Specific linters
 composer lint:composer
 composer lint:editorconfig
+composer lint:json
 composer lint:php
 
 # Fix all CGL issues
@@ -37,6 +38,7 @@ composer fix
 # Fix specific CGL issues
 composer fix:composer
 composer fix:editorconfig
+composer fix:json
 composer fix:php
 ```
 
@@ -50,6 +52,14 @@ composer sca
 composer sca:php
 ```
 
+## Validate configuration schema
+
+```bash
+composer validate-schema
+```
+
+💡 You need a local Docker installation for this command.
+
 ## Run tests
 
 ```bash

composer.json

@@ -50,7 +50,8 @@
 		"phpstan/phpstan-symfony": "^1.1",
 		"phpstan/phpstan-webmozart-assert": "^1.2",
 		"phpunit/phpunit": "^10.1 || ^11.0",
-		"rector/rector": "^1.0.0"
+		"rector/rector": "^1.0.0",
+		"seld/jsonlint": "^1.10"
 	},
 	"suggest": {
 		"gmostafa/php-graphql-client": "Used to perform GraphQL requests within GithubVcsProvider (^1.13)"
@@ -79,18 +80,22 @@
 		"fix": [
 			"@fix:composer",
 			"@fix:editorconfig",
+			"@fix:json",
 			"@fix:php"
 		],
 		"fix:composer": "@composer normalize",
 		"fix:editorconfig": "@lint:editorconfig --fix",
+		"fix:json": "@lint:json",
 		"fix:php": "php-cs-fixer fix",
 		"lint": [
 			"@lint:composer",
 			"@lint:editorconfig",
+			"@lint:json",
 			"@lint:php"
 		],
 		"lint:composer": "@fix:composer --dry-run",
 		"lint:editorconfig": "ec",
+		"lint:json": "jsonlint resources/configuration.schema.json",
 		"lint:php": "@fix:php --dry-run",
 		"migration": [
 			"@migration:rector"
@@ -104,6 +109,7 @@
 			"phpstan analyse -c phpstan.neon"
 		],
 		"test": "@test:coverage --no-coverage",
-		"test:coverage": "phpunit -c phpunit.xml"
+		"test:coverage": "phpunit -c phpunit.xml",
+		"validate-schema": "docker run --rm -v \"$(pwd)\":/code swaggest/json-cli json-cli validate-schema resources/configuration.schema.json"
 	}
 }