TypeScript 语法检查
推荐的 TypeScript 代码检查工具是 ESLint ,它提供了广泛的检查规则,并且可以通过插件进行扩展。 RustRover 会在编辑器中直接显示由 ESLint 报告的警告和错误,您在键入时即可看到。 了解详情,请参阅 ESLint。
当 @typescript-eslint/parser 设置为您项目的 ESLint 配置中的解析器时,RustRover 会在 .ts 和 .tsx 文件中高亮显示 ESLint 报告的错误。 了解更多信息,请参阅 typescript-eslint 仓库中的 readme 文件。
在开始之前
下载并安装 Node.js。
按照 配置本地 Node.js 解释器、 在 Windows Subsystem for Linux 上使用 Node.js 或 配置远程 Node.js 运行时 中的说明,在您的项目中配置 Node.js 运行时。
安装 ESLint
ESLint 版本 9 及更高版本
在内置的 终端 (Alt+F12 )中,输入:
npm install --save-dev eslint @eslint/js typescript typescript-eslintpnpm add --save-dev eslint @eslint/js typescript typescript-eslintyarn add --dev eslint @eslint/js typescript typescript-eslint
了解更多信息,请参阅 typescript-eslint 官方网站。
ESLint 版本 8 及更早版本
在内置的 终端 (Alt+F12 )中,输入:
npm install --save-dev @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint typescriptpnpm add --save-dev eslint @eslint/js typescript-eslintyarn add --dev eslint @eslint/js typescript-eslint
了解更多信息,请参阅 typescript-eslint 官方网站。
配置文件
根据您使用的 ESLint 版本,RustRover 能识别以下文件类型中的配置:
ESLint 版本 9 及更高版本
eslint.config.js 、 eslint.config.mjs 或 eslint.config.cjs (平面格式),了解更多信息,请参阅 ESLint 官方网站。
您还可以使用用 TypeScript 编写的配置文件,例如 eslint.config.ts 、 eslint.config.mts 或 eslint.config.cts 。 为此,您需要指定 unstable_ts_config 标志。
按下 Ctrl+Alt+S 打开设置,然后选择 。
请选择 手动 ESLint 配置。
在 额外的 eslint 选项 字段中,输入
--flag unstable_ts_config。点击 应用 保存更改并关闭对话框。
ESLint 版本 8 及更早版本
.eslintrc.* ( .eslintrc 、 .eslintrc.json 或 .eslintrc.yaml 文件,或其他支持的格式文件)。
.eslintignore
package.json 具有
eslintIgnore或eslintConfig属性。 此配置系统已被弃用,了解更多信息,请参阅 ESLint 官方网站。
了解如何从 ESLint 配置迁移指南 切换到平面格式。
创建和编辑配置文件
打开一个配置文件或在项目根目录中创建一个新文件。 根据您使用的 ESLint 版本填充配置文件:
// @ts-check import eslint from '@eslint/js'; import tseslint from 'typescript-eslint'; export default tseslint.config( eslint.configs.recommended, tseslint.configs.recommended, );了解更多信息,请参阅 typescript-eslint 官方网站。
/* eslint-env node */ module.exports = { extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'], parser: '@typescript-eslint/parser', plugins: ['@typescript-eslint'], root: true, };了解更多信息,请参阅 typescript-eslint 官方网站。
在 RustRover 中配置 ESLint
默认情况下,ESLint 被 自动 配置。 您可以选择 手动 指定所有配置设置或禁用 ESLint。
了解更多信息,请参阅 ESLint。
使用 ESLint 抑制 TypeScript 代码的检查
如果您已经在使用
@typescript-eslint/parser,但不想使用 ESLint 检查 TypeScript 代码,请将 .ts 或 .tsx 添加到 .eslintignore 文件。
检查您的代码
安装并启用后,每次打开 TypeScript 文件时,ESLint 会自动激活。 您还可以配置 ESLint 以 在保存时自动检测并修复问题。
默认情况下,RustRover 会根据 ESLint 配置中的严重性级别标记检测到的问题。 请参阅 配置 ESLint 高亮显示 ,了解如何重写这些设置。
您可以在编辑器以及 问题 工具窗口的 文件 选项卡中查看当前文件中检测到的错误的描述及其快速修复。
所有之前打开的文件中的错误及其快速修复会显示在 项目错误 选项卡的 问题 工具窗口中。 若要打开工具窗口,请点击编辑器右上角的 检查 小组件:

有关详情,请参阅 在编辑器中查看问题并应用快速修复以及 问题工具窗口。
要在编辑器中查看问题的描述,请将鼠标悬停在高亮显示的代码上。

要解决检测到的问题,请点击 ESLint: 修复 '<rule name>' 或按 Alt+Shift+Enter。
要解决当前文件中的所有检测到的问题,请点击 更多操作 (Alt+Enter )并从列表中选择 。

或者,打开 文件 选项卡的 问题 工具窗口 Alt+6 ,您可以在其中查看问题描述、应用快速修复、导航到发生错误的源代码片段,并在 编辑器预览 面板中修复它们,而无需离开工具窗口。

了解更多信息,请参阅 问题工具窗口。
您还可以配置 ESLint 在保存文件时修复文件中的所有问题。 要配置此类行为,请在 保存时运行 eslint --fix 复选框,在 ESLint 页面的 设置 对话框中,如 在 RustRover 中激活和配置 ESLint 所述。
了解更多信息,请参阅 在编辑器中查看问题并应用快速修复 和 ESLint。