Allow manifest versions to be defined as SemVer strings (#274)

Blockception · Apr 3, 2024 · a571926 · a571926
1 parent 2449b73
commit a571926
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 32 deletions.
diff --git a/source/general/manifest/manifest.1.json b/source/general/manifest/manifest.1.json
@@ -28,9 +28,9 @@
           "title": "UUID"
         },
         "version": {
-          "$ref": "../Version.json",
+          "title": "Version",
           "description": "This is the version of your pack in the format [majorVersion, minorVersion, revision].",
-          "title": "Version"
+          "oneOf": [{ "$ref": "../Version.json" }, { "$ref": "../semver.json" }]
         },
         "min_engine_version": {
           "type": "string",
@@ -72,9 +72,9 @@
             "title": "UUID"
           },
           "version": {
-            "$ref": "../Version.json",
+            "title": "Version",
             "description": "This is the version of the module in the same format as the pack's version in the header. This can be used to further identify changes in your pack",
-            "title": "Version"
+            "oneOf": [{ "$ref": "../Version.json" }, { "$ref": "../semver.json" }]
           }
         }
       },
@@ -94,9 +94,9 @@
             "title": "UUID"
           },
           "version": {
-            "$ref": "../Version.json",
+            "title": "Version",
             "description": "This is the specific version of the pack that your pack depends on. Should match the version the other pack has in its manifest file",
-            "title": "Version"
+            "oneOf": [{ "$ref": "../Version.json" }, { "$ref": "../semver.json" }]
           }
         },
         "description": "UNDOCUMENTED: dependencies.",

diff --git a/source/general/manifest/manifest.2.json b/source/general/manifest/manifest.2.json
@@ -94,25 +94,11 @@
                 ]
               },
               "version": {
-                "type": "string",
-                "description": "This is the specific version of the module that your pack depends on.",
                 "title": "Version",
+                "description": "This is the specific version of the module that your pack depends on.",
+                "$ref": "../semver.json",
                 "default": "1.9.0",
-                "examples": [
-                  "1.10.0-beta",
-                  "1.10.0",
-                  "1.9.0",
-                  "1.8.0",
-                  "1.7.0",
-                  "1.6.0",
-                  "1.5.0",
-                  "1.4.0",
-                  "1.3.0",
-                  "1.2.0",
-                  "1.2.0-beta",
-                  "1.1.0",
-                  "1.0.0"
-                ]
+                "examples": ["1.10.0-beta", "1.10.0", "1.9.0", "1.8.0", "1.7.0", "1.6.0", "1.5.0", "1.4.0", "1.3.0", "1.2.0", "1.2.0-beta", "1.1.0", "1.0.0"]
               }
             }
           }
@@ -168,8 +154,8 @@
         },
         "version": {
           "title": "Version",
-          "$ref": "../Version.json",
-          "description": "This is the version of your pack in the format [majorVersion, minorVersion, revision]."
+          "description": "This is the version of your pack in the format [majorVersion, minorVersion, revision].",
+          "oneOf": [{ "$ref": "../Version.json" }, { "$ref": "../semver.json" }]
         }
       }
     },
@@ -207,9 +193,9 @@
             "title": "Uuid"
           },
           "version": {
-            "$ref": "../Version.json",
+            "title": "Version",
             "description": "This is the version of your pack in the format [majorVersion, minorVersion, revision]. The version number is used when importing a pack that has been imported before. The new pack will replace the old one if the version is higher, and ignored if it's the same or lower",
-            "title": "Version"
+            "oneOf": [{ "$ref": "../Version.json" }, { "$ref": "../semver.json" }]
           },
           "entry": {
             "type": "string",
@@ -237,19 +223,16 @@
           "type": "object",
           "propertyNames": {
             "pattern": "^[a-zA-Z0-9\\_\\-]+$",
-            "maxLength": 32,
-            "maximum": 32
+            "maxLength": 32
           },
           "additionalProperties": {
             "type": "array",
             "examples": [["1.0.0"]],
             "title": "Tool",
             "description": "The tool and the version used to modified this pack.",
             "items": {
-              "type": "string",
               "title": "Version",
-              "examples": ["1.0.0"],
-              "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"
+              "$ref": "../semver.json"
             }
           }
         },

diff --git a/source/general/semver.json b/source/general/semver.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "semver",
+  "title": "Semantic Version",
+  "description": "A semver.org compliant version number.",
+  "type": "string",
+  "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
+  "minLength": 5,
+  "maxLength": 256,
+  "examples": ["1.0.0", "1.1.0-beta"]
+}