React / 系统课时

配置代码编辑器

配置代码编辑器

代码编辑器的目标不是“装很多插件”,而是让保存格式化、ESLint 修复、Next.js 类型检查和路径补全使用同一套项目配置。下面以 VS Code 为例,把关键设置放进仓库,避免每位开发者只靠本机偏好工作。

学习目标

  • 配置保存时格式化、ESLint 修复和团队推荐插件。
  • 让编辑器使用项目内 TypeScript,并获得 Next.js 类型检查与路径提示。
  • 用命令行验证编辑器提示与项目真实检查结果一致。

固定团队可共享的编辑器基线

VS Code 的项目级配置放在 .vscode 目录中,适合提交到版本库。编辑器插件负责即时反馈,但最终规则仍应来自项目里的 TypeScript、ESLint 和格式化配置;这样本地编辑器、命令行和 CI 才不会给出互相冲突的结论。

先创建 .vscode/extensions.json,只推荐与本课目标直接相关的扩展:

json
{
  "recommendations": [
    "dbaeumer.vscode-eslint",
    "esbenp.prettier-vscode"
  ]
}

这是完整配置文件。打开项目后,VS Code 会识别推荐扩展;是否自动安装取决于用户设置。

再创建 .vscode/settings.json:

json
{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": "explicit"
  },
  "typescript.tsdk": "node_modules/typescript/lib",
  "typescript.enablePromptUseWorkspaceTsdk": true
}

保存文件时,Prettier 负责格式化;如果项目已经配置 ESLint,ESLint 扩展可执行明确的自动修复。typescript.tsdk 指向项目安装的 TypeScript,typescript.enablePromptUseWorkspaceTsdk 会提示你切换到工作区版本;使用工作区 TypeScript 后,Next.js 的 TypeScript 插件才能稳定参与框架相关诊断。

配置路径提示

Next.js 项目通常通过 tsconfig.json 或 jsconfig.json 定义导入别名。下面是片段示例,应合并到现有 tsconfig.json,不要覆盖脚手架已经生成的其他字段:

json
{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@/*": ["./*"]
    },
    "plugins": [
      {
        "name": "next"
      }
    ]
  }
}

此配置把 @/ 映射到项目根目录。保存后,在 TypeScript 文件中输入类似 import x from '@/ 的导入时,编辑器应能继续提示项目内路径;若项目采用 src 目录,可把映射改为 @/* 指向 ./src/*,但导入规则必须与真实目录保持一致。

验证类型检查是否真正生效

编辑器里“没有红线”不等于项目一定可通过检查。对 TypeScript 项目,在项目根目录执行:

bash
npx tsc --noEmit

预期输出:

text
成功时不输出诊断信息,并以退出码 0 结束。

如果命令行报错而编辑器没有提示,优先检查 VS Code 是否正在使用工作区 TypeScript;如果路径导入报错,则核对 paths 的目标目录;如果保存时既格式化又被 ESLint 改回去,应让 Prettier 与 ESLint 的规则职责分离,而不是在两个工具里重复定义同一种格式规则。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

配置代码编辑器

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通