跳至主要内容

入门

快速入门​

本页是 ESLint 新的“扁平化”配置格式 的快速入门指南，旨在帮助您尽快使用我们推荐的规则对 TypeScript 代码进行代码检查。

注意

步骤 1：安装​

首先，安装 ESLint、TypeScript 和 我们的工具 所需的包。

npm install --save-dev eslint @eslint/js @types/eslint__js typescript typescript-eslint

步骤 2：配置​

接下来，在项目的根目录中创建一个 eslint.config.js 配置文件，并用以下内容填充它。

eslint.config.js
// @ts-check

import eslint from '@eslint/js';
import tseslint from 'typescript-eslint';

export default tseslint.config(
  eslint.configs.recommended,
  ...tseslint.configs.recommended,
);

此代码将启用我们用于 lint 的 推荐配置。

步骤 3：运行 ESLint​

打开一个终端到项目的根目录，并运行以下命令。

npx eslint .

ESLint 将 lint 当前文件夹中的所有与 TypeScript 兼容的文件，并将结果输出到您的终端。

详细信息​

下一步​

如果您在使用过程中遇到问题，请查看我们的 故障排除和常见问题解答。

其他配置​

我们建议您考虑启用以下两个配置

  • strict: recommended 的超集，包含更多主观的规则，这些规则也可能捕获错误。
  • stylistic: 强制一致样式的附加规则，不会显著捕获错误或更改逻辑。
eslint.config.js
export default tseslint.config(
  eslint.configs.recommended,
  ...tseslint.configs.recommended,
  ...tseslint.configs.strict,
  ...tseslint.configs.stylistic,
);

您可以在我们的 共享配置文档 中了解更多信息。

类型化代码检查​

我们还提供大量强大的规则，这些规则利用了 TypeScript 类型信息的强大功能。 访问下一页以获取类型化规则设置指南.

文档资源​