Back to Biomejs

noUselessStringRaw

src/content/docs/linter/rules/no-useless-string-raw.mdx

latest5.0 KB
Original Source

import { Tabs, TabItem } from '@astrojs/starlight/components';

<Tabs> <TabItem label="JavaScript (and super languages)" icon="seti:javascript"> ## Summary - Rule available since: `v1.9.4` - Diagnostic Category: [`lint/complexity/noUselessStringRaw`](/reference/diagnostics#diagnostic-category) - This rule is **recommended**, meaning it is enabled by default. - This rule doesn't have a fix. - The default severity of this rule is [**information**](/reference/diagnostics#information). ## How to configure ```json title="biome.json" { "linter": { "rules": { "complexity": { "noUselessStringRaw": "error" } } } }
## Description
Disallow unnecessary `String.raw` function in template string literals without any escape sequence.

`String.raw` is useless when contains a raw string without any escape-like sequence.

## Examples

### Invalid

```js
String.raw`a`;
<pre class="language-text"><code class="language-text">code-block.js:1:1 <a href="https://biomejs.dev/linter/rules/no-useless-string-raw">lint/complexity/noUselessStringRaw</a> ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ <strong><span style="color: lightgreen;">ℹ</span></strong> <span style="color: lightgreen;">String.raw is useless when the raw string doesn't contain any escape sequence.</span> <strong><span style="color: Tomato;">&gt;</span></strong> <strong>1 │ </strong>String.raw&#96;a&#96;; <strong> │ </strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong> <strong>2 │ </strong> <strong><span style="color: lightgreen;">ℹ</span></strong> <span style="color: lightgreen;">Remove the String.raw call because it's useless here, String.raw can deal with string which contains escape sequence like &#92;n, &#92;t, &#92;r, &#92;&#92;, &#92;&quot;, &#92;'.</span> </code></pre>
js
String.raw`a ${v}`;
<pre class="language-text"><code class="language-text">code-block.js:1:1 <a href="https://biomejs.dev/linter/rules/no-useless-string-raw">lint/complexity/noUselessStringRaw</a> ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ <strong><span style="color: lightgreen;">ℹ</span></strong> <span style="color: lightgreen;">String.raw is useless when the raw string doesn't contain any escape sequence.</span> <strong><span style="color: Tomato;">&gt;</span></strong> <strong>1 │ </strong>String.raw&#96;a $&#123;v&#125;&#96;; <strong> │ </strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong> <strong>2 │ </strong> <strong><span style="color: lightgreen;">ℹ</span></strong> <span style="color: lightgreen;">Remove the String.raw call because it's useless here, String.raw can deal with string which contains escape sequence like &#92;n, &#92;t, &#92;r, &#92;&#92;, &#92;&quot;, &#92;'.</span> </code></pre>

Valid

js
String.raw`\n ${a}`;
js
String.raw`\n`;
</TabItem> </Tabs>