Tidy up binary methods in parser, and add tokens to strings prior to …

…AST visualisation
guardian · Oct 29, 2024 · f164387 · f164387
1 parent 62e994f
commit f164387
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 17 deletions.
diff --git a/prosemirror-client/src/cqlInput/editor/debug.ts b/prosemirror-client/src/cqlInput/editor/debug.ts
@@ -1,6 +1,14 @@
 import { Node } from "prosemirror-model";
 import { Mapping } from "prosemirror-transform";
 import { Token } from "../../lang/token";
+import {
+  QueryBinary,
+  QueryContent,
+  QueryField,
+  QueryGroup,
+  QueryList,
+  QueryStr,
+} from "../../lang/ast";
 
 // Debugging and visualisation utilities.
 
@@ -60,7 +68,9 @@ export const getDebugTokenHTML = (tokens: Token[]) => {
       })
       .join("")}
       ${
-        tokens[index + 1]?.start > token.end + 1 && tokens[index + 1]?.tokenType !== "EOF" && token.tokenType !== "EOF"
+        tokens[index + 1]?.start > token.end + 1 &&
+        tokens[index + 1]?.tokenType !== "EOF" &&
+        token.tokenType !== "EOF"
           ? `<div class="CqlDebug__queryBox"><div class="CqlDebug__queryIndex">${
               token.end + 1
             }</div></div>`

diff --git a/prosemirror-client/src/lang/ast.ts b/prosemirror-client/src/lang/ast.ts
@@ -5,19 +5,15 @@ export type QueryList = {
   content: QueryBinary[];
 };
 
-export const createQueryList = (
-  content: QueryList["content"]
-): QueryList => ({
+export const createQueryList = (content: QueryList["content"]): QueryList => ({
   type: "QueryList",
   content,
 });
 
 export type QueryBinary = {
   type: "QueryBinary";
   left: QueryContent;
-  right?: [Token, QueryBinary
-
-  ];
+  right?: [Token, QueryBinary];
 };
 
 export const createQueryBinary = (
@@ -50,11 +46,12 @@ export const createQueryGroup = (
   content,
 });
 
-export type QueryStr = { type: "QueryStr"; searchExpr: string };
+export type QueryStr = { type: "QueryStr"; searchExpr: string; token: Token };
 
-export const createQueryStr = (searchExpr: string): QueryStr => ({
+export const createQueryStr = (token: Token): QueryStr => ({
   type: "QueryStr",
-  searchExpr,
+  searchExpr: token.literal ?? "",
+  token,
 });
 
 export type QueryField = { type: "QueryField"; key: Token; value?: Token };

diff --git a/prosemirror-client/src/lang/parser.spec.ts b/prosemirror-client/src/lang/parser.spec.ts
@@ -117,7 +117,10 @@ describe("parser", () => {
     expect(result).toEqual(
       ok(
         createQueryList([
-          createQueryBinary(createQueryContent(createQueryStr("a")), undefined),
+          createQueryBinary(
+            createQueryContent(createQueryStr(quotedStringToken("a"))),
+            undefined
+          ),
           createQueryBinary(
             createQueryContent(
               createQueryField(queryFieldKeyToken("", 2), undefined)

diff --git a/prosemirror-client/src/lang/parser.ts b/prosemirror-client/src/lang/parser.ts
@@ -35,7 +35,7 @@ export class Parser {
     try {
       const queries: QueryBinary[] = [];
       while (this.peek().tokenType !== TokenType.EOF) {
-        queries.push(this.query());
+        queries.push(this.queryBinary());
       }
 
       return ok(createQueryList(queries));
@@ -50,16 +50,13 @@ export class Parser {
   private startOfQueryField = [TokenType.CHIP_KEY];
   private startOfQueryValue = [TokenType.CHIP_VALUE];
 
-  private query(): QueryBinary {
+  private queryBinary(): QueryBinary {
     if (this.startOfQueryValue.some((i) => i === this.peek().tokenType))
       throw new ParseError(
         this.peek().start,
         "I found an unexpected ':'. Did you numberend to search for a tag, section or similar, e.g. tag:news? If you would like to add a search phrase containing a ':' character, please surround it in double quotes."
       );
-    else return this.queryBinary();
-  }
 
-  private queryBinary(): QueryBinary {
     const left = this.queryContent();
 
     switch (this.peek().tokenType) {
@@ -142,7 +139,7 @@ export class Parser {
   private queryStr(): QueryStr {
     const token = this.consume(TokenType.STRING, "Expected a string");
 
-    return createQueryStr(token.literal ?? "");
+    return createQueryStr(token);
   }
 
   private queryField(): QueryField {