Skip to main content

template-literal-format

Enforce newline-boundary formatting for multiline template literals.

Targeted pattern scope​

This rule targets multiline template literals only.

It requires the template content to have boundary newlines:

  • the first quasi starts with \n
  • the last quasi ends with \n

What this rule reports​

This rule reports multiline template literals that do not start and end on their own lines.

It provides an autofix that normalizes indentation in the template body.

Why this rule exists​

Boundary-newline formatting makes multiline templates more readable and stable across indentation changes.

❌ Incorrect​

const text = `line one
line two`;

✅ Correct​

const text = `
    line one
    line two
`;

Behavior and migration notes​

This rule is autofixable.

The fixer adds required boundary newlines and normalizes content indentation based on minimum detected indent.

Options​

This rule has no options.

Additional examples​

const sql = `SELECT *
FROM users`;
// ❌ reported

const sqlNormalized = `
    SELECT *
    FROM users
`;
// ✅ valid

ESLint flat config example​

import etcMisc from "eslint-plugin-etc-misc";

export default [
 {
  plugins: { "etc-misc": etcMisc },
  rules: {
   "etc-misc/template-literal-format": "error",
  },
 },
];

When not to use it​

Disable this rule if your formatter already enforces a different multiline template style.

Package documentation​

Rule catalog ID: R099

Further reading​

Adoption resources​

  • Start at warning level in CI, then move to error after cleanup.
  • Use focused codemods/autofix batches per package or directory.