2 * @fileoverview Rule to enforce spacing around embedded expressions of template strings
3 * @author Toru Nagashima
8 //------------------------------------------------------------------------------
10 //------------------------------------------------------------------------------
12 const astUtils = require("./utils/ast-utils");
14 //------------------------------------------------------------------------------
16 //------------------------------------------------------------------------------
18 const OPEN_PAREN = /\$\{$/u;
19 const CLOSE_PAREN = /^\}/u;
21 //------------------------------------------------------------------------------
23 //------------------------------------------------------------------------------
30 description: "require or disallow spacing around embedded expressions of template strings",
31 category: "ECMAScript 6",
33 url: "https://eslint.org/docs/rules/template-curly-spacing"
36 fixable: "whitespace",
39 { enum: ["always", "never"] }
42 expectedBefore: "Expected space(s) before '}'.",
43 expectedAfter: "Expected space(s) after '${'.",
44 unexpectedBefore: "Unexpected space(s) before '}'.",
45 unexpectedAfter: "Unexpected space(s) after '${'."
50 const sourceCode = context.getSourceCode();
51 const always = context.options[0] === "always";
52 const prefix = always ? "expected" : "unexpected";
55 * Checks spacing before `}` of a given token.
56 * @param {Token} token A token to check. This is a Template token.
59 function checkSpacingBefore(token) {
60 const prevToken = sourceCode.getTokenBefore(token);
63 CLOSE_PAREN.test(token.value) &&
64 astUtils.isTokenOnSameLine(prevToken, token) &&
65 sourceCode.isSpaceBetweenTokens(prevToken, token) !== always
69 messageId: `${prefix}Before`,
72 return fixer.insertTextBefore(token, " ");
74 return fixer.removeRange([
84 * Checks spacing after `${` of a given token.
85 * @param {Token} token A token to check. This is a Template token.
88 function checkSpacingAfter(token) {
89 const nextToken = sourceCode.getTokenAfter(token);
92 OPEN_PAREN.test(token.value) &&
93 astUtils.isTokenOnSameLine(token, nextToken) &&
94 sourceCode.isSpaceBetweenTokens(token, nextToken) !== always
98 line: token.loc.end.line,
99 column: token.loc.end.column - 2
101 messageId: `${prefix}After`,
104 return fixer.insertTextAfter(token, " ");
106 return fixer.removeRange([
116 TemplateElement(node) {
117 const token = sourceCode.getFirstToken(node);
119 checkSpacingBefore(token);
120 checkSpacingAfter(token);