@elastic/monaco-esql 2.0.0 → 3.1.0

package/README.md

@@ -12,7 +12,7 @@ To highlight ES|QL code in Monaco editor, you need to register ES|QL language
 and its Monarch grammar:
 
 ```js
-import { monarchLanguage } from '@elastic/monaco-esql';
+import { language as monarchLanguage } from '@elastic/monaco-esql/lib/monarch-shared';
 
 monaco.languages.register({id: 'esql'});
 monaco.languages.setMonarchTokensProvider('esql', monarchLanguage);

package/lib/definitions.d.ts

@@ -1,4 +1,5 @@
-export declare const commands: string[];
+export declare const sourceCommands: string[];
+export declare const processingCommands: string[];
 export declare const options: string[];
 export declare const literals: string[];
 export declare const functions: string[];
@@ -9,3 +10,8 @@ export declare const operators: {
         other: string[];
     };
 };
+export type TemporalUnit = [unit: string, ...abbreviations: string[]];
+/**
+ * @see https://www.elastic.co/docs/reference/query-languages/esql/esql-time-spans#esql-time-spans-table
+ */
+export declare const temporalUnits: TemporalUnit[];

package/lib/definitions.js

@@ -1,18 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.operators = exports.delimiters = exports.functions = exports.literals = exports.options = exports.commands = void 0;
-exports.commands = [
+exports.temporalUnits = exports.operators = exports.delimiters = exports.functions = exports.literals = exports.options = exports.processingCommands = exports.sourceCommands = void 0;
+exports.sourceCommands = [
+    "FROM",
+    "ROW",
+    "EXPLAIN",
+    "SHOW INFO",
+    "SHOW",
+    "TS",
+];
+exports.processingCommands = [
+    "CHANGE_POINT",
+    "COMPLETION",
     "DISSECT",
     "DROP",
     "ENRICH",
     "EVAL",
-    "EXPLAIN",
     "FORK",
-    "FROM",
+    "FORK",
     "FULL JOIN",
     "GROK",
     "INFO",
     "INLINESTATS",
+    "INSIST",
     "JOIN",
     "KEEP",
     "LEFT JOIN",
@@ -23,11 +33,10 @@ exports.commands = [
     "METRICS",
     "MV_EXPAND",
     "RENAME",
+    "RERANK",
     "RIGHT JOIN",
     "RIGHT",
-    "ROW",
-    "SHOW INFO",
-    "SHOW",
+    "RRF",
     "SORT",
     "STATS",
     "WHERE",
@@ -216,3 +225,17 @@ exports.operators = {
         other: ["ASC", "DESC", "FIRST", "LAST", "NULLS", "NOT"],
     },
 };
+/**
+ * @see https://www.elastic.co/docs/reference/query-languages/esql/esql-time-spans#esql-time-spans-table
+ */
+exports.temporalUnits = [
+    ["YEAR", "Y", "YR", "YEARS"],
+    ["QUARTER", "Q", "QUARTERS"],
+    ["MONTH", "MO", "MONTHS"],
+    ["WEEK", "W", "WEEKS"],
+    ["DAY", "D", "DAYS"],
+    ["HOUR", "H", "HOURS"],
+    ["MINUTE", "MIN", "MINUTES"],
+    ["SECOND", "S", "SEC", "SECONDS"],
+    ["MILLISECOND", "MS", "MILLISECONDS"],
+];

package/lib/monarch.js

@@ -2,14 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.create = void 0;
 const create = (deps = {}) => {
-    const { commands = [], options = [], literals = [], functions = [], delimiters = [], } = deps;
+    const { sourceCommands = [], processingCommands = [], options = [], literals = [], functions = [], delimiters = [], temporalUnits = [], } = deps;
+    const timeUnits = temporalUnits.flat().sort((a, b) => (a > b ? -1 : 1));
     return {
         // Uncomment when developing.
         // defaultToken: "invalid",
         // ES|QL is case-insensitive.
         ignoreCase: true,
         // Lists of known language keywords and built-ins.
-        commands,
+        sourceCommands,
+        processingCommands,
         options,
         literals,
         functions,
@@ -21,6 +23,7 @@ const create = (deps = {}) => {
         // Pre-defined regular expressions.
         escapes: /\\(?:[abfnrtv\\"']|x[0-9A-Fa-f]{1,4}|u[0-9A-Fa-f]{4}|U[0-9A-Fa-f]{8})/,
         digits: /\d+(_+\d+)*/,
+        symbols: /[=><!~:&|+\-*\/\^%\.,]+/,
         brackets: [
             { open: "[", close: "]", token: "delimiter.square" },
             { open: "(", close: ")", token: "delimiter.parenthesis" },
@@ -32,14 +35,16 @@ const create = (deps = {}) => {
                 { include: "@whitespace" },
                 // Keywords
                 [
-                    /[a-zA-Z_$][\w$]*/,
+                    /@?[a-zA-Z_$][\w$]*/,
                     {
                         cases: {
-                            "@commands": { token: "keyword.command.$0" },
+                            "@sourceCommands": { token: "keyword.command.source.$0" },
+                            "@processingCommands": { token: "keyword.command.processing.$0" },
                             "@options": { token: "keyword.option.$0" },
                             "@literals": { token: "keyword.literal.$0" },
                             "@functions": { token: "identifier.function.$0" },
                             "@namedOperators": { token: "keyword.operator.$0" },
+                            "\\@{1}timestamp": "identifier.timestamp",
                             "@default": "identifier",
                         },
                     },
@@ -48,10 +53,11 @@ const create = (deps = {}) => {
                 { include: "@processingCommand" },
                 [/\[|\(|\)|\]/, "@brackets"],
                 [
-                    /[^\s]+/,
+                    /@symbols/,
                     {
                         cases: {
                             "@delimiters": "delimiter",
+                            "@default": "",
                         },
                     },
                 ],
@@ -91,11 +97,18 @@ const create = (deps = {}) => {
             commandName: [
                 // First tries to match all known command names.
                 [
-                    commands.join("|"),
-                    { token: "keyword.command.name", switchTo: "@root" },
+                    sourceCommands.join("|"),
+                    { token: "keyword.command.source.$0", switchTo: "@root" },
+                ],
+                [
+                    processingCommands.join("|"),
+                    { token: "keyword.command.processing.$0", switchTo: "@root" },
                 ],
                 // If command name is not well known, just matches the first word.
-                [/\w+\b/, { token: "keyword.command.name", switchTo: "@root" }],
+                [
+                    /\w+\b/,
+                    { token: "keyword.command.processing.$0", switchTo: "@root" },
+                ],
             ],
             // ------------------------------------------------------------- Expressions
             expression: [
@@ -112,6 +125,7 @@ const create = (deps = {}) => {
                 [/`/, "string", "@column_escape_part"],
             ],
             literal: [
+                { include: "@timeInterval" },
                 { include: "@number" },
                 // Params
                 [
@@ -125,6 +139,7 @@ const create = (deps = {}) => {
                     },
                 ],
             ],
+            timeInterval: [[`(@digits)\\s*(${timeUnits.join("|")})`, "number.time"]],
             number: [
                 [/(@digits)[eE]([\-+]?(@digits))?/, "number.float"],
                 [/(@digits)\.(@digits)([eE][\-+]?(@digits))?/, "number.float"],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elastic/monaco-esql",
-  "version": "2.0.0",
+  "version": "3.1.0",
   "private": false,
   "publishConfig": {
     "access": "public"