feat: add yaml support

Author: miparnisari

package.json

@@ -28,6 +28,18 @@
           "cel"
         ]
       },
+      {
+        "id": "spicedb-yaml",
+        "aliases": [
+          "SpiceDB YAML"
+        ],
+        "extensions": [
+          ".zed.yaml"
+        ],
+        "filenamePatterns": [
+          "*.zed.yaml"
+        ]
+      },
       {
         "id": "spicedb",
         "aliases": [
@@ -52,6 +64,24 @@
         "scopeName": "source.cel",
         "path": "./syntaxes/cel.tmGrammar.json"
       },
+      {
+        "language": "spicedb-yaml",
+        "scopeName": "source.spicedb-yaml",
+        "path": "./syntaxes/spicedb-yaml.tmGrammar.json",
+        "embeddedLanguages": {
+          "meta.embedded.block.spicedb": "spicedb"
+        }
+      },
+      {
+        "scopeName": "spicedb-yaml.injection",
+        "path": "./syntaxes/spicedb-yaml-injection.tmGrammar.json",
+        "injectTo": [
+          "source.spicedb-yaml"
+        ],
+        "embeddedLanguages": {
+          "meta.embedded.block.spicedb": "spicedb"
+        }
+      },
       {
         "language": "spicedb",
         "scopeName": "source.spicedb",
@@ -104,9 +134,16 @@
           "when": "view == spicedb.checkWatchView"
         }
       ]
+    },
+    "configurationDefaults": {
+      "files.associations": {
+        "*.zed.yaml": "spicedb-yaml"
+      }
     }
   },
-  "activationEvents": [],
+  "activationEvents": [
+    "onStartupFinished"
+  ],
   "main": "./out/extension.js",
   "scripts": {
     "vscode:build": "vsce package -o spicedb.vsix --no-yarn",

src/extension.ts

@@ -6,9 +6,19 @@ import { type ResolvedReference, Resolver, parse } from '@authzed/spicedb-parser
 import { getInstallCommand, languageServerBinaryPath } from './binary';
 import { CheckWatchProvider } from './checkwatchprovider';
 
+function reassignZedYamlLanguage(doc: vscode.TextDocument) {
+  if (doc.fileName.endsWith('.zed.yaml') && doc.languageId !== 'spicedb-yaml') {
+    vscode.languages.setTextDocumentLanguage(doc, 'spicedb-yaml');
+  }
+}
+
 export function activate(context: vscode.ExtensionContext) {
   console.log('spicedb-vscode is now active');
 
+  // Reassign language for any already-open .zed.yaml files detected as plain yaml
+  vscode.workspace.textDocuments.forEach(reassignZedYamlLanguage);
+  context.subscriptions.push(vscode.workspace.onDidOpenTextDocument(reassignZedYamlLanguage));
+
   const checkWatchProvider = new CheckWatchProvider(context.extensionUri);
 
   context.subscriptions.push(vscode.window.registerWebviewViewProvider(CheckWatchProvider.viewType, checkWatchProvider));
@@ -197,9 +207,12 @@ async function startLanguageServer(context: vscode.ExtensionContext) {
   };
 
   const clientOptions: LanguageClientOptions = {
-    documentSelector: [{ scheme: 'file', language: 'spicedb' }],
+    documentSelector: [
+      { scheme: 'file', language: 'spicedb' },
+      { scheme: 'file', language: 'spicedb-yaml' },
+    ],
     synchronize: {
-      fileEvents: vscode.workspace.createFileSystemWatcher('**/.zed'),
+      fileEvents: vscode.workspace.createFileSystemWatcher('**/*.zed{,.yaml}'),
     },
   };
 

syntaxes/spicedb-yaml-injection.tmGrammar.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json",
+  "scopeName": "spicedb-yaml.injection",
+  "injectionSelector": "L:source.spicedb-yaml",
+  "patterns": [{ "include": "#schema-block" }],
+  "repository": {
+    "schema-block": {
+      "begin": "(['\"]?schema['\"]?)(:\\s*)([|>][-+0-9]*)\\s*$",
+      "beginCaptures": {
+        "1": { "name": "entity.name.tag.yaml" },
+        "2": { "name": "punctuation.separator.key-value.mapping.yaml" },
+        "3": { "name": "keyword.control.flow.block-scalar.literal.yaml" }
+      },
+      "while": "^(\\s|$)",
+      "contentName": "meta.embedded.block.spicedb",
+      "patterns": [{ "include": "source.spicedb" }]
+    }
+  }
+}

syntaxes/spicedb-yaml.tmGrammar.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json",
+  "name": "SpiceDB YAML",
+  "scopeName": "source.spicedb-yaml",
+  "patterns": [{ "include": "source.yaml" }]
+}

syntaxes/test/full-standard.zed.yaml

@@ -0,0 +1,14 @@
+---
+schema: |-
+  definition user {}
+  definition doc {
+    relation vieww: user
+    relation blah: user
+    }
+
+assertions:
+  assertTrue:
+    - 'doc:1#admin@user:maria'
+
+relationships: |-
+  doc:1#vieww@user:maria

syntaxes/test/withSchemaFile.zed.yaml

@@ -0,0 +1,2 @@
+---
+schemaFile: 'imported.zed'