HTML / CSS / 系统课时

配置编辑器开发体验

配置编辑器开发体验

本课把 Tailwind CSS 的类名提示、悬停预览、冲突检查和保存时排序统一到项目配置中。完成后,新成员打开仓库即可获得一致的编辑体验,并能用命令验证格式化是否真正生效。

学习目标

  • 检查 Tailwind CSS 与 Node.js 是否已被当前工作区识别
  • 用工作区文件声明推荐扩展和统一编辑器设置
  • 配置 Prettier 类名排序,并完成一次端到端验证

完成前置检查

先在项目根目录确认 Node.js、npm 和 Tailwind CSS 都可用。Tailwind CSS IntelliSense 需要从当前工作区识别 Tailwind 安装与样式入口;只在全局安装工具而项目中没有依赖,通常无法得到稳定提示。

bash
node --version
npm --version
npm ls tailwindcss --depth=0

预期输出

text
v<VERSION>
<VERSION>
<PROJECT_NAME>@<VERSION> <PATH>
└── tailwindcss@<VERSION>

<VERSION>、<PROJECT_NAME> 和 <PATH> 会随本机环境变化。若最后一条命令报告缺少依赖,先在项目根目录执行 npm install tailwindcss,再重新检查。

声明工作区推荐扩展

在根目录创建 .vscode/extensions.json。该文件不替用户自动安装扩展,但会在打开仓库时给出统一推荐,避免团队成员各自猜测插件名称。

json
{
  "recommendations": [
    "bradlc.vscode-tailwindcss",
    "esbenp.prettier-vscode"
  ]
}

Tailwind CSS IntelliSense 提供工具类补全、语法高亮、悬停预览和 Tailwind 专用检查;这些能力比普通 CSS 补全更适合包含自定义指令与大量工具类的模板。:contentReference[oaicite:0]{index=0}

配置格式化与类名排序

安装 Prettier 与 Tailwind 官方排序插件,并用 npm ls 立即验证项目依赖,而不是只观察安装日志。

bash
npm install -D prettier prettier-plugin-tailwindcss
npm ls prettier prettier-plugin-tailwindcss --depth=0

预期输出

text
<PROJECT_NAME>@<VERSION> <PATH>
├── prettier@<VERSION>
└── prettier-plugin-tailwindcss@<VERSION>

随后创建 .prettierrc.json。以下配置按 Tailwind CSS v4 项目编写,tailwindStylesheet 指向包含 @import "tailwindcss"; 的主样式文件。

json
{
  "plugins": ["prettier-plugin-tailwindcss"],
  "tailwindStylesheet": "./src/styles/app.css"
}

Tailwind CSS v3 项目应改用 tailwindConfig 指向 tailwind.config.js。官方插件会按推荐顺序整理工具类;v4 项目需要提供样式入口,v3 项目则使用 JavaScript 配置路径。:contentReference[oaicite:1]{index=1}

再创建 .vscode/settings.json,把保存格式化和关键检查固定为工作区行为。

json
{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "tailwindCSS.validate": true,
  "tailwindCSS.lint.invalidApply": "error",
  "tailwindCSS.lint.cssConflict": "warning",
  "tailwindCSS.lint.suggestCanonicalClasses": "warning"
}

验证提示、排序与排障路径

在 src/index.html 写入一段故意打乱顺序的类名。这个文件只用于验证,可在确认后删除。

html
<button class="text-white px-4 sm:px-8 py-2 sm:py-3 bg-sky-700 hover:bg-sky-800">
  Submit
</button>

执行 Prettier,并观察标准输出中的格式化结果。

bash
npx prettier src/index.html

预期输出

html
<button class="bg-sky-700 px-4 py-2 text-white hover:bg-sky-800 sm:px-8 sm:py-3">
  Submit
</button>

再回到编辑器完成三项人工验证:输入 bg- 能看到候选,悬停 px-4 能看到生成的 CSS,把 p-4 p-6 写在同一元素上会出现冲突警告。若没有任何提示,先确认扩展已启用,再运行命令面板中的 Tailwind CSS: Show Output 查看语言服务器日志;多入口项目可显式设置 tailwindCSS.experimental.configFile。:contentReference[oaicite:2]{index=2}

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

目录与阅读设置

阅读设置

17

记录一个想法

配置编辑器开发体验

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

登录哪都通