codtracker-js/node_modules/eslint/lib/rules/template-curly-spacing.js

/**
 * @fileoverview Rule to enforce spacing around embedded expressions of template strings
 * @author Toru Nagashima
 * @deprecated in ESLint v8.53.0
 */

'use strict';

//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------

const astUtils = require('./utils/ast-utils');

//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../types').Rule.RuleModule} */
module.exports = {
  meta: {
    deprecated: {
      message: 'Formatting rules are being moved out of ESLint core.',
      url: 'https://eslint.org/blog/2023/10/deprecating-formatting-rules/',
      deprecatedSince: '8.53.0',
      availableUntil: '10.0.0',
      replacedBy: [
        {
          message:
            'ESLint Stylistic now maintains deprecated stylistic core rules.',
          url: 'https://eslint.style/guide/migration',
          plugin: {
            name: '@stylistic/eslint-plugin-js',
            url: 'https://eslint.style/packages/js',
          },
          rule: {
            name: 'template-curly-spacing',
            url: 'https://eslint.style/rules/js/template-curly-spacing',
          },
        },
      ],
    },
    type: 'layout',

    docs: {
      description:
        'Require or disallow spacing around embedded expressions of template strings',
      recommended: false,
      url: 'https://eslint.org/docs/latest/rules/template-curly-spacing',
    },

    fixable: 'whitespace',

    schema: [{ enum: ['always', 'never'] }],
    messages: {
      expectedBefore: "Expected space(s) before '}'.",
      expectedAfter: "Expected space(s) after '${'.",
      unexpectedBefore: "Unexpected space(s) before '}'.",
      unexpectedAfter: "Unexpected space(s) after '${'.",
    },
  },

  create(context) {
    const sourceCode = context.sourceCode;
    const always = context.options[0] === 'always';

    /**
     * Checks spacing before `}` of a given token.
     * @param {Token} token A token to check. This is a Template token.
     * @returns {void}
     */
    function checkSpacingBefore(token) {
      if (!token.value.startsWith('}')) {
        return; // starts with a backtick, this is the first template element in the template literal
      }

      const prevToken = sourceCode.getTokenBefore(token, {
          includeComments: true,
        }),
        hasSpace = sourceCode.isSpaceBetween(prevToken, token);

      if (!astUtils.isTokenOnSameLine(prevToken, token)) {
        return;
      }

      if (always && !hasSpace) {
        context.report({
          loc: {
            start: token.loc.start,
            end: {
              line: token.loc.start.line,
              column: token.loc.start.column + 1,
            },
          },
          messageId: 'expectedBefore',
          fix: (fixer) => fixer.insertTextBefore(token, ' '),
        });
      }

      if (!always && hasSpace) {
        context.report({
          loc: {
            start: prevToken.loc.end,
            end: token.loc.start,
          },
          messageId: 'unexpectedBefore',
          fix: (fixer) =>
            fixer.removeRange([prevToken.range[1], token.range[0]]),
        });
      }
    }

    /**
     * Checks spacing after `${` of a given token.
     * @param {Token} token A token to check. This is a Template token.
     * @returns {void}
     */
    function checkSpacingAfter(token) {
      if (!token.value.endsWith('${')) {
        return; // ends with a backtick, this is the last template element in the template literal
      }

      const nextToken = sourceCode.getTokenAfter(token, {
          includeComments: true,
        }),
        hasSpace = sourceCode.isSpaceBetween(token, nextToken);

      if (!astUtils.isTokenOnSameLine(token, nextToken)) {
        return;
      }

      if (always && !hasSpace) {
        context.report({
          loc: {
            start: {
              line: token.loc.end.line,
              column: token.loc.end.column - 2,
            },
            end: token.loc.end,
          },
          messageId: 'expectedAfter',
          fix: (fixer) => fixer.insertTextAfter(token, ' '),
        });
      }

      if (!always && hasSpace) {
        context.report({
          loc: {
            start: token.loc.end,
            end: nextToken.loc.start,
          },
          messageId: 'unexpectedAfter',
          fix: (fixer) =>
            fixer.removeRange([token.range[1], nextToken.range[0]]),
        });
      }
    }

    return {
      TemplateElement(node) {
        const token = sourceCode.getFirstToken(node);

        checkSpacingBefore(token);
        checkSpacingAfter(token);
      },
    };
  },
};