Merge pull request #33

Add JSON schema for configuration validation and include schema references in relevant files

Author: andrey-helldar

.github/preview-updater.yml

@@ -1,6 +1,7 @@
-# yaml-language-server: $schema=https://raw.githubusercontent.com/TheDragonCode/preview-updater/refs/heads/main/resources/schema.json
+# $schema: ../resources/schema.json
 
 image:
     parameters:
-        packageManager: 'none'
         icon: 'photograph'
+        packageManager: 'GitHub Actions uses:'
+        packageName: 'TheDragonCode/preview-updater@v1'

README.md

@@ -71,7 +71,7 @@ Create `.github/preview-updater.yml` (or provide your own path via `configPath`)
 All fields are optional—omitted ones fall back to defaults.
 
 ```yaml
-# yaml-language-server: $schema=https://raw.githubusercontent.com/TheDragonCode/preview-updater/refs/heads/main/resources/schema.json
+# $schema: https://raw.githubusercontent.com/TheDragonCode/preview-updater/refs/heads/main/resources/schema.json
 
 path:
     readme: README.md        # Target file to update

resources/schema.json

@@ -49,7 +49,13 @@
                             "anyOf": [
                                 {
                                     "type": "string",
-                                    "enum": ["composer", "npm", "yarn", "auto", "none"]
+                                    "enum": [
+                                        "composer",
+                                        "npm",
+                                        "yarn",
+                                        "auto",
+                                        "none"
+                                    ]
                                 },
                                 {
                                     "type": "string"

tests/unit/filesystem.test.ts

@@ -8,9 +8,6 @@ test("read config", () => {
 
     expect(data.directory).toBe(process.cwd());
 
-    expect(data.image.parameters.packageName).toBe(
-        "TheDragonCode/preview-updater",
-    );
     expect(data.image.parameters.title).toBe("Preview Updater");
     expect(data.image.parameters.description).toBe(
         "Lightweight preview update in your repository",
@@ -22,7 +19,10 @@ test("read config", () => {
         defaultConfig.image.parameters.pattern,
     );
 
-    expect(data.image.parameters.packageManager).toBe("none");
+    expect(data.image.parameters.packageManager).toBe("GitHub Actions uses:");
+    expect(data.image.parameters.packageName).toBe(
+        "TheDragonCode/preview-updater",
+    );
     expect(data.image.parameters.icon).toBe("photograph");
 });