feat(editor): Migrate codemirror-lang-n8n-expression into this monorepo (no-changelog) (#9087)

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

packages/@n8n/codemirror-lang/.eslintrc.cjs

@@ -0,0 +1,14 @@
+const sharedOptions = require('@n8n_io/eslint-config/shared');
+
+/**
+ * @type {import('@types/eslint').ESLint.ConfigData}
+ */
+module.exports = {
+	extends: ['@n8n_io/eslint-config/base'],
+
+	...sharedOptions(__dirname),
+
+	ignorePatterns: [
+		'src/expressions/grammar*.ts'
+	]
+};

packages/@n8n/codemirror-lang/README.md

@@ -0,0 +1,5 @@
+# @n8n/codemirror-lang
+
+Language support package for CodeMirror 6 in n8n
+
+[n8n Expression Language support](./src/expressions/README.md)

packages/@n8n/codemirror-lang/jest.config.js

@@ -0,0 +1,2 @@
+/** @type {import('jest').Config} */
+module.exports = require('../../../jest.config');

packages/@n8n/codemirror-lang/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@n8n/codemirror-lang",
+  "version": "0.3.0",
+  "description": "Language support package for CodeMirror 6 in n8n",
+  "private": true,
+  "sideEffects": false,
+  "main": "dist/index.js",
+  "module": "src/index.ts",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./src/index.ts",
+      "types": "./dist/index.d.ts"
+    },
+    "./*": "./*"
+  },
+  "scripts": {
+    "clean": "rimraf dist .turbo",
+    "typecheck": "tsc --noEmit",
+    "generate:expressions:grammar": "lezer-generator --typeScript --output src/expressions/grammar.ts src/expressions/expressions.grammar",
+    "generate": "pnpm generate:expressions:grammar && pnpm format",
+    "build": "tsc -p tsconfig.build.json",
+    "test": "jest",
+    "lint": "eslint . --ext .ts --quiet",
+    "lintfix": "eslint . --ext .ts --fix",
+    "format": "prettier --write --ignore-path ../../.prettierignore src test"
+  },
+  "peerDependencies": {
+    "@codemirror/language": "*",
+    "@lezer/highlight": "*",
+    "@lezer/lr": "^1.4.0"
+  },
+  "devDependencies": {
+    "@lezer/generator": "^1.7.0"
+  }
+}

packages/@n8n/codemirror-lang/src/expressions/README.md

@@ -0,0 +1,26 @@
+# n8n Expression language support
+
+## Usage
+
+```js
+import { parserWithMetaData as n8nParser } from '@n8n/codemirror-lang';
+import { LanguageSupport, LRLanguage } from '@codemirror/language';
+import { parseMixed } from '@lezer/common';
+import { parser as jsParser } from '@lezer/javascript';
+
+const n8nPlusJsParser = n8nParser.configure({
+	wrap: parseMixed((node) => {
+		if (node.type.isTop) return null;
+
+		return node.name === 'Resolvable'
+			? { parser: jsParser, overlay: (node) => node.type.name === 'Resolvable' }
+			: null;
+	}),
+});
+
+const n8nLanguage = LRLanguage.define({ parser: n8nPlusJsParser });
+
+export function n8nExpressionLanguageSupport() {
+	return new LanguageSupport(n8nLanguage);
+}
+```

packages/@n8n/codemirror-lang/src/expressions/expressions.grammar

@@ -0,0 +1,21 @@
+@top Program { entity* }
+
+entity { Plaintext | Resolvable }
+
+@tokens {
+  Plaintext { ![{] Plaintext? | "{" (@eof | ![{] Plaintext?) }
+
+  OpenMarker[closedBy="CloseMarker"] { "{{" }
+
+  CloseMarker[openedBy="OpenMarker"] { "}}" }
+
+  Resolvable {
+    OpenMarker resolvableChar* CloseMarker
+  }
+
+  resolvableChar { unicodeChar | "}" ![}] | "\\}}" }
+
+  unicodeChar { $[\u0000-\u007C] | $[\u007E-\u1FFF] | $[\u20A0-\u20CF] | $[\u{1F300}-\u{1F64F}] }
+}
+
+@detectDelim

packages/@n8n/codemirror-lang/src/expressions/grammar.terms.ts

@@ -0,0 +1,4 @@
+// This file was generated by lezer-generator. You probably shouldn't edit it.
+export const Program = 1,
+	Plaintext = 2,
+	Resolvable = 3;

packages/@n8n/codemirror-lang/src/expressions/grammar.ts

@@ -0,0 +1,18 @@
+// This file was generated by lezer-generator. You probably shouldn't edit it.
+import { LRParser } from '@lezer/lr';
+
+export const parser = LRParser.deserialize({
+	version: 14,
+	states: "nQQOPOOOOOO'#Cb'#CbOOOO'#C`'#C`QQOPOOOOOO-E6^-E6^",
+	stateData: 'Y~OQPORPO~O',
+	goto: 'bVPPPPWP^QRORSRTQOR',
+	nodeNames: '⚠ Program Plaintext Resolvable',
+	maxTerm: 6,
+	skippedNodes: [0],
+	repeatNodeCount: 1,
+	tokenData:
+		"&U~RTO#ob#o#p!h#p;'Sb;'S;=`!]<%lOb~gTQ~O#ob#o#pv#p;'Sb;'S;=`!]<%lOb~yUO#ob#p;'Sb;'S;=`!]<%l~b~Ob~~!c~!`P;=`<%lb~!hOQ~~!kVO#ob#o#p#Q#p;'Sb;'S;=`!]<%l~b~Ob~~!c~#TWO#O#Q#O#P#m#P#q#Q#q#r%Z#r$IS#Q$Lj$Ml#Q;(b;(c%x;(c;(d&O~#pWO#O#Q#O#P#m#P#q#Q#q#r$Y#r$IS#Q$Lj$Ml#Q;(b;(c%x;(c;(d&O~$]TO#q#Q#q#r$l#r;'S#Q;'S;=`%r<%lO#Q~$qWR~O#O#Q#O#P#m#P#q#Q#q#r%Z#r$IS#Q$Lj$Ml#Q;(b;(c%x;(c;(d&O~%^TO#q#Q#q#r%m#r;'S#Q;'S;=`%r<%lO#Q~%rOR~~%uP;=`<%l#Q~%{P;NQ<%l#Q~&RP;=`;JY#Q",
+	tokenizers: [0],
+	topRules: { Program: [0, 1] },
+	tokenPrec: 0,
+});

packages/@n8n/codemirror-lang/src/expressions/index.ts

@@ -0,0 +1,28 @@
+import { LRLanguage, LanguageSupport, foldNodeProp, foldInside } from '@codemirror/language';
+import { styleTags, tags as t } from '@lezer/highlight';
+import { parser } from './grammar';
+
+export const parserWithMetaData = parser.configure({
+	props: [
+		foldNodeProp.add({
+			Application: foldInside,
+		}),
+		styleTags({
+			OpenMarker: t.brace,
+			CloseMarker: t.brace,
+			Plaintext: t.content,
+			Resolvable: t.string,
+		}),
+	],
+});
+
+export const n8nLanguage = LRLanguage.define({
+	parser: parserWithMetaData,
+	languageData: {
+		commentTokens: { line: ';' },
+	},
+});
+
+export function n8nExpression() {
+	return new LanguageSupport(n8nLanguage);
+}

packages/@n8n/codemirror-lang/src/index.ts

@@ -0,0 +1 @@
+export { parserWithMetaData, n8nLanguage } from './expressions';

packages/@n8n/codemirror-lang/test/expressions/cases.txt

@@ -0,0 +1,255 @@
+# Resolvable
+
+{{ 1 + 1 }}
+
+==>
+
+Program(Resolvable)
+
+# Empty Resolvable
+
+{{}}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable of only whitespace
+
+{{ }}
+
+==>
+
+Program(Resolvable)
+
+# No content
+
+
+
+==>
+
+Program
+
+# Plaintext
+
+text
+
+==>
+
+Program(Plaintext)
+
+# Plaintext of single-brace-wrapped text
+
+{text}
+
+==>
+
+Program(Plaintext)
+
+# Plaintext then Resolvable
+
+text {{ 1 + 1 }}
+
+==>
+
+Program(Plaintext, Resolvable)
+
+# Resolvable then Plaintext
+
+{{ 1 + 1 }} Plaintext
+
+==>
+
+Program(Resolvable, Plaintext)
+
+# Plaintext then Resolvable then Plaintext
+
+text {{ 1 + 1 }} text
+
+==>
+
+Program(Plaintext, Resolvable, Plaintext)
+
+# Resolvable then Plaintext then Resolvable
+
+{{ 1 + 1 }} text {{ 1 + 1 }}
+
+==>
+
+Program(Resolvable,Plaintext,Resolvable)
+
+# Plaintext then Resolvable then Plaintext then Resolvable
+
+text {{ 1 + 1 }} text {{ 1 + 1 }}
+
+==>
+
+Program(Plaintext, Resolvable, Plaintext, Resolvable)
+
+# Resolvable then Plaintext then Resolvable then Plaintext
+
+{{ 1 + 1 }} text {{ 1 + 1 }} text
+
+==>
+
+Program(Resolvable,Plaintext,Resolvable,Plaintext)
+
+# Resolvable containing all resolvable chars
+
+{{ he ()[]{<>~`!@#$%^&*-_+=|\;:'",./?\{ llo }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable containing single left brace
+
+{{ he { llo }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable containing double left brace
+
+{{ he {{ llo }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable containing triple left brace
+
+{{ he {{{ llo }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable containing single right brace
+
+{{ he } llo }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable containing escaped double right brace
+
+{{ he \}} llo }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable containing escaped triple right brace
+
+{{ he \}}} llo }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable containing single-brace-wrapped text with escaping
+
+{{ he { abc } llo }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable containing double-brace-wrapped text with escaping
+
+{{ he {{ abc \}} llo }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable containing triple-brace-wrapped text with escaping
+
+{{ he {{{ abc \}}} llo }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable containing single-bracket-wrapped text
+
+{{ he [ abc ] llo }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable containing double-bracket-wrapped text
+
+{{ he [[ abc ]] llo }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable containing triple-bracket-wrapped text
+
+{{ he [[[ abc ]]] llo }}
+
+==>
+
+Program(Resolvable)
+
+# Plaintext of one opening brace
+
+{
+
+==>
+
+Program(Plaintext)
+
+# Plaintext of one opening brace and two closing braces
+
+{ }}
+
+==>
+
+Program(Plaintext)
+
+# Plaintext then Resolvable with non-ASCII chars then Plaintext
+
+a {{ 'áßи' }} a
+
+==>
+
+Program(Plaintext, Resolvable, Plaintext)
+
+# Resolvable with currency symbol
+
+{{ '€' }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable with cyrillic char
+
+{{ 'л' }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable with Pictographs char
+
+{{ '🎉' }}
+
+==>
+
+Program(Resolvable)
+
+# Resolvable with Emoticons char
+
+{{ '😎' }}
+
+==>
+
+Program(Resolvable)

packages/@n8n/codemirror-lang/test/expressions/expressions.test.ts

@@ -0,0 +1,21 @@
+import fs from 'fs';
+import path from 'path';
+import { fileTests as runTestFile } from '@lezer/generator/dist/test';
+import { n8nLanguage } from '../../src/expressions/index';
+
+describe('expressions language', () => {
+	const CASES_DIR = __dirname;
+	for (const testFile of fs.readdirSync(CASES_DIR)) {
+		if (!/\.txt$/.test(testFile)) continue;
+
+		const testFileName = /^[^\.]*/.exec(testFile)![0];
+		describe(testFileName, () => {
+			for (const { name, run } of runTestFile(
+				fs.readFileSync(path.join(CASES_DIR, testFile), 'utf8'),
+				testFile,
+			)) {
+				it(name, () => run(n8nLanguage.parser));
+			}
+		});
+	}
+});

packages/@n8n/codemirror-lang/tsconfig.build.json

@@ -0,0 +1,10 @@
+{
+	"extends": ["./tsconfig.json", "../../../tsconfig.build.json"],
+	"compilerOptions": {
+		"rootDir": "src",
+		"outDir": "dist",
+		"tsBuildInfoFile": "dist/build.tsbuildinfo"
+	},
+	"include": ["src/**/*.ts"],
+	"exclude": ["test/**"]
+}

packages/@n8n/codemirror-lang/tsconfig.json

@@ -0,0 +1,9 @@
+{
+	"extends": "../../../tsconfig.json",
+	"compilerOptions": {
+		"rootDir": ".",
+		"tsBuildInfoFile": "dist/typecheck.tsbuildinfo",
+		"strict": true
+	},
+	"include": ["src/**/*.ts", "test/**/*.ts"]
+}