JSON schema for zowe.yaml

Signed-off-by: Leonty Chudinov <[email protected]>
zowe · Jan 31, 2022 · 526c4eb · 526c4eb
1 parent 8399a30
commit 526c4eb
Show file tree

Hide file tree

Showing 5 changed files with 197 additions and 3 deletions.
diff --git a/webClient/package-lock.json b/webClient/package-lock.json
diff --git a/webClient/package.json b/webClient/package.json
@@ -47,6 +47,7 @@
     "html-loader": "~0.5.5",
     "monaco-editor": "^0.20.0",
     "monaco-editor-webpack-plugin": "^1.9.0",
+    "monaco-yaml": "~3.2.1",
     "rxjs": "~6.6.0",
     "sass": "~1.26.0",
     "sass-loader": "~8.0.0",

diff --git a/webClient/src/app/editor/code-editor/monaco/monaco.service.ts b/webClient/src/app/editor/code-editor/monaco/monaco.service.ts
@@ -41,6 +41,7 @@ export class MonacoService implements OnDestroy {
 
   constructor(
     @Inject(Angular2InjectionTokens.LOGGER) private log: ZLUX.ComponentLogger,
+    @Inject(Angular2InjectionTokens.PLUGIN_DEFINITION) private pluginDefinition: ZLUX.ContainerPluginDefinition,
     private http: HttpService,
     private dataAdapter: DataAdapterService,
     private editorControl: EditorControlService,
@@ -79,6 +80,7 @@ export class MonacoService implements OnDestroy {
     }
     document.addEventListener("keydown", this.fileSaveListener);
 
+    this.initJsonSchemas();
 
     //this.editorControl.saveAllFile.subscribe(() => {
       //this.saveAllFile();
@@ -492,6 +494,23 @@ export class MonacoService implements OnDestroy {
   cleanDecoration() {
     this.editorControl.editor.getValue().deltaDecorations(this.decorations, []);
   }
+
+  initJsonSchemas(): void {
+    const uri = ZoweZLUX.uriBroker.pluginResourceUri(this.pluginDefinition.getBasePlugin(), 'assets/schemas/zowe-schema.json');
+    (monaco.languages as any).yaml.yamlDefaults.setDiagnosticsOptions({
+      hover: true,
+      completion: true,
+      validate: true,
+      format: true,
+      enableSchemaRequest: true,
+      schemas: [
+        {
+          fileMatch: ['inmemory://**zowe.yaml/**'],
+          uri: uri
+        },
+      ],
+    });
+  } 
 }
 
 /*

diff --git a/webClient/src/app/zowe-schema.json b/webClient/src/app/zowe-schema.json
@@ -0,0 +1,74 @@
+{
+  "name": "zowe_yaml_schema",
+  "$id": "http//zowe.org/schemas/yaml-2.0.json",
+  "type": "object",
+  "required": [
+    "zowe",
+    "externalPort"
+  ],
+  "properties": {
+    "zowe": {
+      "properties": {
+        "setup": {
+          "type": "object",
+          "properties": {
+            "mvs": {
+              "type": "object",
+              "description": "MVS data set related configurations",
+              "properties": {
+                "proclib": {
+                  "$ref": "#/$defs/dataset"
+                },
+                "parmlib": {
+                  "$ref": "#/$defs/dataset"
+                },
+                "hlq": {
+                  "description": "where Zowe MVS data sets will be installed",
+                  "$ref": "#/$defs/dataset"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "job": {
+      "type": "object",
+      "required": [
+        "name",
+        "prefix"
+      ],
+      "properties": {
+        "name": {
+          "$ref": "#/$defs/jobname"
+        },
+        "prefix": {
+          "type": "string"
+        }
+      }
+    },
+    "externalPort": {
+      "type": "integer"
+    },
+    "logDirectory": {
+      "type": "string"
+    }
+  },
+  "$defs": {
+    "dataset": {
+      "type": "string",
+      "minLength": 3,
+      "maxLength": 44
+    },
+    "jobname": {
+      "type": "string",
+      "minLength": 3,
+      "maxLength": 8
+    },
+    "tcpPort": {
+      "type": "integer",
+      "minimum": 1024,
+      "maximum": 65535
+    }
+  }
+}
diff --git a/webClient/webpack.build.config.js b/webClient/webpack.build.config.js
@@ -83,7 +83,19 @@ var config = {
       threshold: 50000,
       minRatio: 0.8
     })
-    , new MonacoWebpackPlugin({publicPath: pubPath})
+    , new MonacoWebpackPlugin({
+      publicPath: pubPath,
+      customLanguages: [
+        {
+          label: 'yaml',
+          entry: ['monaco-yaml', 'vs/basic-languages/yaml/yaml.contribution'],
+          worker: {
+            id: 'monaco-yaml/yamlWorker',
+            entry: 'monaco-yaml/lib/esm/yaml.worker',
+          },
+        },
+      ],
+    })
   ]
 };