传统 ESLint 设置
快速入门
这些步骤将帮助您尽快在 TypeScript 代码上运行 ESLint，并使用我们的推荐规则。
注意
此页面适用于 ESLint 的旧版配置格式。有关 ESLint 的新“扁平”配置格式，请参阅 入门。
步骤 1：安装
首先，安装 ESLint、TypeScript 和此插件所需的软件包
- npm
- Yarn
- pnpm
npm install --save-dev @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint typescript
yarn add --dev @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint typescript
pnpm add --save-dev @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint typescript
步骤 2：配置
接下来，在项目的根目录中创建一个 .eslintrc.cjs 配置文件，并用以下内容填充它
.eslintrc.cjs
/* eslint-env node */
module.exports = {
extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
parser: '@typescript-eslint/parser',
plugins: ['@typescript-eslint'],
root: true,
};
信息
如果您的项目不使用 ESM，则将文件命名为 .eslintrc.js 就可以了。有关更多信息，请参阅 ESLint 的配置文件文档。
步骤 3：运行 ESLint
在项目的根目录中打开一个终端，并运行以下命令
- npm
- Yarn
- pnpm
npx eslint .
yarn eslint .
pnpm eslint .
ESLint 将检查当前文件夹中所有与 TypeScript 兼容的文件，并将结果输出到您的终端。
详细信息
parser: '@typescript-eslint/parser'告诉 ESLint 使用您安装的@typescript-eslint/parser软件包来解析您的源文件。- 这是必需的，否则 ESLint 会在尝试将 TypeScript 代码解析为普通 JavaScript 时抛出错误。
plugins: ['@typescript-eslint']告诉 ESLint 将@typescript-eslint/eslint-plugin包加载为插件。- 这允许您在代码库中使用 typescript-eslint 的规则。
extends: [ ... ]告诉 ESLint 您的配置扩展了给定的配置。eslint:recommended是 ESLint 内置的“推荐”配置 - 它开启了一组小的、合理的规则，这些规则用于检查众所周知的最佳实践。plugin:@typescript-eslint/recommended是我们的“推荐”配置 - 它类似于eslint:recommended，只是它开启了我们插件中的 TypeScript 特定规则。
root: true通常是一个很好的 ESLint 实践，用于指示此文件是项目使用的根级文件，ESLint 不应该在这个目录之外搜索配置文件。
下一步
如果您在使用此功能时遇到问题，请查看我们的 故障排除和常见问题解答。
其他配置
我们建议您考虑启用以下两个配置
.eslintrc.cjs
/* eslint-env node */
module.exports = {
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'plugin:@typescript-eslint/strict',
'plugin:@typescript-eslint/stylistic',
],
parser: '@typescript-eslint/parser',
plugins: ['@typescript-eslint'],
root: true,
};
您可以在我们的 共享配置文档 中了解更多关于这些内容的信息。
类型化代码检查
我们还提供大量强大的规则，这些规则利用了 TypeScript 类型信息的力量。 访问下一页以获取类型化规则设置指南。