@surrealdb/codemirror 1.0.0-beta.2 → 1.0.0-beta.20

package/dist/index.cjs

@@ -1,13 +1,15 @@
 'use strict';
 
 var language = require('@codemirror/language');
-var lezerSurrealql = require('lezer-surrealql');
+var lint = require('@codemirror/lint');
 var common = require('@lezer/common');
 var javascript = require('@lezer/javascript');
+var lezer = require('@surrealdb/lezer');
+var compareVersions = require('compare-versions');
 
 const surrealqlLanguage = language.LRLanguage.define({
     name: "surrealql",
-    parser: lezerSurrealql.parser.configure({
+    parser: lezer.parser.configure({
         props: [
             language.indentNodeProp.add({
                 Object: language.continuedIndent({ except: /^\s*}/ }),
@@ -24,24 +26,70 @@ const surrealqlLanguage = language.LRLanguage.define({
     languageData: {
         closeBrackets: { brackets: ["[", "{", '"', "'", "("] },
         indentOnInput: /^\s*[\]}]$/,
-        commentTokens: { line: "--" },
+        commentTokens: { line: "--", block: { open: "/*", close: "*/" } },
     },
 });
-const languageMap = new Map([
-    ["default", surrealqlLanguage.configure({ top: "SurrealQL" })],
-    ["permission", surrealqlLanguage.configure({ top: "PermissionInput" })],
-    ["combined-results", surrealqlLanguage.configure({ top: "CombinedResults" })],
+const scopeMap = new Map([
+    ["permission", "PermissionInput"],
+    ["index", "IndexInput"],
+    ["combined-results", "CombinedResults"],
+    ["syntax", "Syntax"],
 ]);
+/**
+ * A linter that checks if the syntax tree uses features that are not available in the given SurrealDB version
+ *
+ * @param version The SurrealDB version to check against (e.g. "2.0.0")
+ */
+function surrealqlVersionLinter(version) {
+    if (!compareVersions.validate(version)) {
+        throw new Error(`Invalid SurrealDB version: ${version}`);
+    }
+    return lint.linter((view) => {
+        const diagnostics = [];
+        language.syntaxTree(view.state)
+            .cursor()
+            .iterate((node) => {
+            if (node.from === node.to) {
+                return;
+            }
+            const sinceVersionProp = node.type.prop(lezer.sinceProp);
+            const untilVersionProp = node.type.prop(lezer.untilProp);
+            if (sinceVersionProp && compareVersions.compareVersions(version, sinceVersionProp) < 0) {
+                diagnostics.push({
+                    from: node.from,
+                    to: node.to,
+                    severity: "error",
+                    message: `This syntax is only available on SurrealDB ${sinceVersionProp} and up`,
+                });
+            }
+            if (untilVersionProp && compareVersions.compareVersions(version, untilVersionProp) >= 0) {
+                diagnostics.push({
+                    from: node.from,
+                    to: node.to,
+                    severity: "error",
+                    message: `This syntax is only available until SurrealDB ${untilVersionProp}`,
+                });
+            }
+        });
+        return diagnostics;
+    });
+}
 /**
  * The CodeMirror extension used to add support for the SurrealQL language
+ *
+ * @param scope Limit the scope of the highlighting
  */
-function surrealql(scope = "default") {
-    const language$1 = languageMap.get(scope);
-    if (!language$1) {
+function surrealql(scope) {
+    if (!scope) {
+        return new language.LanguageSupport(surrealqlLanguage);
+    }
+    const scopeId = scopeMap.get(scope);
+    if (!scopeId) {
         throw new Error(`Unknown language scope: ${scope}`);
     }
-    return new language.LanguageSupport(language$1);
+    return new language.LanguageSupport(surrealqlLanguage.configure({ top: scopeId }));
 }
 
 exports.surrealql = surrealql;
 exports.surrealqlLanguage = surrealqlLanguage;
+exports.surrealqlVersionLinter = surrealqlVersionLinter;

package/dist/index.d.cts

@@ -1,10 +1,19 @@
 import { LRLanguage, LanguageSupport } from '@codemirror/language';
+import { Extension } from '@codemirror/state';
 
 declare const surrealqlLanguage: LRLanguage;
-type Scope = "default" | "permission" | "combined-results";
+type Scope = "permission" | "index" | "combined-results" | "syntax";
+/**
+ * A linter that checks if the syntax tree uses features that are not available in the given SurrealDB version
+ *
+ * @param version The SurrealDB version to check against (e.g. "2.0.0")
+ */
+declare function surrealqlVersionLinter(version: string): Extension;
 /**
  * The CodeMirror extension used to add support for the SurrealQL language
+ *
+ * @param scope Limit the scope of the highlighting
  */
 declare function surrealql(scope?: Scope): LanguageSupport;
 
-export { surrealql, surrealqlLanguage };
+export { surrealql, surrealqlLanguage, surrealqlVersionLinter };

package/dist/index.d.ts

@@ -1,10 +1,19 @@
 import { LRLanguage, LanguageSupport } from '@codemirror/language';
+import { Extension } from '@codemirror/state';
 
 declare const surrealqlLanguage: LRLanguage;
-type Scope = "default" | "permission" | "combined-results";
+type Scope = "permission" | "index" | "combined-results" | "syntax";
+/**
+ * A linter that checks if the syntax tree uses features that are not available in the given SurrealDB version
+ *
+ * @param version The SurrealDB version to check against (e.g. "2.0.0")
+ */
+declare function surrealqlVersionLinter(version: string): Extension;
 /**
  * The CodeMirror extension used to add support for the SurrealQL language
+ *
+ * @param scope Limit the scope of the highlighting
  */
 declare function surrealql(scope?: Scope): LanguageSupport;
 
-export { surrealql, surrealqlLanguage };
+export { surrealql, surrealqlLanguage, surrealqlVersionLinter };

package/dist/index.js

@@ -1,7 +1,9 @@
-import { LRLanguage, indentNodeProp, continuedIndent, foldNodeProp, foldInside, LanguageSupport } from '@codemirror/language';
-import { parser } from 'lezer-surrealql';
+import { LRLanguage, indentNodeProp, continuedIndent, foldNodeProp, foldInside, syntaxTree, LanguageSupport } from '@codemirror/language';
+import { linter } from '@codemirror/lint';
 import { parseMixed } from '@lezer/common';
 import { parser as parser$1 } from '@lezer/javascript';
+import { parser, sinceProp, untilProp } from '@surrealdb/lezer';
+import { validate, compareVersions } from 'compare-versions';
 
 const surrealqlLanguage = /*@__PURE__*/LRLanguage.define({
     name: "surrealql",
@@ -22,23 +24,68 @@ const surrealqlLanguage = /*@__PURE__*/LRLanguage.define({
     languageData: {
         closeBrackets: { brackets: ["[", "{", '"', "'", "("] },
         indentOnInput: /^\s*[\]}]$/,
-        commentTokens: { line: "--" },
+        commentTokens: { line: "--", block: { open: "/*", close: "*/" } },
     },
 });
-const languageMap = /*@__PURE__*/new Map([
-    ["default", /*@__PURE__*/surrealqlLanguage.configure({ top: "SurrealQL" })],
-    ["permission", /*@__PURE__*/surrealqlLanguage.configure({ top: "PermissionInput" })],
-    ["combined-results", /*@__PURE__*/surrealqlLanguage.configure({ top: "CombinedResults" })],
+const scopeMap = /*@__PURE__*/new Map([
+    ["permission", "PermissionInput"],
+    ["index", "IndexInput"],
+    ["combined-results", "CombinedResults"],
+    ["syntax", "Syntax"],
 ]);
+/**
+ * A linter that checks if the syntax tree uses features that are not available in the given SurrealDB version
+ *
+ * @param version The SurrealDB version to check against (e.g. "2.0.0")
+ */
+function surrealqlVersionLinter(version) {
+    if (!validate(version)) {
+        throw new Error(`Invalid SurrealDB version: ${version}`);
+    }
+    return linter((view) => {
+        const diagnostics = [];
+        syntaxTree(view.state)
+            .cursor()
+            .iterate((node) => {
+            if (node.from === node.to) {
+                return;
+            }
+            const sinceVersionProp = node.type.prop(sinceProp);
+            const untilVersionProp = node.type.prop(untilProp);
+            if (sinceVersionProp && compareVersions(version, sinceVersionProp) < 0) {
+                diagnostics.push({
+                    from: node.from,
+                    to: node.to,
+                    severity: "error",
+                    message: `This syntax is only available on SurrealDB ${sinceVersionProp} and up`,
+                });
+            }
+            if (untilVersionProp && compareVersions(version, untilVersionProp) >= 0) {
+                diagnostics.push({
+                    from: node.from,
+                    to: node.to,
+                    severity: "error",
+                    message: `This syntax is only available until SurrealDB ${untilVersionProp}`,
+                });
+            }
+        });
+        return diagnostics;
+    });
+}
 /**
  * The CodeMirror extension used to add support for the SurrealQL language
+ *
+ * @param scope Limit the scope of the highlighting
  */
-function surrealql(scope = "default") {
-    const language = languageMap.get(scope);
-    if (!language) {
+function surrealql(scope) {
+    if (!scope) {
+        return new LanguageSupport(surrealqlLanguage);
+    }
+    const scopeId = scopeMap.get(scope);
+    if (!scopeId) {
         throw new Error(`Unknown language scope: ${scope}`);
     }
-    return new LanguageSupport(language);
+    return new LanguageSupport(surrealqlLanguage.configure({ top: scopeId }));
 }
 
-export { surrealql, surrealqlLanguage };
+export { surrealql, surrealqlLanguage, surrealqlVersionLinter };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@surrealdb/codemirror",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0-beta.20",
   "author": "SurrealDB",
   "description": "SurrealQL language support for CodeMirror",
   "type": "module",
@@ -12,10 +12,12 @@
   "types": "dist/index.d.ts",
   "module": "dist/index.js",
   "dependencies": {
-    "@codemirror/language": "^6.0.0",
-    "@lezer/common": "^1.2.1",
-    "@lezer/javascript": "^1.4.13",
-    "@surrealdb/lezer": ""
+    "@codemirror/language": "^6.10.3",
+    "@codemirror/lint": "^6.8.2",
+    "@lezer/common": "^1.2.3",
+    "@lezer/javascript": "^1.4.19",
+    "@surrealdb/lezer": "",
+    "compare-versions": "^6.1.1"
   },
   "devDependencies": {
     "@codemirror/buildhelper": "^1.0.0"

package/src/surrealql.ts

@@ -1,15 +1,18 @@
 import {
-	continuedIndent,
-	indentNodeProp,
-	foldNodeProp,
-	foldInside,
 	LRLanguage,
 	LanguageSupport,
+	continuedIndent,
+	foldInside,
+	foldNodeProp,
+	indentNodeProp,
+	syntaxTree,
 } from "@codemirror/language";
-
-import { parser } from "lezer-surrealql";
+import { type Diagnostic, linter } from "@codemirror/lint";
+import type { Extension } from "@codemirror/state";
 import { parseMixed } from "@lezer/common";
 import { parser as jsParser } from "@lezer/javascript";
+import { parser, sinceProp, untilProp } from "@surrealdb/lezer";
+import { compareVersions, validate } from "compare-versions";
 
 export const surrealqlLanguage = LRLanguage.define({
 	name: "surrealql",
@@ -30,27 +33,80 @@ export const surrealqlLanguage = LRLanguage.define({
 	languageData: {
 		closeBrackets: { brackets: ["[", "{", '"', "'", "("] },
 		indentOnInput: /^\s*[\]}]$/,
-		commentTokens: { line: "--" },
+		commentTokens: { line: "--", block: { open: "/*", close: "*/" } },
 	},
 });
 
-type Scope = "default" | "permission" | "combined-results";
+type Scope = "permission" | "index" | "combined-results" | "syntax";
 
-const languageMap = new Map<Scope, LRLanguage>([
-	["default", surrealqlLanguage.configure({ top: "SurrealQL" })],
-	["permission", surrealqlLanguage.configure({ top: "PermissionInput" })],
-	["combined-results", surrealqlLanguage.configure({ top: "CombinedResults" })],
+const scopeMap = new Map<Scope, string>([
+	["permission", "PermissionInput"],
+	["index", "IndexInput"],
+	["combined-results", "CombinedResults"],
+	["syntax", "Syntax"],
 ]);
 
+/**
+ * A linter that checks if the syntax tree uses features that are not available in the given SurrealDB version
+ *
+ * @param version The SurrealDB version to check against (e.g. "2.0.0")
+ */
+export function surrealqlVersionLinter(version: string): Extension {
+	if (!validate(version)) {
+		throw new Error(`Invalid SurrealDB version: ${version}`);
+	}
+
+	return linter((view) => {
+		const diagnostics: Diagnostic[] = [];
+
+		syntaxTree(view.state)
+			.cursor()
+			.iterate((node) => {
+				if (node.from === node.to) {
+					return;
+				}
+
+				const sinceVersionProp = node.type.prop(sinceProp);
+				const untilVersionProp = node.type.prop(untilProp);
+
+				if (sinceVersionProp && compareVersions(version, sinceVersionProp) < 0) {
+					diagnostics.push({
+						from: node.from,
+						to: node.to,
+						severity: "error",
+						message: `This syntax is only available on SurrealDB ${sinceVersionProp} and up`,
+					});
+				}
+
+				if (untilVersionProp && compareVersions(version, untilVersionProp) >= 0) {
+					diagnostics.push({
+						from: node.from,
+						to: node.to,
+						severity: "error",
+						message: `This syntax is only available until SurrealDB ${untilVersionProp}`,
+					});
+				}
+			});
+
+		return diagnostics;
+	});
+}
+
 /**
  * The CodeMirror extension used to add support for the SurrealQL language
+ *
+ * @param scope Limit the scope of the highlighting
  */
-export function surrealql(scope: Scope = "default") {
-	const language = languageMap.get(scope);
+export function surrealql(scope?: Scope): LanguageSupport {
+	if (!scope) {
+		return new LanguageSupport(surrealqlLanguage);
+	}
+
+	const scopeId = scopeMap.get(scope);
 
-	if (!language) {
+	if (!scopeId) {
 		throw new Error(`Unknown language scope: ${scope}`);
 	}
 
-	return new LanguageSupport(language);
+	return new LanguageSupport(surrealqlLanguage.configure({ top: scopeId }));
 }