← Back to rules

eslint/prefer-const Style

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

作用

要求对在初始声明后从未被重新赋值的变量使用 const 声明。

为什么这不好？

如果一个变量从未被重新赋值，使用 const 声明会更好。 const 声明会告诉读者：“这个变量从未被重新赋值”，从而减少认知负担并提高可维护性。

示例

以下是此规则的错误代码示例：

let a = 3;
console.log(a);

let b;
b = 0;
console.log(b);

for (let i in [1, 2, 3]) {
  console.log(i);
}

以下是此规则的正确代码示例：

const a = 0;

let a;
a = 0;
a = 1;

let a;
if (true) {
  a = 0;
}

for (const i in [1, 2, 3]) {
  console.log(i);
}

配置

destructuring

type: "any" | "all"

配置解构赋值的处理方式。

"any"

如果解构赋值中的任意变量应当使用 const，则发出警告。

"all"

仅当解构赋值中的所有变量都应当使用 const 时才发出警告。否则，忽略它们。

ignoreReadBeforeAssign

type: boolean

default: false

如果为 true，该规则将不会报告在初始赋值之前被读取的变量。 这主要用于防止与 typescript/no-use-before-define 规则冲突。

如何使用

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

Config (.oxlintrc.json)

{
  "rules": {
    "prefer-const": "error"
  }
}

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  rules: {
    "prefer-const": "error",
  },
});

CLI

oxlint --deny prefer-const

版本

此规则是在 v1.43.0 中添加的。

参考

• Rule Source
• Open rule in Oxc Playground