feat: add alignIndent option

Author: gajus

.README/rules/format.md

@@ -12,6 +12,7 @@ The first option is an object with the following configuration.
 
 |configuration|format|default|description|
 |---|---|---|---|
+|`padIndent`|boolean|`false`|Aligns indentation with either the start of the `TemplateLiteral` or `TaggedTemplateExpression` node.|
 |`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.|

src/rules/format.test.ts

@@ -33,6 +33,33 @@ export default createRuleTester(
           \`
         `,
       },
+      {
+        code: multiline`
+          sql\`
+          SELECT
+            1
+          \`
+        `,
+        errors: [
+          {
+            messageId: 'format',
+          },
+        ],
+        options: [
+          {
+            alignIndent: true,
+          },
+          {
+            spaces: 4,
+          },
+        ],
+        output: multiline`
+          sql\`
+              SELECT
+                  1
+          \`
+        `,
+      },
       {
         code: multiline`
           sql.type({ id: z.number() })\`

src/rules/format.ts

@@ -1,13 +1,15 @@
 import { createRule } from '../factories/createRule';
 import { dropBaseIndent } from '../utilities/dropBaseIndent';
 import { isSqlQuery } from '../utilities/isSqlQuery';
+import { AST_NODE_TYPES } from '@typescript-eslint/utils';
 import { generate } from 'astring';
 import { format } from 'pg-formatter';
 
 type MessageIds = 'format';
 
 type Options = [
   {
+    alignIndent?: boolean;
     ignoreBaseIndent?: boolean;
     ignoreExpressions?: boolean;
     ignoreInline?: boolean;
@@ -27,13 +29,23 @@ type Options = [
   },
 ];
 
+const padIndent = (subject: string, spaces: number) => {
+  return subject
+    .split('\n')
+    .map((line) => {
+      return line.length > 0 ? ' '.repeat(spaces) + line : line;
+    })
+    .join('\n');
+};
+
 export const rule = createRule<Options, MessageIds>({
   create: (context) => {
     // @ts-expect-error I am ont clear how to type this
     const placeholderRule = context.settings?.sql?.placeholderRule;
 
     const pluginOptions = context.options?.[0] || {};
 
+    const alignIndent = pluginOptions.alignIndent === true;
     const sqlTag = pluginOptions.sqlTag ?? 'sql';
     const ignoreExpressions = pluginOptions.ignoreExpressions === true;
     const ignoreInline = pluginOptions.ignoreInline !== false;
@@ -42,6 +54,8 @@ export const rule = createRule<Options, MessageIds>({
       pluginOptions.ignoreStartWithNewLine !== false;
     const ignoreBaseIndent = pluginOptions.ignoreBaseIndent === true;
 
+    const spaces = context.options?.[1]?.spaces ?? 4;
+
     return {
       TemplateLiteral(node) {
         const tagName =
@@ -54,6 +68,14 @@ export const rule = createRule<Options, MessageIds>({
 
         const sqlTagIsPresent = tagName === sqlTag;
 
+        let indentAnchorOffset = node.loc.start.column;
+
+        if (node.parent.type === AST_NODE_TYPES.TaggedTemplateExpression) {
+          indentAnchorOffset = node.parent.loc.start.column;
+        }
+
+        indentAnchorOffset += spaces;
+
         if (ignoreTagless && !sqlTagIsPresent) {
           return;
         }
@@ -82,7 +104,10 @@ export const rule = createRule<Options, MessageIds>({
           literal = dropBaseIndent(literal);
         }
 
-        let formatted = format(literal, context.options[1]);
+        let formatted = format(literal, {
+          ...context.options[1],
+          spaces,
+        });
 
         if (
           ignoreStartWithNewLine &&
@@ -96,6 +121,10 @@ export const rule = createRule<Options, MessageIds>({
           formatted = formatted.replace(/\n\n$/u, '\n');
         }
 
+        if (alignIndent) {
+          formatted = padIndent(formatted, indentAnchorOffset);
+        }
+
         if (formatted !== literal) {
           context.report({
             fix: (fixer) => {
@@ -130,6 +159,7 @@ export const rule = createRule<Options, MessageIds>({
   },
   defaultOptions: [
     {
+      alignIndent: true,
       ignoreBaseIndent: false,
       ignoreExpressions: false,
       ignoreInline: true,
@@ -162,6 +192,10 @@ export const rule = createRule<Options, MessageIds>({
       {
         additionalProperties: false,
         properties: {
+          alignIndent: {
+            default: false,
+            type: 'boolean',
+          },
           ignoreBaseIndent: {
             default: false,
             type: 'boolean',