Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 69 Commits
.github		.github
dev		dev
packages		packages
.editorconfig		.editorconfig
.gitignore		.gitignore
.npmrc		.npmrc
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
biome.json		biome.json
index.html		index.html
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
pnpm-workspace.yaml		pnpm-workspace.yaml
vite.config.ts		vite.config.ts

Repository files navigation

SurrealQL Support for CodeMirror

@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
Support for linting of supported syntax based on version

How to install

Install it with:

# using npmnpm i @surrealdb/codemirror# or using pnpmpnpm i @surrealdb/codemirror# or using yarnyarn add @surrealdb/codemirror

Next, just import it with:

const{ surrealql}=require("@surrealdb/codemirror");

or when you use modules:

import{surrealql}from"@surrealdb/codemirror";

Example usage

import{surrealql}from"@surrealdb/codemirror";conststate=EditorState.create({doc:"SELECT * FROM table",extensions:[surrealql()]});consteditor=newEditorView({parent:document.getElementById("editor"),state:state,});

import{surrealql,surrealqlVersionLinter}from"@surrealdb/codemirror";conststate=EditorState.create({doc:"SELECT * FROM table",extensions:[surrealql(),surrealqlVersionLinter("2.0.0")]});consteditor=newEditorView({parent:document.getElementById("editor"),state:state,});