feat(queries): add multi-line queries support

Features some refactoring to support this feature, to remove the
dependency of compiling a complex reg-exp I preferred keeping the
output of the findQueries function untransformed, so we can use that
string to find and replace the query with the serialized query.

It adds a boolean to check if we are capturing a multi-line query or not, and
some logic to complete the feature.

I've tested both multi-line and single-line queries to ensure that I did
not break basic functionality.

Author: yoyossef

apps/plugin/src/app/constants.ts

@@ -6,8 +6,8 @@ export const NOTICE_TIMEOUT = 5000;
 export const DEFAULT_CANVAS_FILE_NAME = 'Canvas.md';
 export const MARKDOWN_FILE_EXTENSION = 'md';
 
-export const QUERY_FLAG_OPEN = `<!-- QueryToSerialize: `;
-export const QUERY_FLAG_CLOSE = ` -->`;
+export const QUERY_FLAG_OPEN = `<!-- QueryToSerialize:`;
+export const QUERY_FLAG_CLOSE = `-->`;
 
 // Query and serialized query structure: <!-- SerializedQuery: QUERY -->\n<markdown>\n<!-- SerializedQuery END -->
 export const SERIALIZED_QUERY_START = `<!-- SerializedQuery: `;

apps/plugin/src/app/plugin.ts

@@ -21,7 +21,6 @@ import { DataviewApi } from 'obsidian-dataview/lib/api/plugin-api';
 import { add, isBefore } from 'date-fns';
 import { serializeQuery } from './utils/serialize-query.fn';
 import { findQueries } from './utils/find-queries.fn';
-import { escapeRegExp } from './utils/escape-reg-exp.fn';
 import { isTableQuery } from './utils/is-table-query.fn';
 
 export class DataviewSerializerPlugin extends Plugin {
@@ -227,7 +226,7 @@ export class DataviewSerializerPlugin extends Plugin {
         //log(`Processing query: [${foundQuery}] in file [${file.path}]`, 'debug');
         // Reference: https://github.com/IdreesInc/Waypoint/blob/master/main.ts
         const serializedQuery = await serializeQuery({
-          query: foundQuery,
+          query: foundQuery.trim(),
           originFile: file.path,
           // eslint-disable-next-line  @typescript-eslint/no-non-null-assertion
           dataviewApi: this.dataviewApi!,
@@ -236,24 +235,18 @@ export class DataviewSerializerPlugin extends Plugin {
         //log('Serialized query: ', 'debug', serializedQuery);
 
         if ('' !== serializedQuery) {
-          const escapedQuery = escapeRegExp(foundQuery);
-
-          const queryToSerializeRegex = new RegExp(
-            `${QUERY_FLAG_OPEN}${escapedQuery}.*${QUERY_FLAG_CLOSE}\\n`,
-            'gm'
-          );
-
           let queryAndSerializedQuery = '';
           if (isTableQuery(foundQuery)) {
-            queryAndSerializedQuery = `${QUERY_FLAG_OPEN}${foundQuery}${QUERY_FLAG_CLOSE}\n${SERIALIZED_QUERY_START}${foundQuery}${QUERY_FLAG_CLOSE}\n\n${serializedQuery}${SERIALIZED_QUERY_END}\n`;
+            queryAndSerializedQuery = `${QUERY_FLAG_OPEN}${foundQuery}${QUERY_FLAG_CLOSE}\n${SERIALIZED_QUERY_START}${QUERY_FLAG_CLOSE}\n\n${serializedQuery}${SERIALIZED_QUERY_END}\n`;
           } else {
-            queryAndSerializedQuery = `${QUERY_FLAG_OPEN}${foundQuery}${QUERY_FLAG_CLOSE}\n${SERIALIZED_QUERY_START}${foundQuery}${QUERY_FLAG_CLOSE}\n${serializedQuery}${SERIALIZED_QUERY_END}\n`;
+            queryAndSerializedQuery = `${QUERY_FLAG_OPEN}${foundQuery}${QUERY_FLAG_CLOSE}\n${SERIALIZED_QUERY_START}${QUERY_FLAG_CLOSE}\n${serializedQuery}${SERIALIZED_QUERY_END}\n`;
           }
           //log('Query to serialize regex: ', 'debug', queryToSerializeRegex);
 
           //log('Updated text before: ', 'debug', updatedText);
+          const searchedString = `${QUERY_FLAG_OPEN}${foundQuery}${QUERY_FLAG_CLOSE}`;
           updatedText = updatedText.replace(
-            queryToSerializeRegex,
+            searchedString,
             queryAndSerializedQuery
           );
           //log('Updated text after: ', 'debug', updatedText);

apps/plugin/src/app/utils/escape-reg-exp.fn.ts

@@ -7,25 +7,45 @@ import { isSupportedQueryType } from './is-supported-query-type.fn';
  */
 export const findQueries = (text: string): string[] => {
   const retVal: string[] = [];
+  let isCapturing = false;
+  let foundQuery = '';
 
   const lines: string[] = text.split('\n');
   for (const line of lines) {
-    const trimmedLine = line.trim();
-    if (
-      trimmedLine.startsWith(QUERY_FLAG_OPEN) &&
-      trimmedLine.endsWith(QUERY_FLAG_CLOSE)
-    ) {
-      let foundQuery = trimmedLine.replace(QUERY_FLAG_OPEN, '');
-      foundQuery = foundQuery.replace(QUERY_FLAG_CLOSE, '');
-      foundQuery = foundQuery.trim();
+    if (isCapturing) {
+      if (line.includes(QUERY_FLAG_CLOSE)) {
+        const endIndex = line.indexOf(QUERY_FLAG_CLOSE);
+        foundQuery += `${line.substring(0, endIndex)}`;
 
-      // Ignore duplicates
-      // Make sure it is a supported query
-      if (!retVal.includes(foundQuery) && isSupportedQueryType(foundQuery)) {
-        retVal.push(foundQuery);
+        if (!retVal.includes(foundQuery) && isSupportedQueryType(foundQuery)) {
+          retVal.push(foundQuery);
+          isCapturing = false;
+          foundQuery = '';
+        }
+      } else {
+        // Accumulate the current line if capturing multi-line query
+        foundQuery += `${line}\n`;
       }
     }
-  }
+    // Detect QUERY FLAG OPEN and single line comments
+    if (!isCapturing && line.includes(QUERY_FLAG_OPEN)) {
+      isCapturing = true;
+      const startIndex = line.indexOf(QUERY_FLAG_OPEN) + QUERY_FLAG_OPEN.length;
+      foundQuery = line.substring(startIndex) + '\n';
+      if (line.includes(QUERY_FLAG_CLOSE)) {
+        const endIndex = line.indexOf(QUERY_FLAG_CLOSE);
+        foundQuery = line.substring(startIndex, endIndex);
 
+        // Ignore duplicates
+        // Make sure it is a supported query
+        if (!retVal.includes(foundQuery) && isSupportedQueryType(foundQuery)) {
+          retVal.push(foundQuery);
+          isCapturing = false;
+          foundQuery = '';
+        }
+      }
+    }
+  }
+  console.log(retVal);
   return retVal;
 };

apps/plugin/src/app/utils/find-queries.fn.ts

@@ -7,7 +7,7 @@ import { SUPPORTED_QUERY_TYPES } from '../constants';
 export const isSupportedQueryType = (query: string): boolean => {
   let retVal = false;
 
-  const queryLower = query.toLowerCase();
+  const queryLower = query.trim().toLowerCase();
 
   for (const queryType of SUPPORTED_QUERY_TYPES) {
     if (queryLower.startsWith(queryType)) {

apps/plugin/src/app/utils/is-supported-query-type.fn.ts

@@ -7,7 +7,7 @@ import { QUERY_TYPE_TABLE } from '../constants';
 export const isTableQuery = (query: string): boolean => {
   let retVal = false;
 
-  const queryLower = query.toLowerCase();
+  const queryLower = query.trim().toLowerCase();
 
   if (queryLower.startsWith(QUERY_TYPE_TABLE)) {
     retVal = true;