noMultilineString

JavaScript (and super languages)

Summary

Rule available since: v2.3.8
Diagnostic Category: lint/style/noMultilineString
This rule isn’t recommended, so you need to enable it.
This rule doesn’t have a fix.
The default severity of this rule is information.
Sources:
- Same as no-multi-str

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "noMultilineString": "error"
6
      }
7
    }
8
  }
9
}

Description

Disallow creating multiline strings by escaping newlines.

Escaping newlines to create multiline strings is discouraged because it can lead to subtle errors caused by unexpected whitespace after the backslash.

Examples

Invalid

1
const foo =
2
    "Line 1\n\
3
Line 2";

code-block.js:2:5 lint/style/noMultilineString ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ This string escapes a newline to span multiple lines.
  
    1 │ const foo =
  > 2 │     “Line 1\n\
      │     ^^^^^^^^^^
  > 3 │ Line 2”;
      │ ^^^^^^^
    4 │ 
  
  ℹ Escaped newlines make string contents harder to read and can hide unexpected whitespace.
  
  ℹ Use a template literal or include the newline explicitly instead.

Valid

1
const foo = "Line 1\nLine 2";

1
const bar = `Line 1
2
Line 2`;