From 7fe3a19d323ba86f5fff684327aae39ed9000382 Mon Sep 17 00:00:00 2001
From: Isak <isak.nilsson@neo4j.com>
Date: Thu, 28 Nov 2024 10:20:12 +0100
Subject: [PATCH 01/12] added parsing of preparser options for cypher versions
 and key=value

---
 .../src/antlr-grammar/CypherPreLexer.g4       |   5 +-
 .../src/antlr-grammar/CypherPreParser.g4      |   2 +-
 .../semanticValidation.test.ts                | 180 ++++++++++++++++++
 3 files changed, 185 insertions(+), 2 deletions(-)

diff --git a/packages/language-support/src/antlr-grammar/CypherPreLexer.g4 b/packages/language-support/src/antlr-grammar/CypherPreLexer.g4
index a2438d6b..91777d5d 100644
--- a/packages/language-support/src/antlr-grammar/CypherPreLexer.g4
+++ b/packages/language-support/src/antlr-grammar/CypherPreLexer.g4
@@ -6,4 +6,7 @@ EXPLAIN:
    E X P L A I N;
 
 PROFILE:
-   P R O F I L E;
\ No newline at end of file
+   P R O F I L E;
+
+CYPHER:
+   C Y P H E R;
\ No newline at end of file
diff --git a/packages/language-support/src/antlr-grammar/CypherPreParser.g4 b/packages/language-support/src/antlr-grammar/CypherPreParser.g4
index bceb0919..2a1b34ba 100644
--- a/packages/language-support/src/antlr-grammar/CypherPreParser.g4
+++ b/packages/language-support/src/antlr-grammar/CypherPreParser.g4
@@ -8,4 +8,4 @@ preparsedStatement:
    preparserOption? statement;
 
 preparserOption:
-   EXPLAIN | PROFILE;
\ No newline at end of file
+   EXPLAIN | PROFILE | CYPHER (UNSIGNED_DECIMAL_INTEGER | IDENTIFIER EQ (IDENTIFIER | numberLiteral))*;
\ No newline at end of file
diff --git a/packages/language-support/src/tests/syntaxValidation/semanticValidation.test.ts b/packages/language-support/src/tests/syntaxValidation/semanticValidation.test.ts
index 58f532c4..312edffd 100644
--- a/packages/language-support/src/tests/syntaxValidation/semanticValidation.test.ts
+++ b/packages/language-support/src/tests/syntaxValidation/semanticValidation.test.ts
@@ -100,6 +100,186 @@ describe('Semantic validation spec', () => {
     ]);
   });
 
+  test('Semantic errors work using empty preparser options. Like CYPHER <rest of query', () => {
+    const query = `CYPHER MATCH (n);
+                   CYPHER MATCH (m) RETURN n`;
+
+    expect(getDiagnosticsForQuery({ query })).toEqual([
+      {
+        message:
+          'Query cannot conclude with MATCH (must be a RETURN clause, a FINISH clause, an update clause, a unit subquery call, or a procedure call with no YIELD).',
+        offsets: {
+          end: 16,
+          start: 7,
+        },
+        range: {
+          end: {
+            character: 16,
+            line: 0,
+          },
+          start: {
+            character: 7,
+            line: 0,
+          },
+        },
+        severity: 1,
+      },
+      {
+        message: 'Variable `n` not defined',
+        offsets: {
+          end: 62,
+          start: 61,
+        },
+        range: {
+          end: {
+            character: 44,
+            line: 1,
+          },
+          start: {
+            character: 43,
+            line: 1,
+          },
+        },
+        severity: 1,
+      },
+    ]);
+  });
+
+  test('Semantic errors work using both version syntax and key-value syntax for preparser options. Like CYPHER <version> <option> = <value>', () => {
+    const query = `CYPHER 25 runtime = pipelined timeout = 1000 MATCH (n);
+                   CYPHER 5 timeout= 555 MATCH (m) RETURN n`;
+
+    expect(getDiagnosticsForQuery({ query })).toEqual([
+      {
+        message:
+          'Query cannot conclude with MATCH (must be a RETURN clause, a FINISH clause, an update clause, a unit subquery call, or a procedure call with no YIELD).',
+        offsets: {
+          end: 54,
+          start: 45,
+        },
+        range: {
+          end: {
+            character: 54,
+            line: 0,
+          },
+          start: {
+            character: 45,
+            line: 0,
+          },
+        },
+        severity: 1,
+      },
+      {
+        message: 'Variable `n` not defined',
+        offsets: {
+          end: 115,
+          start: 114,
+        },
+        range: {
+          end: {
+            character: 59,
+            line: 1,
+          },
+          start: {
+            character: 58,
+            line: 1,
+          },
+        },
+        severity: 1,
+      },
+    ]);
+  });
+
+  test('Semantic errors work with preparser option CYPHER <option> = <value>', () => {
+    const query = `CYPHER runtime = pipelined timeout   = 1000 MATCH (n);
+                   CYPHER planner=cost MATCH (m) RETURN n`;
+
+    expect(getDiagnosticsForQuery({ query })).toEqual([
+      {
+        message:
+          'Query cannot conclude with MATCH (must be a RETURN clause, a FINISH clause, an update clause, a unit subquery call, or a procedure call with no YIELD).',
+        offsets: {
+          end: 53,
+          start: 44,
+        },
+        range: {
+          end: {
+            character: 53,
+            line: 0,
+          },
+          start: {
+            character: 44,
+            line: 0,
+          },
+        },
+        severity: 1,
+      },
+      {
+        message: 'Variable `n` not defined',
+        offsets: {
+          end: 112,
+          start: 111,
+        },
+        range: {
+          end: {
+            character: 57,
+            line: 1,
+          },
+          start: {
+            character: 56,
+            line: 1,
+          },
+        },
+        severity: 1,
+      },
+    ]);
+  });
+
+  test('Semantic errors work with preparser option CYPHER <version>', () => {
+    const query = `CYPHER 25 MATCH (n);
+                   CYPHER 5 MATCH (m) RETURN n`;
+
+    expect(getDiagnosticsForQuery({ query })).toEqual([
+      {
+        message:
+          'Query cannot conclude with MATCH (must be a RETURN clause, a FINISH clause, an update clause, a unit subquery call, or a procedure call with no YIELD).',
+        offsets: {
+          end: 19,
+          start: 10,
+        },
+        range: {
+          end: {
+            character: 19,
+            line: 0,
+          },
+          start: {
+            character: 10,
+            line: 0,
+          },
+        },
+        severity: 1,
+      },
+      {
+        message: 'Variable `n` not defined',
+        offsets: {
+          end: 67,
+          start: 66,
+        },
+        range: {
+          end: {
+            character: 46,
+            line: 1,
+          },
+          start: {
+            character: 45,
+            line: 1,
+          },
+        },
+        severity: 1,
+      },
+    ]);
+  });
+
   test('Semantic errors work when we also have preparser options', () => {
     const query = `EXPLAIN MATCH (n);
                    PROFILE MATCH (m) RETURN n`;

From dfcad4c3bbfda7e18d8d75e4976f40f77273c9b7 Mon Sep 17 00:00:00 2001
From: Isak <isak.nilsson@neo4j.com>
Date: Thu, 28 Nov 2024 14:45:11 +0100
Subject: [PATCH 02/12] fix test/lexer file that broke when adding CYPHER token

---
 packages/language-support/src/lexerSymbols.ts                   | 1 +
 .../src/tests/syntaxValidation/syntacticValidation.test.ts      | 2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/packages/language-support/src/lexerSymbols.ts b/packages/language-support/src/lexerSymbols.ts
index e26a1760..5745bb6f 100644
--- a/packages/language-support/src/lexerSymbols.ts
+++ b/packages/language-support/src/lexerSymbols.ts
@@ -365,6 +365,7 @@ export const lexerKeywords = [
   // Preparser tokens
   CypherLexer.EXPLAIN,
   CypherLexer.PROFILE,
+  CypherLexer.CYPHER,
 ];
 
 export const lexerConsoleCmds = [
diff --git a/packages/language-support/src/tests/syntaxValidation/syntacticValidation.test.ts b/packages/language-support/src/tests/syntaxValidation/syntacticValidation.test.ts
index 11819416..b707807c 100644
--- a/packages/language-support/src/tests/syntaxValidation/syntacticValidation.test.ts
+++ b/packages/language-support/src/tests/syntaxValidation/syntacticValidation.test.ts
@@ -36,7 +36,7 @@ describe('Syntactic validation spec', () => {
           start: 0,
         },
         message:
-          'Expected any of ALTER, CALL, CREATE, DEALLOCATE, DELETE, DENY, DETACH, DROP, DRYRUN, ENABLE, EXPLAIN, FINISH, FOREACH, GRANT, INSERT, LIMIT, LOAD, MATCH, MERGE, NODETACH, OFFSET, OPTIONAL, ORDER, PROFILE, REALLOCATE, REMOVE, RENAME, RETURN, REVOKE, SET, SHOW, SKIP, START, STOP, TERMINATE, UNWIND, USE, USING or WITH',
+          'Expected any of CYPHER, ALTER, CALL, CREATE, DEALLOCATE, DELETE, DENY, DETACH, DROP, DRYRUN, ENABLE, EXPLAIN, FINISH, FOREACH, GRANT, INSERT, LIMIT, LOAD, MATCH, MERGE, NODETACH, OFFSET, OPTIONAL, ORDER, PROFILE, REALLOCATE, REMOVE, RENAME, RETURN, REVOKE, SET, SHOW, SKIP, START, STOP, TERMINATE, UNWIND, USE, USING or WITH',
         range: {
           end: {
             character: 3,

From c6e7b5d6045048315f4b95e065bad7357dcf93dc Mon Sep 17 00:00:00 2001
From: Isak <isak.nilsson@neo4j.com>
Date: Thu, 28 Nov 2024 14:49:10 +0100
Subject: [PATCH 03/12] fix order of tokens in test

---
 .../src/tests/syntaxValidation/syntacticValidation.test.ts      | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/packages/language-support/src/tests/syntaxValidation/syntacticValidation.test.ts b/packages/language-support/src/tests/syntaxValidation/syntacticValidation.test.ts
index b707807c..b8adc2ac 100644
--- a/packages/language-support/src/tests/syntaxValidation/syntacticValidation.test.ts
+++ b/packages/language-support/src/tests/syntaxValidation/syntacticValidation.test.ts
@@ -36,7 +36,7 @@ describe('Syntactic validation spec', () => {
           start: 0,
         },
         message:
-          'Expected any of CYPHER, ALTER, CALL, CREATE, DEALLOCATE, DELETE, DENY, DETACH, DROP, DRYRUN, ENABLE, EXPLAIN, FINISH, FOREACH, GRANT, INSERT, LIMIT, LOAD, MATCH, MERGE, NODETACH, OFFSET, OPTIONAL, ORDER, PROFILE, REALLOCATE, REMOVE, RENAME, RETURN, REVOKE, SET, SHOW, SKIP, START, STOP, TERMINATE, UNWIND, USE, USING or WITH',
+          'Expected any of ALTER, CALL, CREATE, CYPHER, DEALLOCATE, DELETE, DENY, DETACH, DROP, DRYRUN, ENABLE, EXPLAIN, FINISH, FOREACH, GRANT, INSERT, LIMIT, LOAD, MATCH, MERGE, NODETACH, OFFSET, OPTIONAL, ORDER, PROFILE, REALLOCATE, REMOVE, RENAME, RETURN, REVOKE, SET, SHOW, SKIP, START, STOP, TERMINATE, UNWIND, USE, USING or WITH',
         range: {
           end: {
             character: 3,

From 819fcbcd5a83c11a89a8e609ab00baa5009c4b67 Mon Sep 17 00:00:00 2001
From: Isak <isak.nilsson@neo4j.com>
Date: Wed, 4 Dec 2024 09:23:22 +0100
Subject: [PATCH 04/12] added CYPHER keyword to cypher.json +  test that
 autocomplete works with preparser options

---
 .../autocompletion/patternCompletion.test.ts  | 21 +++++++++++++++++++
 .../vscode-extension/syntaxes/cypher.json     |  2 +-
 2 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/packages/language-support/src/tests/autocompletion/patternCompletion.test.ts b/packages/language-support/src/tests/autocompletion/patternCompletion.test.ts
index f74e7b3e..15648a45 100644
--- a/packages/language-support/src/tests/autocompletion/patternCompletion.test.ts
+++ b/packages/language-support/src/tests/autocompletion/patternCompletion.test.ts
@@ -42,6 +42,27 @@ describe('MATCH auto-completion', () => {
     });
   });
 
+  test('Correctly completes even with preparser options', () => {
+    const query = 'CYPHER 25 runtime=pipelined MATCH (n:P';
+
+    testCompletions({
+      query,
+      dbSchema: { labels: ['Cat', 'Person', 'Dog'] },
+      expected: [{ label: 'Person', kind: CompletionItemKind.TypeParameter }],
+    });
+
+    const query2 = 'CYPHER 25 runtime=pipelined MATCH (n:Person)-[:W';
+
+    testCompletions({
+      query: query2,
+      dbSchema: {
+        labels: ['Cat', 'Person', 'Dog'],
+        relationshipTypes: ['WALKS', 'OWNS'],
+      },
+      expected: [{ label: 'WALKS', kind: CompletionItemKind.TypeParameter }],
+    });
+  });
+
   test("Doesn't complete label before : is entered", () => {
     const query = 'MATCH (n';
 
diff --git a/packages/vscode-extension/syntaxes/cypher.json b/packages/vscode-extension/syntaxes/cypher.json
index fac5103f..23b4910e 100644
--- a/packages/vscode-extension/syntaxes/cypher.json
+++ b/packages/vscode-extension/syntaxes/cypher.json
@@ -38,7 +38,7 @@
           "name": "keyword.operator"
         },
         {
-          "match": "(?i)\\b(ACCESS|ACTIVE|ADMIN|ADMINISTRATOR|ALIAS|ALIASES|ALL|allShortestPaths|ALTER|AND|ANY|ARRAY|AS|ASC|ASCENDING|ASSERT|ASSIGN|AT|AUTH|BINDINGS|BOOL|BOOLEAN|BOOSTED|BOTH|BREAK|BRIEF|BTREE|BUILT|BY|CALL|CASCADE|CASE|CIDR|CHANGE|COLLECT|COMMAND|COMMANDS|COMMIT|COMPOSITE|CONSTRAINT|CONSTRAINTS|CONTAINS|CONTINUE|COPY|COUNT|CREATE|CSV|CONCURRENT|CURRENT|DATA|DATABASE|DATABASES|DATE|DATETIME|DBMS|DEALLOCATE|DEFAULT|DEFINED|DELETE|DENY|DESC|DESCENDING|DESTROY|DETACH|DIFFERENT|DISTINCT|DRIVER|DROP|DRYRUN|DUMP|DURATION|EACH|EDGE|ELEMENT|ELEMENTS|ELSE|ENABLE|ENCRYPTED|END|ENDS|ERROR|EXECUTABLE|EXECUTE|EXIST|EXISTENCE|EXISTS|FAIL|FALSE|FIELDTERMINATOR|FINISH|FLOAT|FOR|FOREACH|FROM|FULLTEXT|FUNCTION|FUNCTIONS|GRANT|GRAPH|GRAPHS|GROUP|GROUPS|HEADERS|HOME|ID|IF|IMMUTABLE|IMPERSONATE|IN|INDEX|INDEXES|INF|INFINITY|INSERT|INT|INTEGER|IS|JOIN|KEY|LABEL|LABELS|LEADING|LIMIT|LIST|LOAD|LOCAL|LOOKUP|MANAGEMENT|MAP|MATCH|MERGE|NAME|NAMES|NAN|NEW|NFC|NFD|NFKC|NFKD|NODE|NODETACH|NODES|NONE|NORMALIZE|NORMALIZED|NOT|NOTHING|NOWAIT|NULL|OF|OFFSET|ON|ONLY|OPTION|OPTIONAL|OPTIONS|OR|ORDER|OUTPUT|PASSWORD|PASSWORDS|PATH|PATHS|PERIODIC|PLAINTEXT|POINT|POPULATED|PRIMARY|PRIMARIES|PRIVILEGE|PRIVILEGES|PROCEDURE|PROCEDURES|PROPERTIES|PROPERTY|PROVIDER|PROVIDERS|RANGE|READ|REALLOCATE|REDUCE|REL|RELATIONSHIP|RELATIONSHIPS|REMOVE|RENAME|REPEATABLE|REPLACE|REPORT|REQUIRE|REQUIRED|RESTRICT|RETURN|REVOKE|ROLE|ROLES|ROW|ROWS|SCAN|SECONDARY|SECONDARIES|SEC|SECOND|SECONDS|SEEK|SERVER|SERVERS|SET|SETTING|SETTINGS|SHORTEST|shortestPath|SHOW|SIGNED|SINGLE|SKIP|START|STARTS|STATUS|STOP|VARCHAR|STRING|SUPPORTED|SUSPENDED|TARGET|TERMINATE|TEXT|THEN|TIME|TIMESTAMP|TIMEZONE|TO|TOPOLOGY|TRAILING|TRANSACTION|TRANSACTIONS|TRAVERSE|TRIM|TRUE|TYPE|TYPED|TYPES|UNION|UNIQUE|UNIQUENESS|UNWIND|URL|USE|USER|USERS|USING|VALUE|VECTOR|VERBOSE|VERTEX|WAIT|WHEN|WHERE|WITH|WITHOUT|WRITE|XOR|YIELD|ZONE|ZONED|EXPLAIN|PROFILE)\\b",
+          "match": "(?i)\\b(ACCESS|ACTIVE|ADMIN|ADMINISTRATOR|ALIAS|ALIASES|ALL|allShortestPaths|ALTER|AND|ANY|ARRAY|AS|ASC|ASCENDING|ASSERT|ASSIGN|AT|AUTH|BINDINGS|BOOL|BOOLEAN|BOOSTED|BOTH|BREAK|BRIEF|BTREE|BUILT|BY|CALL|CASCADE|CASE|CIDR|CHANGE|COLLECT|COMMAND|COMMANDS|COMMIT|COMPOSITE|CONSTRAINT|CONSTRAINTS|CONTAINS|CONTINUE|COPY|COUNT|CREATE|CSV|CONCURRENT|CURRENT|DATA|DATABASE|DATABASES|DATE|DATETIME|DBMS|DEALLOCATE|DEFAULT|DEFINED|DELETE|DENY|DESC|DESCENDING|DESTROY|DETACH|DIFFERENT|DISTINCT|DRIVER|DROP|DRYRUN|DUMP|DURATION|EACH|EDGE|ELEMENT|ELEMENTS|ELSE|ENABLE|ENCRYPTED|END|ENDS|ERROR|EXECUTABLE|EXECUTE|EXIST|EXISTENCE|EXISTS|FAIL|FALSE|FIELDTERMINATOR|FINISH|FLOAT|FOR|FOREACH|FROM|FULLTEXT|FUNCTION|FUNCTIONS|GRANT|GRAPH|GRAPHS|GROUP|GROUPS|HEADERS|HOME|ID|IF|IMMUTABLE|IMPERSONATE|IN|INDEX|INDEXES|INF|INFINITY|INSERT|INT|INTEGER|IS|JOIN|KEY|LABEL|LABELS|LEADING|LIMIT|LIST|LOAD|LOCAL|LOOKUP|MANAGEMENT|MAP|MATCH|MERGE|NAME|NAMES|NAN|NEW|NFC|NFD|NFKC|NFKD|NODE|NODETACH|NODES|NONE|NORMALIZE|NORMALIZED|NOT|NOTHING|NOWAIT|NULL|OF|OFFSET|ON|ONLY|OPTION|OPTIONAL|OPTIONS|OR|ORDER|OUTPUT|PASSWORD|PASSWORDS|PATH|PATHS|PERIODIC|PLAINTEXT|POINT|POPULATED|PRIMARY|PRIMARIES|PRIVILEGE|PRIVILEGES|PROCEDURE|PROCEDURES|PROPERTIES|PROPERTY|PROVIDER|PROVIDERS|RANGE|READ|REALLOCATE|REDUCE|REL|RELATIONSHIP|RELATIONSHIPS|REMOVE|RENAME|REPEATABLE|REPLACE|REPORT|REQUIRE|REQUIRED|RESTRICT|RETURN|REVOKE|ROLE|ROLES|ROW|ROWS|SCAN|SECONDARY|SECONDARIES|SEC|SECOND|SECONDS|SEEK|SERVER|SERVERS|SET|SETTING|SETTINGS|SHORTEST|shortestPath|SHOW|SIGNED|SINGLE|SKIP|START|STARTS|STATUS|STOP|VARCHAR|STRING|SUPPORTED|SUSPENDED|TARGET|TERMINATE|TEXT|THEN|TIME|TIMESTAMP|TIMEZONE|TO|TOPOLOGY|TRAILING|TRANSACTION|TRANSACTIONS|TRAVERSE|TRIM|TRUE|TYPE|TYPED|TYPES|UNION|UNIQUE|UNIQUENESS|UNWIND|URL|USE|USER|USERS|USING|VALUE|VECTOR|VERBOSE|VERTEX|WAIT|WHEN|WHERE|WITH|WITHOUT|WRITE|XOR|YIELD|ZONE|ZONED|EXPLAIN|PROFILE|CYPHER)\\b",
           "name": "keyword"
         }
       ]

From 6d736dc3ce1dacb75236278df6dfcc3898bbf0d2 Mon Sep 17 00:00:00 2001
From: Isak <isak.nilsson@neo4j.com>
Date: Wed, 4 Dec 2024 16:11:47 +0100
Subject: [PATCH 05/12] added changeset

---
 .changeset/four-tools-leave.md | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 .changeset/four-tools-leave.md

diff --git a/.changeset/four-tools-leave.md b/.changeset/four-tools-leave.md
new file mode 100644
index 00000000..0a509b1c
--- /dev/null
+++ b/.changeset/four-tools-leave.md
@@ -0,0 +1,5 @@
+---
+'@neo4j-cypher/language-support': patch
+---
+
+Added parsing of CYPHER <version> and CYPHER <optionName> = <value>

From e32360e708a9c7624a763a913c8c4517393e6913 Mon Sep 17 00:00:00 2001
From: Isak <isak.nilsson@neo4j.com>
Date: Wed, 11 Dec 2024 09:27:54 +0100
Subject: [PATCH 06/12] split CYPHER ... into subrules. Added test for CYPHER
 in syntacticValidation.test.ts

---
 .../src/antlr-grammar/CypherPreParser.g4              | 11 ++++++++++-
 .../syntaxValidation/syntacticValidation.test.ts      |  1 +
 2 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/packages/language-support/src/antlr-grammar/CypherPreParser.g4 b/packages/language-support/src/antlr-grammar/CypherPreParser.g4
index 2a1b34ba..58d3b19e 100644
--- a/packages/language-support/src/antlr-grammar/CypherPreParser.g4
+++ b/packages/language-support/src/antlr-grammar/CypherPreParser.g4
@@ -8,4 +8,13 @@ preparsedStatement:
    preparserOption? statement;
 
 preparserOption:
-   EXPLAIN | PROFILE | CYPHER (UNSIGNED_DECIMAL_INTEGER | IDENTIFIER EQ (IDENTIFIER | numberLiteral))*;
\ No newline at end of file
+   EXPLAIN | PROFILE | cypherOptions;
+
+cypherOptions:
+   CYPHER (cypherVersion | cypherOption)*;
+
+cypherOption:
+   IDENTIFIER EQ (IDENTIFIER | numberLiteral);
+
+cypherVersion:
+   UNSIGNED_DECIMAL_INTEGER;
\ No newline at end of file
diff --git a/packages/language-support/src/tests/syntaxValidation/syntacticValidation.test.ts b/packages/language-support/src/tests/syntaxValidation/syntacticValidation.test.ts
index b8adc2ac..1a2e3554 100644
--- a/packages/language-support/src/tests/syntaxValidation/syntacticValidation.test.ts
+++ b/packages/language-support/src/tests/syntaxValidation/syntacticValidation.test.ts
@@ -1046,6 +1046,7 @@ describe('Syntactic validation spec', () => {
 
   test.each([
     `MATCH (n:Test1) RETURN n.profile`,
+    `MATCH (n:MyLabel) RETURN n.CYPHER`,
     `CREATE (n:Test1 {explain: 'Explain'});`,
     `RETURN { clear: 'Clear', params: 'params', history: 'history'}`,
   ])(

From 8580ba383368650e3dd0dd74956b585ac78f9cf2 Mon Sep 17 00:00:00 2001
From: Isak <isak.nilsson@neo4j.com>
Date: Wed, 11 Dec 2024 14:53:00 +0100
Subject: [PATCH 07/12] changed so keywords are their own rule used in
 cmdparser

---
 packages/language-support/src/antlr-grammar/CypherCmdParser.g4 | 2 +-
 packages/language-support/src/antlr-grammar/CypherPreParser.g4 | 3 +++
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/packages/language-support/src/antlr-grammar/CypherCmdParser.g4 b/packages/language-support/src/antlr-grammar/CypherCmdParser.g4
index 2a51346c..0055e376 100644
--- a/packages/language-support/src/antlr-grammar/CypherCmdParser.g4
+++ b/packages/language-support/src/antlr-grammar/CypherCmdParser.g4
@@ -53,7 +53,7 @@ serverCompletionRule: SERVER;
 
 // This rule overrides the identifiers adding EXPLAIN, PROFILE, etc
 unescapedLabelSymbolicNameString: 
-    preparserOption 
+    preparserKeyword 
     | HISTORY
     | CLEAR
     | PARAM
diff --git a/packages/language-support/src/antlr-grammar/CypherPreParser.g4 b/packages/language-support/src/antlr-grammar/CypherPreParser.g4
index 58d3b19e..f83adca4 100644
--- a/packages/language-support/src/antlr-grammar/CypherPreParser.g4
+++ b/packages/language-support/src/antlr-grammar/CypherPreParser.g4
@@ -7,6 +7,9 @@ options { tokenVocab = CypherPreLexer; }
 preparsedStatement:
    preparserOption? statement;
 
+preparserKeyword:
+   EXPLAIN | PROFILE | CYPHER; 
+
 preparserOption:
    EXPLAIN | PROFILE | cypherOptions;
 

From a9fafc242009906a5b35508023e25f98cfcaa0e5 Mon Sep 17 00:00:00 2001
From: Isak <isak.nilsson@neo4j.com>
Date: Thu, 12 Dec 2024 10:00:19 +0100
Subject: [PATCH 08/12] Fixed preparser-file not allowing both analysis-keyword
 (PROFILE/EXPLAIN) and CYPHER-option. Adjusted cypherOptions-definition to
 require version first (like in db)

---
 .../src/antlr-grammar/CypherPreParser.g4               | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/packages/language-support/src/antlr-grammar/CypherPreParser.g4 b/packages/language-support/src/antlr-grammar/CypherPreParser.g4
index f83adca4..c37da088 100644
--- a/packages/language-support/src/antlr-grammar/CypherPreParser.g4
+++ b/packages/language-support/src/antlr-grammar/CypherPreParser.g4
@@ -5,16 +5,16 @@ import Cypher5Parser;
 options { tokenVocab = CypherPreLexer; }
 
 preparsedStatement:
-   preparserOption? statement;
+   (analysisKeyword cypherOptions | cypherOptions analysisKeyword)? statement;
 
 preparserKeyword:
-   EXPLAIN | PROFILE | CYPHER; 
+   analysisKeyword | CYPHER; 
 
-preparserOption:
-   EXPLAIN | PROFILE | cypherOptions;
+analysisKeyword:
+   EXPLAIN | PROFILE;
 
 cypherOptions:
-   CYPHER (cypherVersion | cypherOption)*;
+   CYPHER cypherVersion? cypherOption*;
 
 cypherOption:
    IDENTIFIER EQ (IDENTIFIER | numberLiteral);

From 7d9289788962ebfd57e98da2921be7a73aad390c Mon Sep 17 00:00:00 2001
From: Isak <isak.nilsson@neo4j.com>
Date: Thu, 12 Dec 2024 11:38:24 +0100
Subject: [PATCH 09/12] re-colored setting=value

---
 .../src/antlr-grammar/CypherPreParser.g4            |  8 +++++++-
 packages/language-support/src/lexerSymbols.ts       |  1 +
 .../src/syntaxColouring/syntaxColouring.ts          | 13 ++++++++++++-
 3 files changed, 20 insertions(+), 2 deletions(-)

diff --git a/packages/language-support/src/antlr-grammar/CypherPreParser.g4 b/packages/language-support/src/antlr-grammar/CypherPreParser.g4
index c37da088..87779e85 100644
--- a/packages/language-support/src/antlr-grammar/CypherPreParser.g4
+++ b/packages/language-support/src/antlr-grammar/CypherPreParser.g4
@@ -17,7 +17,13 @@ cypherOptions:
    CYPHER cypherVersion? cypherOption*;
 
 cypherOption:
-   IDENTIFIER EQ (IDENTIFIER | numberLiteral);
+   cypherOptionName EQ cypherOptionValue;
+
+cypherOptionValue:
+   (IDENTIFIER | numberLiteral);
+
+cypherOptionName:
+   IDENTIFIER;
 
 cypherVersion:
    UNSIGNED_DECIMAL_INTEGER;
\ No newline at end of file
diff --git a/packages/language-support/src/lexerSymbols.ts b/packages/language-support/src/lexerSymbols.ts
index 5745bb6f..88701298 100644
--- a/packages/language-support/src/lexerSymbols.ts
+++ b/packages/language-support/src/lexerSymbols.ts
@@ -23,6 +23,7 @@ export enum CypherTokenType {
   punctuation = 'punctuation',
   none = 'none',
   consoleCommand = 'consoleCommand',
+  settingValue = 'settingValue',
 }
 
 export const lexerOperators = [
diff --git a/packages/language-support/src/syntaxColouring/syntaxColouring.ts b/packages/language-support/src/syntaxColouring/syntaxColouring.ts
index 8051cd6b..b92106fe 100644
--- a/packages/language-support/src/syntaxColouring/syntaxColouring.ts
+++ b/packages/language-support/src/syntaxColouring/syntaxColouring.ts
@@ -4,6 +4,8 @@ import {
   ArrowLineContext,
   BooleanLiteralContext,
   ConsoleCommandContext,
+  CypherOptionNameContext,
+  CypherOptionValueContext,
   FunctionNameContext,
   KeywordLiteralContext,
   LabelNameContext,
@@ -74,6 +76,7 @@ export function mapCypherToSemanticTokenIndex(
     [CypherTokenType.paramDollar]: SemanticTokenTypes.namespace,
     [CypherTokenType.paramValue]: SemanticTokenTypes.parameter,
     [CypherTokenType.property]: SemanticTokenTypes.property,
+    [CypherTokenType.settingValue]: SemanticTokenTypes.enumMember,
     [CypherTokenType.label]: SemanticTokenTypes.type,
     [CypherTokenType.variable]: SemanticTokenTypes.variable,
     [CypherTokenType.symbolicName]: SemanticTokenTypes.variable,
@@ -110,6 +113,14 @@ class SyntaxHighlighter extends CypherParserListener {
     }
   }
 
+  exitCypherOptionValue = (ctx: CypherOptionValueContext) => {
+    this.addToken(ctx.start, CypherTokenType.settingValue, ctx.getText());
+  };
+
+  exitCypherOptionName = (ctx: CypherOptionNameContext) => {
+    this.addToken(ctx.start, CypherTokenType.property, ctx.getText());
+  };
+
   exitLabelName = (ctx: LabelNameContext) => {
     this.addToken(ctx.start, CypherTokenType.label, ctx.getText());
   };
@@ -338,7 +349,7 @@ export function applySyntaxColouring(
   /* Get a second pass at the colouring correcting the colours
      using structural information from the parsing tree
   
-     This allows to correclty colour things that are
+     This allows to correctly colour things that are
      recognized as keywords by the lexer in positions
      where they are not keywords (e.g. MATCH (MATCH: MATCH))
   */

From a38f1db00d554022f62b45bc43c85c78101a9ea7 Mon Sep 17 00:00:00 2001
From: Isak <isak.nilsson@neo4j.com>
Date: Mon, 16 Dec 2024 17:01:47 +0100
Subject: [PATCH 10/12] Switched colouring of preparser key, and added missing
 (new) values to constants.ts objects

---
 packages/language-support/src/lexerSymbols.ts                 | 1 +
 .../language-support/src/syntaxColouring/syntaxColouring.ts   | 3 ++-
 packages/react-codemirror/src/lang-cypher/constants.ts        | 4 ++++
 3 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/packages/language-support/src/lexerSymbols.ts b/packages/language-support/src/lexerSymbols.ts
index 88701298..8f9b58d2 100644
--- a/packages/language-support/src/lexerSymbols.ts
+++ b/packages/language-support/src/lexerSymbols.ts
@@ -24,6 +24,7 @@ export enum CypherTokenType {
   none = 'none',
   consoleCommand = 'consoleCommand',
   settingValue = 'settingValue',
+  setting = 'setting',
 }
 
 export const lexerOperators = [
diff --git a/packages/language-support/src/syntaxColouring/syntaxColouring.ts b/packages/language-support/src/syntaxColouring/syntaxColouring.ts
index b92106fe..ceec805d 100644
--- a/packages/language-support/src/syntaxColouring/syntaxColouring.ts
+++ b/packages/language-support/src/syntaxColouring/syntaxColouring.ts
@@ -76,6 +76,7 @@ export function mapCypherToSemanticTokenIndex(
     [CypherTokenType.paramDollar]: SemanticTokenTypes.namespace,
     [CypherTokenType.paramValue]: SemanticTokenTypes.parameter,
     [CypherTokenType.property]: SemanticTokenTypes.property,
+    [CypherTokenType.setting]: SemanticTokenTypes.enum,
     [CypherTokenType.settingValue]: SemanticTokenTypes.enumMember,
     [CypherTokenType.label]: SemanticTokenTypes.type,
     [CypherTokenType.variable]: SemanticTokenTypes.variable,
@@ -118,7 +119,7 @@ class SyntaxHighlighter extends CypherParserListener {
   };
 
   exitCypherOptionName = (ctx: CypherOptionNameContext) => {
-    this.addToken(ctx.start, CypherTokenType.property, ctx.getText());
+    this.addToken(ctx.start, CypherTokenType.setting, ctx.getText());
   };
 
   exitLabelName = (ctx: LabelNameContext) => {
diff --git a/packages/react-codemirror/src/lang-cypher/constants.ts b/packages/react-codemirror/src/lang-cypher/constants.ts
index c9d20bdf..de9618a6 100644
--- a/packages/react-codemirror/src/lang-cypher/constants.ts
+++ b/packages/react-codemirror/src/lang-cypher/constants.ts
@@ -40,6 +40,8 @@ export const cypherTokenTypeToNode = (facet: Facet<unknown>) => ({
   relationship: NodeType.define({ id: 26, name: 'label' }),
   boolean: NodeType.define({ id: 27, name: 'booleanLiteral' }),
   number: NodeType.define({ id: 28, name: 'numberLiteral' }),
+  setting: NodeType.define({ id: 29, name: 'setting' }),
+  settingValue: NodeType.define({ id: 30, name: 'settingValue' }),
 });
 
 export type PrismSpecificTokenType =
@@ -78,6 +80,8 @@ export const tokenTypeToStyleTag: Record<HighlightedCypherTokenTypes, Tag> = {
   punctuation: tags.punctuation,
   separator: tags.separator,
   consoleCommand: tags.macroName,
+  setting: tags.attributeName,
+  settingValue: tags.attributeValue,
 };
 
 export const parserAdapterNodeSet = (nodes: Record<string, NodeType>) =>

From b13fcae24df9a416e8291331e7909be933aca9d4 Mon Sep 17 00:00:00 2001
From: Isak <isak.nilsson@neo4j.com>
Date: Tue, 17 Dec 2024 09:49:00 +0100
Subject: [PATCH 11/12] fixed preparser-options (again) and added colouring
 tests

---
 .../src/antlr-grammar/CypherPreParser.g4      |   2 +-
 .../tests/syntaxColouring/preparser.test.ts   | 171 ++++++++++++++++++
 2 files changed, 172 insertions(+), 1 deletion(-)

diff --git a/packages/language-support/src/antlr-grammar/CypherPreParser.g4 b/packages/language-support/src/antlr-grammar/CypherPreParser.g4
index 87779e85..e2b74bf7 100644
--- a/packages/language-support/src/antlr-grammar/CypherPreParser.g4
+++ b/packages/language-support/src/antlr-grammar/CypherPreParser.g4
@@ -5,7 +5,7 @@ import Cypher5Parser;
 options { tokenVocab = CypherPreLexer; }
 
 preparsedStatement:
-   (analysisKeyword cypherOptions | cypherOptions analysisKeyword)? statement;
+   (analysisKeyword? cypherOptions? | cypherOptions? analysisKeyword?) statement;
 
 preparserKeyword:
    analysisKeyword | CYPHER; 
diff --git a/packages/language-support/src/tests/syntaxColouring/preparser.test.ts b/packages/language-support/src/tests/syntaxColouring/preparser.test.ts
index c8a1b00d..16e5170e 100644
--- a/packages/language-support/src/tests/syntaxColouring/preparser.test.ts
+++ b/packages/language-support/src/tests/syntaxColouring/preparser.test.ts
@@ -1,6 +1,177 @@
 import { applySyntaxColouring } from '../../syntaxColouring/syntaxColouring';
 
 describe('Preparser syntax colouring', () => {
+  test('Correctly colours cypher versions', () => {
+    const query = 'CYPHER 25 MATCH (m) RETURN m';
+    expect(applySyntaxColouring(query)).toEqual([
+      {
+        bracketInfo: undefined,
+        length: 6,
+        position: {
+          line: 0,
+          startCharacter: 0,
+          startOffset: 0,
+        },
+        token: 'CYPHER',
+        tokenType: 'keyword',
+      },
+      {
+        bracketInfo: undefined,
+        length: 2,
+        position: {
+          line: 0,
+          startCharacter: 7,
+          startOffset: 7,
+        },
+        token: '25',
+        tokenType: 'numberLiteral',
+      },
+      {
+        bracketInfo: undefined,
+        length: 5,
+        position: {
+          line: 0,
+          startCharacter: 10,
+          startOffset: 10,
+        },
+        token: 'MATCH',
+        tokenType: 'keyword',
+      },
+      {
+        bracketInfo: {
+          bracketLevel: 0,
+          bracketType: 'parenthesis',
+        },
+        length: 1,
+        position: {
+          line: 0,
+          startCharacter: 16,
+          startOffset: 16,
+        },
+        token: '(',
+        tokenType: 'bracket',
+      },
+      {
+        bracketInfo: undefined,
+        length: 1,
+        position: {
+          line: 0,
+          startCharacter: 17,
+          startOffset: 17,
+        },
+        token: 'm',
+        tokenType: 'variable',
+      },
+      {
+        bracketInfo: {
+          bracketLevel: 0,
+          bracketType: 'parenthesis',
+        },
+        length: 1,
+        position: {
+          line: 0,
+          startCharacter: 18,
+          startOffset: 18,
+        },
+        token: ')',
+        tokenType: 'bracket',
+      },
+      {
+        bracketInfo: undefined,
+        length: 6,
+        position: {
+          line: 0,
+          startCharacter: 20,
+          startOffset: 20,
+        },
+        token: 'RETURN',
+        tokenType: 'keyword',
+      },
+      {
+        bracketInfo: undefined,
+        length: 1,
+        position: {
+          line: 0,
+          startCharacter: 27,
+          startOffset: 27,
+        },
+        token: 'm',
+        tokenType: 'variable',
+      },
+    ]);
+  });
+  test('Correctly colours CYPHER <setting> = <setting-value> options', () => {
+    const query = 'CYPHER runtime = slotted RETURN ""';
+    expect(applySyntaxColouring(query)).toEqual([
+      {
+        bracketInfo: undefined,
+        length: 6,
+        position: {
+          line: 0,
+          startCharacter: 0,
+          startOffset: 0,
+        },
+        token: 'CYPHER',
+        tokenType: 'keyword',
+      },
+      {
+        bracketInfo: undefined,
+        length: 7,
+        position: {
+          line: 0,
+          startCharacter: 7,
+          startOffset: 7,
+        },
+        token: 'runtime',
+        tokenType: 'setting',
+      },
+      {
+        bracketInfo: undefined,
+        length: 1,
+        position: {
+          line: 0,
+          startCharacter: 15,
+          startOffset: 15,
+        },
+        token: '=',
+        tokenType: 'operator',
+      },
+      {
+        bracketInfo: undefined,
+        length: 7,
+        position: {
+          line: 0,
+          startCharacter: 17,
+          startOffset: 17,
+        },
+        token: 'slotted',
+        tokenType: 'settingValue',
+      },
+      {
+        bracketInfo: undefined,
+        length: 6,
+        position: {
+          line: 0,
+          startCharacter: 25,
+          startOffset: 25,
+        },
+        token: 'RETURN',
+        tokenType: 'keyword',
+      },
+      {
+        bracketInfo: undefined,
+        length: 2,
+        position: {
+          line: 0,
+          startCharacter: 32,
+          startOffset: 32,
+        },
+        token: '""',
+        tokenType: 'stringLiteral',
+      },
+    ]);
+  });
+
   test('Correctly colours PROFILE', () => {
     const query = 'PROFILE MATCH (n) RETURN n';
 

From 4ff7cf076929bb9583d98510d6f05b8ad9a9e908 Mon Sep 17 00:00:00 2001
From: Isak <isak.nilsson@neo4j.com>
Date: Tue, 17 Dec 2024 16:41:45 +0100
Subject: [PATCH 12/12] aligned preparser with actual preparser

---
 .../language-support/src/antlr-grammar/CypherPreParser.g4 | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/packages/language-support/src/antlr-grammar/CypherPreParser.g4 b/packages/language-support/src/antlr-grammar/CypherPreParser.g4
index e2b74bf7..b77e6dfd 100644
--- a/packages/language-support/src/antlr-grammar/CypherPreParser.g4
+++ b/packages/language-support/src/antlr-grammar/CypherPreParser.g4
@@ -5,13 +5,13 @@ import Cypher5Parser;
 options { tokenVocab = CypherPreLexer; }
 
 preparsedStatement:
-   (analysisKeyword? cypherOptions? | cypherOptions? analysisKeyword?) statement;
+   preparserOption* statement;
 
 preparserKeyword:
-   analysisKeyword | CYPHER; 
+   EXPLAIN | PROFILE | CYPHER; 
 
-analysisKeyword:
-   EXPLAIN | PROFILE;
+preparserOption:
+   EXPLAIN | PROFILE | cypherOptions;
 
 cypherOptions:
    CYPHER cypherVersion? cypherOption*;