ESLint

• 在项目根目录中打开一个配置文件，或创建一个新文件。 根据您使用的 ESLint 版本填写该配置文件：

  // @ts-check import eslint from '@eslint/js'; import tseslint from 'typescript-eslint'; export default tseslint.config( eslint.configs.recommended, tseslint.configs.recommended, );

  了解详情请参阅 ESLint 官方网站。

  /* eslint-env node */ module.exports = { extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'], parser: '@typescript-eslint/parser', plugins: ['@typescript-eslint'], root: true, };

  了解详情请参阅 ESLint 官方网站。

• 要在当前项目中自动配置 ESLint，请打开 设置 对话框（Ctrl+Alt+S ），转到 语言与框架 | JavaScript | 代码质量工具 | ESLint ，然后选择 自动配置 ESLint 选项。

• 要在所有新项目中自动配置 ESLint，请打开 新建项目的设置 对话框（文件 | 新建项目的设置 ），转到 语言与框架 | JavaScript | 代码质量工具 | ESLint ，然后选择 自动配置 ESLint 选项。

1. 在 设置 对话框（Ctrl+Alt+S ）中，转到 语言与框架 | JavaScript | 代码质量工具 | ESLint ，并选择 手动配置 ESLint。

2. 在 ESLint 包 字段中，指定 eslint 或 standard 包的位置。

3. 在 工作目录 字段中，指定 ESLint 进程的工作目录。

   默认情况下，该字段为空，PyCharm 会自动检测工作目录。 首先，它会查找最接近被检查文件且包含 配置文件 的目录。

   如果自动检测到的工作目录与您的项目配置不匹配，您需要手动指定工作目录（可为多个）。 使用分号作为分隔符。 可接受的值为：

   • 绝对路径。

   • 相对于项目基目录的路径（存储 PyCharm 特定项目元数据的 .idea 文件夹的父文件夹）。 例如：

     1. ./ ：将项目基目录用作 ESLint 进程的工作目录。

     2. client;server ：将 <project_base_dir>/client 和 <project_base_dir>/server 用作工作目录。 对于既不在 client 文件夹下、也不在 server 文件夹下的文件，工作目录将会被 按照上述方式自动检测。

     3. packages/*： <project_base_dir>/packages 目录的每个子文件夹都将用作相应被检查文件的工作目录。

   • 如果某些被检查文件在文件夹层级中不位于项目基目录下，则可以使用相对于内容根的路径。

   • Glob patterns ，用于定义到工作目录的相对路径。 例如，使用 **/foo -* 时，每个名称以 foo- 开头的目录都将用作相应被检查文件的工作目录。

4. 选择要使用的配置。

   • 自动搜索 ：如果在受支持格式的 配置文件 中配置了 ESLint 规则，请选择此选项。

     PyCharm 会从要检查的文件所在的文件夹开始查找此类文件，然后在其父文件夹中查找，依次向上，直到到达项目根目录。

   • 配置文件 - 选择此选项以使用自定义文件，并在 路径 字段中指定文件位置。

   了解有关配置 ESLint 的更多信息，请参阅 ESLint 官方网站。

5. 可选：

   • 在 额外eslint 选项 (O) 字段中，指定运行 ESLint 时使用的其他命令行选项，使用空格作为分隔符。 例如，要使用 用 TypeScript 编写的配置文件 ，请输入 --flag unstable_ts_config。

     了解有关 ESLint CLI 选项的更多信息，请参阅 ESLint 官方网站。

   • 在 附加规则目录 字段中，指定附加代码验证规则文件的位置。 这些规则将应用在默认配置文件或自定义配置文件的规则之后，并据此覆盖它们。

     有关 ESLint 配置文件 和 添加规则 的更多信息，请参阅 ESLint 官方网站。

1. 打开 设置 对话框（Ctrl+Alt+S ），转到 语言与框架 | JavaScript | 代码质量工具 | ESLint ，然后选择 自动配置 ESLint 或 手动配置 ESLint。

2. 在 对文件运行 字段中，指定定义要检查的文件集的模式。 您可以接受默认模式，或输入自定义模式。

   使用默认模式 **/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts,html,vue} ，ESLint 将在 JavaScript、TypeScript、JSX、TSX、HTML 或 Vue 文件更新时唤醒并进行处理。 要检查其他类型的文件或存储在特定文件夹中的文件，请使用 glob patterns 更新默认模式。

   • 例如，要同时自动检查 CoffeeScript 文件，请将 coffee 添加到默认模式中，如下所示：

     **/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts,html,vue,coffee}

   • 要检查特定文件夹（包括其子文件夹）中的文件，请将 **/* 替换为 <path to the folder>/**/*。

     假设您的项目具有以下结构：

     

     若仅检查 coffee 文件夹中的文件，请按如下方式更新模式：

     coffee/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts,html,vue,coffee}

     结果，文件 linting.coffee 会被检查，而 no_linting .coffee 不会。

• 打开 设置 对话框（Ctrl+Alt+S ），转到 语言与框架 | JavaScript | 代码质量工具 | ESLint ，并选中 在保存时运行 eslint --fix 复选框。

• 要查看问题的描述，请将鼠标悬停在高亮代码上。

  

  要解决检测到的问题，点击 ESLint：修复 '<rule name>' 或按 Alt+Shift+Enter。

  要解决当前文件中检测到的所有问题，点击 更多操作 （Alt+Enter ），然后从列表中选择 ESLint：修复当前文件。

  

  有关更多信息，请参阅 View problems and apply quick-fixes in the editor。

• 您还可以配置 ESLint，在保存该文件时修复该文件中的所有问题。 要配置此行为，请在 设置 对话框的 ESLint 页面上选中 在保存时运行 eslint --fix 复选框，如 Activating and configuring ESLint in PyCharm 中所述。

• 要打开 问题 工具窗口，请点击编辑器右上角的 检查 小部件。

  

  或者，从主菜单中选择 视图 | 工具窗口 | 问题 ，或按 Alt+6。

• 在 文件 选项卡中，查看问题说明，应用快速修复，导航到源代码中发生错误的片段，并且可在不离开工具窗口的情况下在 编辑器预览 窗格中修复它们。 了解更多请参阅 Problems tool window。

  

• 在 项目错误 选项卡中，查看当前会话期间打开的所有文件中的错误，错误消息按检测到它们的文件进行分组。

  

  在此，您可以查看问题说明，应用快速修复，导航到源代码中发生错误的片段，并且可在不离开工具窗口的情况下在 编辑器预览 窗格中修复它们。 了解更多请参阅 Problems tool window。

• 在 配置文件 中，找到要编辑的规则，并将其值设置为 1warn 或 2error。

  了解更多请参阅 ESLint 官方网站。

忽略配置中的严重性级别

1. 在 设置 对话框（Ctrl+Alt+S ）中，选择 编辑器 | 检查。 Inspections page 打开。

2. 在中央窗格中，转到 JavaScript | 代码质量工具 | ESLint。

3. 在右侧窗格中，清除 使用配置文件中的规则严重性 复选框，并选择要替代默认级别的严重性级别。