Fix doubling of new lines and adding indent ignore feature

.README/rules/format.md

@@ -12,6 +12,7 @@ The first option is an object with the following configuration.
 
 |configuration|format|default|description|
 |---|---|---|---|
+|`ignoreBaseIndent`|boolean|`false`|Does not leave base indent before linting.|
 |`ignoreExpressions`|boolean|`false`|Does not format template literals that contain expressions.|
 |`ignoreInline`|boolean|`true`|Does not format queries that are written on a single line.|
 |`ignoreTagless`|boolean|`true`|Does not format queries that are written without using `sql` tag.|

README.md

@@ -106,6 +106,7 @@ The first option is an object with the following configuration.
 
 |configuration|format|default|description|
 |---|---|---|---|
+|`ignoreBaseIndent`|boolean|`false`|Does not leave base indent before linting.|
 |`ignoreExpressions`|boolean|`false`|Does not format template literals that contain expressions.|
 |`ignoreInline`|boolean|`true`|Does not format queries that are written on a single line.|
 |`ignoreTagless`|boolean|`true`|Does not format queries that are written without using `sql` tag.|

package.json

@@ -9,7 +9,8 @@
     "debug": "^4.3.4",
     "lodash": "^4.17.21",
     "pg-formatter": "^2.0.2",
-    "sql-parse": "^0.1.5"
+    "sql-parse": "^0.1.5",
+    "strip-indent": "^3.0.0"
   },
   "description": "SQL linting rules for ESLint.",
   "devDependencies": {

src/rules/format.ts

@@ -1,6 +1,7 @@
 import isSqlQuery from '../utilities/isSqlQuery';
 import { generate } from 'astring';
 import { format } from 'pg-formatter';
+import stripIndent from 'strip-indent';
 
 const create = (context) => {
   const placeholderRule = context.settings?.sql?.placeholderRule;
@@ -11,6 +12,7 @@ const create = (context) => {
   const ignoreInline = pluginOptions.ignoreInline !== false;
   const ignoreTagless = pluginOptions.ignoreTagless !== false;
   const ignoreStartWithNewLine = pluginOptions.ignoreStartWithNewLine !== false;
+  const ignoreBaseIndent = pluginOptions.ignoreBaseIndent === true;
 
   return {
     TemplateLiteral(node) {
@@ -31,7 +33,7 @@ const create = (context) => {
 
       const magic = '"gajus-eslint-plugin-sql"';
 
-      const literal = node.quasis
+      let literal = node.quasis
         .map((quasi) => {
           return quasi.value.raw;
         })
@@ -45,6 +47,10 @@ const create = (context) => {
         return;
       }
 
+      if (ignoreBaseIndent) {
+        literal = stripIndent(literal);
+      }
+
       let formatted = format(literal, context.options[1]);
 
       if (
@@ -77,7 +83,7 @@ const create = (context) => {
                 node.quasis[0].range[0],
                 node.quasis[node.quasis.length - 1].range[1],
               ],
-              '`\n' + final + '`',
+              '`' + (final.startsWith('\n') ? final : '\n' + final) + '`',
             );
           },
           message: 'Format the query',
@@ -101,6 +107,10 @@ export = {
       {
         additionalProperties: false,
         properties: {
+          ignoreBaseIndent: {
+            default: false,
+            type: 'boolean',
+          },
           ignoreExpressions: {
             default: false,
             type: 'boolean',

test/rules/assertions/format.ts

@@ -76,6 +76,21 @@ export default {
       ],
       output: "`\nSELECT\n    ${'foo'}\nFROM\n    ${'bar'}\n`",
     },
+    {
+      code: "    const code = sql`\n    SELECT\n        ${'foo'}\n    FROM\n        ${'bar'}\n`",
+      errors: [
+        {
+          message: 'Format the query',
+        },
+      ],
+      options: [
+        {
+          ignoreBaseIndent: false,
+        },
+      ],
+      output:
+        "    const code = sql`\nSELECT\n    ${'foo'}\nFROM\n    ${'bar'}\n`",
+    },
   ],
   valid: [
     {
@@ -104,5 +119,13 @@ export default {
         },
       ],
     },
+    {
+      code: "    const code = sql`\n    SELECT\n        ${'foo'}\n    FROM\n        ${'bar'}\n`",
+      options: [
+        {
+          ignoreBaseIndent: true,
+        },
+      ],
+    },
   ],
 };