2021-05-01 12:54:34
在 VSCode 中配置 ESLint 代码检查需完成以下核心步骤:安装插件、初始化配置文件、启用自动修复功能,并确保项目依赖和目录结构正确。 具体操作如下:
一、安装 ESLint 插件已安装 Node.js 和 npm(通过命令 node -v 和 npm -v 检查版本)。
项目根目录为待配置的文件夹(即包含 package.json 的目录)。
方法一:运行命令 npm init @eslint/config,按提示选择:
模块类型(如 script、module)。
使用的框架(如 React、Vue 或 None)。
是否使用 TypeScript(根据项目需求选择)。
代码风格标准(如 Airbnb、Standard 或自定义规则)。
方法二:全局安装 ESLint 后执行 eslint --init(需先运行 npm install -g eslint)。
打开 VSCode 设置(快捷键 Ctrl+, 或通过菜单栏 File > Preferences > Settings)。
搜索 format on save,勾选 Editor: Format On Save 选项。
在设置搜索框中输入 editor.codeActionsOnSave,添加以下配置:"editor.codeActionsOnSave": { "source.fixAll.eslint": true}
此配置会触发 ESLint 在保存时自动修复缩进、引号等可修复问题。
若 ESLint 未生效,按以下步骤排查:
确认项目根目录存在 .eslintrc.* 文件(如 .eslintrc.cjs 或 .eslintrc.json)。
若文件缺失,重新运行 npm init @eslint/config 生成。
确保项目本地安装了 eslint 包(运行 npm list eslint 检查,若未安装则执行 npm install eslint --save-dev)。
若使用 TypeScript,需额外安装解析器和插件:npm install @typescript-eslint/parser @typescript-eslint/eslint-plugin --save-dev
在 .eslintrc.cjs 中配置解析器为 @typescript-eslint/parser:module.exports = { parser: '@typescript-eslint/parser', plugins: ['@typescript-eslint'], // 其他规则...};
确保 VSCode 打开的是项目根目录(而非上级文件夹),否则插件无法识别配置文件。
总结:通过安装插件、初始化配置、启用自动修复及排查常见问题,即可在 VSCode 中完整配置 ESLint。此配置能实时检查代码规范,支持自动修复,显著提升开发效率和代码质量。