unicorn/prefer-string-raw Style

🛠️ An auto-fix is available for this rule.

Prefers use of String.raw to avoid escaping \.

Excessive backslashes can make string values less readable which can be avoided by using String.raw.

Examples of incorrect code for this rule:

javascript

const file = "C:\\windows\\style\\path\\to\\file.js";
const regexp = new RegExp("foo\\.bar");

Examples of correct code for this rule:

javascript

const file = String.raw`C:\windows\style\path\to\file.js`;
const regexp = new RegExp(String.raw`foo\.bar`);

How to use

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)Config (oxlint.config.ts)CLI

json

{
  "rules": {
    "unicorn/prefer-string-raw": "error"
  }
}

import { defineConfig } from "oxlint";

export default defineConfig({
  rules: {
    "unicorn/prefer-string-raw": "error",
  },
});

bash

oxlint --deny unicorn/prefer-string-raw

This rule was added in v0.12.0.