TypeScript 代码检查
推荐用于 TypeScript 代码的检查器是 ESLint ,它提供了广泛的代码检查规则,并可通过插件进行扩展。 GoLand 会在编辑器中直接显示由 ESLint 报告的警告和错误,在您输入的同时进行提示。 详细信息请参阅 ESLint。
在项目的 ESLint 配置中将 @typescript-eslint/parser 设置为解析器后,GoLand 会在 .ts 和 .tsx 文件中高亮显示由 ESLint 报告的错误。 详细信息请参阅 typescript-eslint 仓库中的 readme 文件。
准备工作
下载并安装 Node.js。
请按照 配置本地 Node.js 解释器、 在 Windows 子系统 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 版本,GoLand 可识别以下文件类型中的配置:
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 配置迁移指南 ,了解如何切换为 flat 格式。
创建并编辑配置文件
在项目根目录下打开配置文件或创建新文件。 根据您使用的 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 官方网站。
在 GoLand 中配置 ESLint
默认情况下,ESLint 会被 自动配置。 您可以选择 手动指定所有配置设置,或禁用 ESLint。
请参阅 ESLint 了解更多信息。
使用 ESLint 抑制 TypeScript 代码检查
如果您已在使用
@typescript-eslint/parser,但不希望使用 ESLint 检查 TypeScript 代码,请将 .ts 或 .tsx 添加到 .eslintignore 文件中。
检查代码
安装并启用后,每次打开 TypeScript 文件时,ESLint 会自动激活。 您还可以配置 ESLint,在保存时 自动检测并修复问题。
默认情况下,GoLand 会根据 ESLint 配置中的严重级别标记检测到的问题。 请参阅 配置 ESLint 高亮 了解如何覆盖这些设置。
编辑器以及 文件 选项卡下的 问题 工具窗口中提供了当前文件中检测到的错误描述及其快速修复方式。
所有先前打开的文件中的错误及其快速修复内容显示在 项目错误 选项卡下的 问题 工具窗口中。 要打开该工具窗口,请单击编辑器右上角的 检查 小部件:

要查看编辑器中问题的描述,请将鼠标悬停在高亮代码上。

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

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

更多信息请参阅 问题工具窗口。
您还可以配置 ESLint 以在保存文件时修复该文件中的所有问题。 要配置此行为,请在 ESLint 页面中的 保存时运行 eslint --fix 复选框中进行选择,在 设置 对话框内,如 在 GoLand 中激活并配置 ESLint 中所述。
TSLint
您还可以在 GoLand 中使用 TSLint 代码检查工具,在不运行应用程序的情况下检查 TypeScript 代码中的常见错误。 启用该工具后,会检查所有打开的 TypeScript 文件,并标记检测到的问题。
要查看问题的描述,请将鼠标悬停在高亮代码上。 默认情况下,GoLand 会基于 TSLint 配置文件中的严重级别标记检测到的问题。 请参阅 配置 TSLint 高亮 了解如何覆盖这些设置。

准备工作
安装 TSLint
在嵌入式 终端 (Alt+F12 )中,输入:
npm install tslint typescript --save-dev详细信息请参阅 TSLint 官方网站。
创建 TSLint 配置文件
在嵌入式 终端 (Alt+F12 )中,输入:
cd <project root> tslint --init
在 GoLand 中启用并配置 TSLint
默认情况下,GoLand 使用项目 node_modules 文件夹中的 TSLint 包,以及当前文件所在文件夹中的 tslint.json 配置文件。 如果在当前文件的文件夹中找不到 tslint.json 配置文件,GoLand 会向上查找其父目录中的配置文件,直到项目根目录。
如果您有多个将 TSLint 列为依赖项的 package.json 文件,GoLand 会为每个 package.json 启动一个单独的进程,并处理其下方的所有内容。 这使您能够针对 mono 仓库或具有多个 TSLint 配置的项目中的每个路径,应用特定版本的 TSLint 或特定插件集。
此行为是所有新建 GoLand 项目的默认设置。 要在先前创建的项目中启用此功能,请转到 中的 设置 对话框(Ctrl+Alt+S ),然后选择 自动 TSLint 配置 选项。
您还可以手动配置 TSLint,以使用自定义 TSLint 包和 tslint.json ,并指定一些附加规则。
在 设置 对话框(Ctrl+Alt+S )中,转到 。
选择 手动配置 选项。
指定 TSLint 包的路径。
在 配置文件 区域中,指定要使用的配置。
默认情况下,GoLand 会首先查找 tslint.json 、 tslint.yaml 或 tslint.yml 配置文件。 GoLand 从存放待检查文件的文件夹开始查找,然后依次查找上级目录,直至到达项目根目录。 如果未找到 tslint.json 、 tslint.yaml 或 tslint.yml 配置文件,则 TSLint 会使用其默认的内置配置文件。 因此,您必须在 tslint.json 、 tslint.yaml 或 tslint.yml 配置文件中定义要应用的配置,或者在自定义配置文件中定义,或者依赖默认的内置配置。
若要使 GoLand 查找 tslint.json 、 tslint.yaml 或 tslint.yml 文件,请选择 自动搜索 选项。
要使用自定义文件,请选择 配置文件 选项,并在 路径 字段中指定文件位置。 从列表中选择路径,或手动输入,或点击
并在打开的对话框中选择相关文件。
您可以在 TSLint 官方网站 上了解有关配置 TSLint 的更多内容。
如有需要,请在 附加规则目录 字段中指定包含附加代码验证规则的文件位置。 这些规则将在来自 tslint.json 、 tslint.yaml 、 tslint.yml 或上述指定的自定义配置文件的规则之后应用,并据此覆盖它们。
配置 TSLint 的高亮显示
默认情况下,GoLand 会根据 TSLint 配置文件中设置的严重性级别,标记检测到的错误和警告。 例如,错误会用红色波浪线突出显示,而警告则以黄色背景标记。
更改 TSLint 配置中的规则严重级别
在 TSLint 配置文件中,找到您想要编辑的规则,并将其 ID 设置为
warning或error。 请参阅 TSLint 官方网站 了解更多信息。
您可以覆盖 TSLint 配置文件中的严重性级别,使 GoLand 忽略这些设置,并将 linter 报告的所有内容显示为错误、警告或自定义颜色。
忽略配置中的严重级别
在 设置 对话框(Ctrl+Alt+S )中,转到 。 将打开 检查页面。
在中间面板中,转到 JavaScript 和 TypeScript | 代码质量工具 | TSLint。
在右侧面板中,取消选中 使用配置文件中的规则严重性 复选框,并选择要使用的严重性级别以替代默认设置。

从 TSLint 配置文件导入代码风格
GoLand 能够识别某些在 tslint.json 、 tslint.yaml 或 tslint.yml 配置文件中描述的 TSLint 规则,并允许您将其应用于项目中的 TypeScript 代码样式配置。
首次打开项目时,GoLand 会自动从项目的 tslint.json 、 tslint.yaml 或 tslint.yml 中导入代码样式。
如果 tslint.json 、 tslint.yaml 或 tslint.yml 被更新(手动或通过版本控制),请在编辑器中打开该文件,并从上下文菜单中选择 应用 TSLint 代码样式规则。

TSLint 快速修复
GoLand 允许您自动修复部分由 TSLint 报告的问题。

要修复特定错误,将插入符号放在高亮代码上,按下 Alt+Enter ,然后从列表中选择 TSLint:修复 '<current error>'。
要修复文件中检测到的所有问题,请选择 TSLint:修复当前文件。
您可以在当前文件甚至当前行中禁用 TSLint 规则。 GoLand 会自动以 /* tslint:disable:<rule name> 或 // tslint:disable-next-line:<rule name> 格式生成禁用注释,并分别置于文件顶部或当前行的上方。

即时抑制 TSLint 规则
将光标置于 TSLint 报告的错误或警告上,然后按下 Alt+Enter。
选择要禁用的规则的快速修复,然后按下 Right。
在列表中选择 在当前文件中禁用 <rule name> 或 在当前行中禁用 <rule name>。