Add basic setup for JSON validation through schemas

Author: marvin-roesch

src/main/kotlin/com/demonwav/mcdev/json/providers.kt

@@ -0,0 +1,52 @@
+/*
+ * Minecraft Dev for IntelliJ
+ *
+ * https://minecraftdev.org
+ *
+ * Copyright (c) 2017 minecraft-dev
+ *
+ * MIT License
+ */
+
+package com.demonwav.mcdev.json
+
+import com.demonwav.mcdev.util.resourceDomain
+import com.demonwav.mcdev.util.resourcePath
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.vfs.VirtualFile
+import com.jetbrains.jsonSchema.extension.JsonSchemaFileProvider
+import com.jetbrains.jsonSchema.extension.JsonSchemaProviderFactory
+import com.jetbrains.jsonSchema.extension.SchemaType
+
+class SchemaProviderFactory : JsonSchemaProviderFactory {
+    override fun getProviders(project: Project) =
+        listOf(SoundsSchemaProvider(), BlockstatesSchemaProvider())
+}
+
+class SoundsSchemaProvider : JsonSchemaFileProvider {
+    companion object {
+        val FILE = JsonSchemaProviderFactory.getResourceFile(SchemaProviderFactory::class.java, "/jsonSchemas/sounds.schema.json")
+    }
+
+    override fun getName() = "Minecraft Sounds JSON"
+
+    override fun isAvailable(project: Project, file: VirtualFile) = file.resourceDomain != null && file.resourcePath == "sounds.json"
+
+    override fun getSchemaType(): SchemaType = SchemaType.embeddedSchema
+
+    override fun getSchemaFile(): VirtualFile = FILE
+}
+
+class BlockstatesSchemaProvider : JsonSchemaFileProvider {
+    companion object {
+        val FILE = JsonSchemaProviderFactory.getResourceFile(SchemaProviderFactory::class.java, "/jsonSchemas/blockstates.schema.json")
+    }
+
+    override fun getName() = "Minecraft Blockstates JSON"
+
+    override fun isAvailable(project: Project, file: VirtualFile) = file.resourceDomain != null && file.resourcePath?.startsWith("blockstates/") == true
+
+    override fun getSchemaType(): SchemaType = SchemaType.embeddedSchema
+
+    override fun getSchemaFile(): VirtualFile = FILE
+}

src/main/kotlin/com/demonwav/mcdev/util/files.kt

@@ -30,3 +30,11 @@ val VirtualFile.manifest: Manifest?
 
 operator fun Manifest.get(attribute: String): String? = mainAttributes.getValue(attribute)
 operator fun Manifest.get(attribute: Attributes.Name): String? = mainAttributes.getValue(attribute)
+
+private val DOMAIN_PATTERN = Regex("^.*?/assets/(.*?)/(.*?)\$")
+
+val VirtualFile.resourceDomain: String?
+    get() = DOMAIN_PATTERN.matchEntire(this.path)?.groupValues?.get(1)
+
+val VirtualFile.resourcePath: String?
+    get() = DOMAIN_PATTERN.matchEntire(this.path)?.groupValues?.get(2)

src/main/resources/META-INF/plugin.xml

@@ -629,6 +629,10 @@
         <projectResolve implementation="com.demonwav.mcdev.platform.forge.gradle.ForgePatcherProjectResolverExtension"/>
     </extensions>
 
+    <extensions defaultExtensionNs="JavaScript.JsonSchema">
+        <ProviderFactory implementation="com.demonwav.mcdev.json.SchemaProviderFactory"/>
+    </extensions>
+
     <application-components>
     </application-components>
 

src/main/resources/jsonSchemas/blockstates.schema.json

@@ -0,0 +1,70 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "Minecraft Blockstates JSON",
+    "definitions": {
+        "variantDefinition": {
+            "type": "object",
+            "additionalProperties": {
+                "oneOf": [
+                    {
+                        "type": "object",
+                        "additionalProperties": { "$ref": "#/definitions/variantObject" }
+                    },
+                    {
+                        "type": "array",
+                        "items": { "$ref": "#/definitions/variantObject" }
+                    }
+                ]
+            }
+        },
+        "variantObject": {
+            "type": "object",
+            "properties": {
+                "__comment": {
+                    "type": "string"
+                },
+                "model": { "type": "string" },
+                "textures": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string"
+                    }
+                }
+            },
+            "additionalProperties": false
+        }
+    },
+    "oneOf": [
+        {
+            "type": "object",
+            "properties": {
+                "__comment": {
+                    "type": "string"
+                },
+                "variants": {
+                    "type": "object",
+                    "additionalProperties": { "$ref": "#/definitions/variantObject" }
+                }
+            },
+            "additionalProperties": false,
+            "required": [ "variants" ],
+            "not": { "required": [ "forge_marker" ] }
+        },
+        {
+            "type": "object",
+            "properties": {
+                "__comment": {
+                    "type": "string"
+                },
+                "forge_marker": {
+                    "type": "integer",
+                    "enum": [ 1 ]
+                },
+                "variants": { "$ref": "#/definitions/variantDefinition" },
+                "defaults": { "$ref": "#/definitions/variantObject" }
+            },
+            "additionalProperties": false,
+            "required": [ "forge_marker", "variants" ]
+        }
+    ]
+}

src/main/resources/jsonSchemas/sounds.schema.json

@@ -0,0 +1,60 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Minecraft Sounds JSON",
+  "type": "object",
+  "additionalProperties": {
+    "type": "object",
+    "properties": {
+      "category": {
+        "type": "string"
+      },
+      "replace": {
+        "type": "boolean"
+      },
+      "subtitle": {
+        "type": "string"
+      },
+      "sounds": {
+        "type": "array",
+        "items": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "volume": {
+                  "type": "number",
+                  "minimum": 0,
+                  "maximum": 1,
+                  "default": 1
+                },
+                "pitch": {
+                  "type": "number",
+                  "default": 1
+                },
+                "weight": {
+                  "type": "number",
+                  "default": 1
+                },
+                "stream": {
+                  "type": "boolean",
+                  "default": false
+                },
+                "type": {
+                  "enum": [ "sound", "event" ],
+                  "default": "sound"
+                }
+              }
+            }
+          ]
+        },
+        "uniqueItems": true
+      }
+    }
+  }
+}