Create validate-yml.py

Author: GarlicRot

scripts/validate-yml.py

@@ -0,0 +1,115 @@
+import yaml
+import re
+import sys
+
+REQUIRED_FIELDS = {
+    'name': str,
+    'repo': str,
+    'description': str,
+    'creator': dict,
+    'latest_release_tag': str,
+    'screenshots': list,
+}
+
+REQUIRED_CREATOR_FIELDS = {
+    'name': str,
+    'url': str,
+    'avatar': str,
+}
+
+YOUTUBE_REGEX = re.compile(r'https://img\.youtube\.com/vi/([^/]+)/[^/]+\.jpg')
+REPO_REGEX = re.compile(r'^[\w\-]+/[\w\-\.]+$')
+
+def is_valid_screenshot_url(url: str) -> bool:
+    return url.startswith("https://") or url.startswith("./Assets/")
+
+def validate_entry(entry, is_plugin=True, index=0):
+    name = entry.get('name', f'<Unnamed {index}>')
+    errors = []
+
+    # Required fields
+    for field, field_type in REQUIRED_FIELDS.items():
+        if field not in entry:
+            errors.append(f"❌ Missing field `{field}` in entry '{name}'")
+        elif not isinstance(entry[field], field_type):
+            errors.append(f"❌ Field `{field}` in entry '{name}' must be {field_type.__name__}")
+
+    # Repo format
+    repo = entry.get('repo')
+    if repo and not REPO_REGEX.match(repo):
+        errors.append(f"❌ Invalid `repo` format in '{name}', must be 'owner/repo'")
+
+    # Creator block
+    creator = entry.get('creator', {})
+    if not isinstance(creator, dict):
+        errors.append(f"❌ `creator` must be a dictionary in entry '{name}'")
+    else:
+        for cfield, ctype in REQUIRED_CREATOR_FIELDS.items():
+            if cfield not in creator:
+                errors.append(f"❌ Missing `creator.{cfield}` in entry '{name}'")
+            elif not isinstance(creator[cfield], ctype):
+                errors.append(f"❌ `creator.{cfield}` in entry '{name}' must be {ctype.__name__}")
+            elif cfield in ['url', 'avatar'] and not creator[cfield].startswith("https://"):
+                errors.append(f"❌ `creator.{cfield}` URL must start with https:// in '{name}'")
+
+    # Screenshots
+    for ss in entry.get('screenshots', []):
+        if not isinstance(ss, dict):
+            errors.append(f"❌ Screenshot must be a dictionary in '{name}'")
+            continue
+        if 'url' not in ss or not isinstance(ss['url'], str):
+            errors.append(f"❌ Missing or invalid `url` in screenshot of '{name}'")
+        elif not is_valid_screenshot_url(ss['url']):
+            errors.append(f"❌ Screenshot URL must start with https:// or ./Assets/ in '{name}'")
+        elif ss['url'].startswith("https://img.youtube.com/") and not YOUTUBE_REGEX.match(ss['url']):
+            errors.append(f"❌ Invalid YouTube thumbnail format in screenshot of '{name}'")
+
+        if 'alt' in ss and not isinstance(ss['alt'], str):
+            errors.append(f"❌ `alt` must be a string in screenshot of '{name}'")
+
+        if 'width' in ss and not isinstance(ss['width'], int):
+            errors.append(f"❌ `width` must be an integer in screenshot of '{name}'")
+
+    # Plugin-only checks
+    if is_plugin:
+        if 'mc_versions' not in entry:
+            errors.append(f"❌ Missing `mc_versions` in plugin '{name}'")
+        elif not isinstance(entry['mc_versions'], str):
+            errors.append(f"❌ `mc_versions` must be a string in plugin '{name}'")
+
+        if 'is_core' in entry and not isinstance(entry['is_core'], bool):
+            errors.append(f"❌ `is_core` must be a boolean in plugin '{name}'")
+
+    return errors
+
+def main():
+    try:
+        with open('data/plugins-and-themes.yml', 'r') as f:
+            data = yaml.safe_load(f)
+    except Exception as e:
+        print(f"❌ Failed to load YAML: {e}")
+        sys.exit(1)
+
+    if not isinstance(data, dict):
+        print("❌ Top-level YAML must be a dictionary with 'plugins' and 'themes'")
+        sys.exit(1)
+
+    all_errors = []
+
+    for i, plugin in enumerate(data.get("plugins", [])):
+        all_errors.extend(validate_entry(plugin, is_plugin=True, index=i))
+
+    for i, theme in enumerate(data.get("themes", [])):
+        all_errors.extend(validate_entry(theme, is_plugin=False, index=i))
+
+    if all_errors:
+        print("\n--- VALIDATION ERRORS ---\n")
+        for err in all_errors:
+            print(err)
+        print(f"\n❌ {len(all_errors)} issue(s) found.")
+        sys.exit(1)
+    else:
+        print("✅ plugins-and-themes.yml validation passed with no issues.")
+
+if __name__ == "__main__":
+    main()