React / 系统课时
配置 VS Code 开发环境
配置 VS Code 开发环境
本课把 VS Code 调整成适合 React 日常开发的工作区:保留编辑器自带的 JavaScript/TypeScript 智能提示,补上 ESLint 与 Prettier,并用项目级设置统一保存格式化和代码修复行为。完成后,你可以用一次保存动作验证配置是否真正生效。
学习目标
- 配置 React 项目所需的代码提示、格式化与 ESLint 检查
- 用
.vscode工作区配置固定团队一致的编辑器行为 - 能定位“保存不格式化”或“ESLint 没提示”的常见原因
先确认基础能力
VS Code 已内置 JavaScript 和 TypeScript 语言服务,React 的 JSX/TSX 补全、跳转和基础类型提示通常不需要额外安装“React 语法插件”。先打开一个现有 React 项目,确认 .jsx、.tsx 文件能被正常识别。
格式化与规则检查建议分工明确:Prettier 负责代码排版,ESLint 负责潜在错误与项目规则。这样可以避免多个工具同时修改同一类格式规则。
安装必要扩展
在 VS Code 的扩展面板中安装 ESLint 和 Prettier - Code formatter。它们对应的扩展 ID 分别是 dbaeumer.vscode-eslint 与 esbenp.prettier-vscode。
如果终端中已经可以使用 code 命令,也可以执行:
code --install-extension dbaeumer.vscode-eslint
code --install-extension esbenp.prettier-vscode预期输出:
两个扩展安装成功;如果某个扩展已经存在,VS Code 会提示其已安装或保持当前版本。写入项目级工作区设置
在项目根目录创建 .vscode/settings.json。项目级配置只影响当前仓库,适合团队共享;个人字体、主题等偏好仍应留在用户设置中。
{
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit"
},
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact"
],
"emmet.includeLanguages": {
"javascript": "javascriptreact"
}
}生效行为:保存支持的源码文件时,Prettier 负责格式化;ESLint 扩展会检查 JavaScript、JSX、TypeScript 与 TSX 文件,并在保存时执行可安全自动修复的 ESLint 动作。emmet.includeLanguages 让 JSX 文件也能使用常见 Emmet 展开。
用一个文件验证整条链路
新建或打开 src/App.jsx,先写成下面这种明显需要格式化的形式,然后保存文件。
export default function App(){const title="React";return <h1>{title}</h1>}预期结果:
保存后代码被自动排版为多行结构。
如果项目启用了对应 ESLint 规则,问题会出现在“问题”面板和编辑器诊断中;可自动修复的问题会按保存设置处理。格式化后的具体引号、分号与换行由项目中的 Prettier 配置决定,因此团队仓库若包含 .prettierrc,应以仓库规则为准,而不是依赖个人偏好。
配置没有生效时怎么查
保存不格式化时,先查看当前文件右下角的语言模式是否正确,再执行“Format Document With...”确认默认格式化器是不是 Prettier。若项目同时安装了其他格式化扩展,默认格式化器冲突是最常见原因之一。
ESLint 没有提示时,依次检查项目依赖、ESLint 配置和 VS Code 的 ESLint 输出日志。可以先在项目终端运行仓库已有的 lint 脚本;如果命令行本身就失败,应先修复项目的 ESLint 配置,而不是反复重装编辑器扩展。
最后把 .vscode/settings.json 提交到仓库前确认团队是否希望共享这些行为。适合共享的是格式化器、保存动作和语言检查范围;主题、字号、窗口布局等个人偏好通常不应写入项目配置。