VSCode中的代码检查(Linting)配置指南

1次阅读

vscode需配合外部Linter工具及对应扩展实现代码检查:选对语言匹配扩展、配置项目级规则文件、开启VSCode相关设置(如eslint.enable)、确保环境路径正确,多根工作区需独立配置。

VSCode中的代码检查(Linting)配置指南

VSCode 本身不自带代码检查(Linting)功能,需要配合外部 Linter 工具(如 ESLint、Prettier、pylint、rust-clippy 等)和对应扩展来实现。关键在于:装对扩展、配好规则、让编辑器真正“听懂”项目配置。

选对扩展,匹配语言和工具链

不同语言需安装对应的 VSCode 扩展,且要与项目中实际使用的 Linter 一致:

  • javaScript/typescript:装 ESLint 扩展(由 microsoft 官方维护),并确保项目根目录有 eslint.config.js.eslintrc.*;禁用其他冲突的 JS Linter(如 JSHint)
  • python:装 PylintFlake8 扩展,同时在终端运行 pip install pylint;推荐用 Python 官方扩展(它自动集成多种 Linter,可在设置中切换)
  • Rust:装 Rust Analyzer(已内置 clippy 支持),无需额外配置即可高亮 clippy 建议
  • 通用格式化:Prettier 需装 Prettier 扩展,并在项目中安装 prettier 包;它通常不单独做“检查”,而是配合 ESLint 使用(如 eslint-config-prettier 关闭风格类规则)

配置 VSCode 设置,让 Lint 结果可见

即使 Linter 已安装,VSCode 默认可能不显示警告或错误。需手动开启:

  • 打开设置(Ctrl+,Cmd+,),搜索 lint,确认 “Editor: Code Actions On Save” 中勾选了 source.fixAll(可选)
  • 搜索 eslint.enable,确保为 true(JS/TS 项目);Python 用户检查 python.linting.enabled 是否启用
  • 若想保存时自动修复,设 "editor.codeActionsOnSave": { "source.fixAll": true }(注意:部分规则不可自动修复,需手动处理)

项目级配置优先于全局设置

VSCode 的 Linter 行为以项目根目录下的配置文件为准,不是用户全局设置:

VSCode中的代码检查(Linting)配置指南

MyBatis3.2.3帮助文档 中文CHM版

MyBatis 是支持普通 SQL 查询,存储过程和高级映射的优秀持久层框架。MyBatis 消除 了几乎所有的 JDBC 代码和参数的手工设置以及结果集的检索。MyBatis 使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plan Old Java Objects,普通的 Java 对象)映射成数据库中的记录。有需要的朋友可以下载看看

VSCode中的代码检查(Linting)配置指南 1

查看详情 VSCode中的代码检查(Linting)配置指南

  • ESLint 会依次查找 eslint.config.js.eslintrc.cjs.eslintrc.json;推荐用 eslint.config.js(ESLint v8.22+ 新标准)
  • Python 的 pyproject.toml.flake8 文件会被自动识别;确保 [tool.pylint][tool.flake8] 区块存在
  • 如果 Lint 不生效,右键命令面板(Ctrl+Shift+P)输入 “Developer: Toggle Developer Tools”,看 console 是否报错(常见如找不到 eslint 可执行文件)

调试常见失效场景

Lint 突然不提示?大概率是环境或路径问题:

  • 工作区没识别到 node.js/Python 环境:在 VSCode 终端中运行 which eslintwhere pylint,确认命令可用;必要时在设置里指定 eslint.packageManagerpython.defaultInterpreter
  • 多根工作区(Multi-root Workspace)下 Lint 失效:每个文件夹需独立含 Linter 配置;或在 .code-workspace 文件中为各文件夹指定 "settings"
  • TS/JSX 文件被误判为 plain JS:检查文件右下角语言模式是否为 TypeScript react,不是 javascript;可点击切换或加 // @ts-check 注释激活类型检查

基本上就这些。核心逻辑很直接:工具装对、配置放对位置、VSCode 设置打开开关。不复杂但容易忽略路径和作用域细节。

text=ZqhQzanResources