@surrealdb/codemirror 1.0.0-beta.1 → 1.0.0-beta.11

package/README.md

@@ -0,0 +1,79 @@
+<br>
+
+<p align="center">
+    <img width=120 src="https://raw.githubusercontent.com/surrealdb/icons/main/surreal.svg" />
+</p>
+
+<h3 align="center">SurrealQL Support for CodeMirror</h3>
+
+<br>
+
+<p align="center">
+    <a href="https://github.com/surrealdb/surrealql-codemirror"><img src="https://img.shields.io/badge/status-beta-ff00bb.svg?style=flat-square"></a>
+    &nbsp;
+    <a href="https://www.npmjs.com/package/@surrealdb/codemirror"><img src="https://img.shields.io/npm/v/%40surrealdb%2Fcodemirror?style=flat-square"></a>
+</p>
+
+<p align="center">
+    <a href="https://surrealdb.com/discord"><img src="https://img.shields.io/discord/902568124350599239?label=discord&style=flat-square&color=5a66f6"></a>
+    &nbsp;
+    <a href="https://twitter.com/surrealdb"><img src="https://img.shields.io/badge/twitter-follow_us-1d9bf0.svg?style=flat-square"></a>
+    &nbsp;
+    <a href="https://www.linkedin.com/company/surrealdb/"><img src="https://img.shields.io/badge/linkedin-connect_with_us-0a66c2.svg?style=flat-square"></a>
+    &nbsp;
+    <a href="https://www.youtube.com/channel/UCjf2teVEuYVvvVC-gFZNq6w"><img src="https://img.shields.io/badge/youtube-subscribe-fc1c1c.svg?style=flat-square"></a>
+</p>
+
+# @surrealdb/codemirror
+
+This library provides full support for the SurrealQL language within your CodeMirror editors.
+
+Some features include:
+- Intelligent SurrealQL highlighting
+- Folding support for blocks, objects, and arrays
+- Automatic indentation support
+- Support for comment toggling
+- Embedded JavaScript highlighting
+
+## How to install
+
+Install it with:
+
+```sh
+# using npm
+npm i @surrealdb/codemirror
+# or using pnpm
+pnpm i @surrealdb/codemirror
+# or using yarn
+yarn add @surrealdb/codemirror
+```
+
+Next, just import it with:
+
+```ts
+const { surrealql } = require("@surrealdb/codemirror");
+```
+
+or when you use modules:
+
+```ts
+import { surrealql } from "@surrealdb/codemirror";
+```
+
+## Example usage
+
+```ts
+import { surrealql } from "@surrealdb/codemirror";
+
+const state = EditorState.create({
+    doc: "SELECT * FROM table",
+    extensions: [
+        surrealql()
+    ]
+});
+
+const editor = new EditorView({
+    parent: document.getElementById("editor"),
+    state: state,
+});
+```

package/dist/index.cjs

@@ -1,13 +1,13 @@
 'use strict';
 
 var language = require('@codemirror/language');
-var lezerSurrealql = require('lezer-surrealql');
+var lezer = require('@surrealdb/lezer');
 var common = require('@lezer/common');
 var javascript = require('@lezer/javascript');
 
 const surrealqlLanguage = language.LRLanguage.define({
     name: "surrealql",
-    parser: lezerSurrealql.parser.configure({
+    parser: lezer.parser.configure({
         props: [
             language.indentNodeProp.add({
                 Object: language.continuedIndent({ except: /^\s*}/ }),
@@ -27,20 +27,26 @@ const surrealqlLanguage = language.LRLanguage.define({
         commentTokens: { line: "--" },
     },
 });
-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"],
 ]);
 /**
  * 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;

package/dist/index.d.cts

@@ -1,9 +1,11 @@
 import { LRLanguage, LanguageSupport } from '@codemirror/language';
 
 declare const surrealqlLanguage: LRLanguage;
-type Scope = "default" | "permission" | "combined-results";
+type Scope = "permission" | "index" | "combined-results" | "syntax";
 /**
  * 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;
 

package/dist/index.d.ts

@@ -1,9 +1,11 @@
 import { LRLanguage, LanguageSupport } from '@codemirror/language';
 
 declare const surrealqlLanguage: LRLanguage;
-type Scope = "default" | "permission" | "combined-results";
+type Scope = "permission" | "index" | "combined-results" | "syntax";
 /**
  * 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;
 

package/dist/index.js

@@ -1,5 +1,5 @@
 import { LRLanguage, indentNodeProp, continuedIndent, foldNodeProp, foldInside, LanguageSupport } from '@codemirror/language';
-import { parser } from 'lezer-surrealql';
+import { parser } from '@surrealdb/lezer';
 import { parseMixed } from '@lezer/common';
 import { parser as parser$1 } from '@lezer/javascript';
 
@@ -25,20 +25,26 @@ const surrealqlLanguage = /*@__PURE__*/LRLanguage.define({
         commentTokens: { line: "--" },
     },
 });
-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"],
 ]);
 /**
  * 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@surrealdb/codemirror",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.11",
   "author": "SurrealDB",
   "description": "SurrealQL language support for CodeMirror",
   "type": "module",

package/src/surrealql.ts

@@ -7,7 +7,7 @@ import {
 	LanguageSupport,
 } from "@codemirror/language";
 
-import { parser } from "lezer-surrealql";
+import { parser } from "@surrealdb/lezer";
 import { parseMixed } from "@lezer/common";
 import { parser as jsParser } from "@lezer/javascript";
 
@@ -34,23 +34,30 @@ export const surrealqlLanguage = LRLanguage.define({
 	},
 });
 
-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"],
 ]);
 
 /**
  * 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) {
+	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 }));
 }