Add matchIndentation option

[karlhorky]

Closes https://github.com/gajus/eslint-plugin-sql/issues/9

[karlhorky]

@gajus any thoughts on this one?

[gajus]

Maybe. Needs tests. Too early to give feedback.

[karlhorky]

Hmm... looking at https://github.com/gajus/eslint-plugin-sql/blob/master/test/rules/assertions/format.js it seems like there is no plumbing for the template string code around the SQL.

Could you offer me some guidance as to how you would suggest implementing tests for this feature?

[karlhorky]

Ah looks like there could be some edge cases here with indentation, frigus went and worked through them in his PR here:

https://github.com/frigus02/typescript-sql-tagged-template-plugin/pull/14

Maybe if the AST method isn't working, manually counting the indentation will be required.

[karlhorky]

Another bit of inspiration can probably be found in Prettier's tagged template string indentation:

https://github.com/prettier/prettier/blob/2247ce1aab604bf1b95b3d010c08d48b003286c7/src/language-js/embed.js#L164

[gajus]

I am down to merge this, but it would need pretty thorough tests, just to make sure that we don't introduce hard to debug bugs.

[karlhorky]

Nice, cheers. I may have some time soon to rewrite the implementation, based on the "inspiration" links above.

As for the tests, would you be able to offer any guidance for a method for testing this?

[gajus]

As for the tests, would you be able to offer any guidance for a method for testing this?

If testing integration is hard, then I would just abstract any fragile logic into a utility and test that. Otherwise, leave it without a test.

[devthejo]

Thanks you guys for this great tools and improvements, waiting for this PR merged with impatience ;)

[karlhorky]

@devthejo not sure I'll have time soon to look at this soon, maybe you could contribute to the feature?

[devthejo]

@karlhorky sorry I have not enough time to make tests, but I've refactored a little bit, removing the bug that was adding new line #9, and removing option ignoreStartWithNewLine replacing with adding a new line at start by default, so I have, for example:

sql`
const row = await conn.one(
  sql`
    SELECT
      "user_id" as "userId",
      "device_id" as "deviceId"
    FROM
      "auth_token"
    WHERE
      "auth_token" = ${authToken}
    `
)

If this can be useful for someone I put the code here: format.js

// @flow

import {
  generate,
} from 'astring';
import {
  format,
} from 'pg-formatter';
import isSqlQuery from '../utilities/isSqlQuery';

export default (context) => {
  const placeholderRule = context.settings.sql && context.settings.sql.placeholderRule;

  const pluginOptions = context.options && context.options[0] || {};

  const ignoreExpressions = pluginOptions.ignoreExpressions === true;
  const ignoreInline = pluginOptions.ignoreInline !== false;
  const ignoreTagless = pluginOptions.ignoreTagless !== false;
  const matchIndentation = pluginOptions.matchIndentation !== false;

  const pgFormatterOptions = context.options && context.options[1] || {};

  return {
    TemplateLiteral (node) {
      const sqlTagIsPresent = node.parent.tag && node.parent.tag.name === 'sql';

      if (ignoreTagless && !sqlTagIsPresent) {
        return;
      }

      if (ignoreExpressions && node.quasis.length !== 1) {
        return;
      }

      const magic = '"gajus-eslint-plugin-sql"';

      const literal = node.quasis
        .map((quasi) => {
          return quasi.value.raw;
        })
        .join(magic);

      if (!sqlTagIsPresent && !isSqlQuery(literal, placeholderRule)) {
        return;
      }

      if (ignoreInline && !literal.includes('\n')) {
        return;
      }

      let formatted = format(literal, context.options[1]);

      formatted = formatted.trimStart();

      if (matchIndentation) {
        let firstNodeOnLine = node;

        while (
          firstNodeOnLine.parent &&
          firstNodeOnLine.loc.start.line === firstNodeOnLine.parent.loc.start.line
        ) {
          firstNodeOnLine = firstNodeOnLine.parent;
        }

        const startingColumn = firstNodeOnLine.loc.start.column;
        formatted = formatted.replace(/\n+$/g, '') + '\n';
        const formattedLines = formatted.split('\n');
        formatted = formattedLines
          .map((line) => {
            // Indent each subsequent line based on the spaces option
            const indentSpaces = context.options[1].spaces || 4;

            const indentation = ' '.repeat(startingColumn + indentSpaces);

            return `${indentation}${line}`;
          })
          .join('\n');
      }

      formatted = '\n' + formatted.replace(/^\n+/g, '');

      if (formatted !== literal) {
        context.report({
          fix: (fixer) => {
            let final = formatted;

            const expressionCount = node.expressions.length;
            let index = 0;
            while (index <= expressionCount - 1) {
              final = final.replace(magic, '${' + generate(node.expressions[index]) + '}');
              index++;
            }

            return fixer.replaceText(node, '`' + final + '`');
          },
          message: 'Format the query',
          node,
        });
      }
    },
  };
};

[ssukienn]

Will it be merged?

[gajus]

Would need a rebase, but otherwise happy to accept it.

[vantaboard]

@gajus What happened to this? It looks like you closed it but never did a rebase or a merge.

[karlhorky]

From my side, I didn't find the time to work on it yet. But maybe someone else can take over and (re-)implement in a new PR?

[vantaboard]

Went ahead and did it based off of your code @karlhorky https://github.com/gajus/eslint-plugin-sql/pull/25

[karlhorky]

Amazing, thanks! Would be great to see this merged!

[vantaboard]

What do you think @gajus ?