Automatically strip out any comments in SQL templates (#60)

* Strip comments from sql template strings

* Added SQL with comments unit tests

src/queries/statements.ts

@@ -1,5 +1,8 @@
 import type { Statement } from '@ronin/compiler';
 
+const MULTILINE_SQL_COMMENTS = /\/\*[\s\S]*?\*\//g;
+const SINGLELINE_SQL_COMMENTS = /--[^\n]*\n/g;
+
 /**
  * Used to track whether SQL queries are run in batches.
  */
@@ -21,7 +24,12 @@ export const getSyntaxProxySQL = (options: {
     const params: Array<unknown> = [];
 
     strings.forEach((string, i) => {
-      text += string;
+      // Remove comments but preserve the newline
+      const processedString = string
+        .replace(MULTILINE_SQL_COMMENTS, '')
+        .replace(SINGLELINE_SQL_COMMENTS, '\n');
+
+      text += processedString;
 
       if (i < values.length) {
         text += `$${i + 1}`;

tests/queries/statements.test.ts

@@ -1,4 +1,4 @@
-import { expect, spyOn, test } from 'bun:test';
+import { describe, expect, spyOn, test } from 'bun:test';
 import { getBatchProxySQL, getSyntaxProxySQL } from '@/src/queries';
 import type { Statement } from '@ronin/compiler';
 import { expectTypeOf } from 'expect-type';
@@ -70,3 +70,47 @@ test('using raw SQL with multiple lines', async () => {
     params: ['elaine'],
   });
 });
+
+describe('using raw SQL with comments', () => {
+  test('--', async () => {
+    let statement: Statement | undefined;
+
+    const sqlProxy = getSyntaxProxySQL({
+      callback: (value) => {
+        statement = value;
+      },
+    });
+
+    const accountHandle = 'elaine';
+    sqlProxy`
+      -- Select all accounts with the given handle:
+      SELECT * FROM accounts WHERE handle = ${accountHandle}
+    `;
+
+    expect(statement).toMatchObject({
+      statement: 'SELECT * FROM accounts WHERE handle = $1',
+      params: ['elaine'],
+    });
+  });
+
+  test('/* ... */', async () => {
+    let statement: Statement | undefined;
+
+    const sqlProxy = getSyntaxProxySQL({
+      callback: (value) => {
+        statement = value;
+      },
+    });
+
+    const accountHandle = 'elaine';
+    sqlProxy`
+      /* Select all accounts with the given handle */
+      SELECT * FROM accounts WHERE handle = ${accountHandle}
+    `;
+
+    expect(statement).toMatchObject({
+      statement: 'SELECT * FROM accounts WHERE handle = $1',
+      params: ['elaine'],
+    });
+  });
+});