统一团队风格的HTML代码质量与格式化实战

梦墨吖_5235

梦墨吖_5235

2026-07-06

484人浏览

原创

vs code 保存时 html 不自动格式化,需关闭内置格式化、设 prettier 为默认格式化工具、启用 formatonsave;调整 htmlwhitespacesensitivity 和 wraplinelength;用 .editorconfig 统一缩进;ci 中需显式指定 glob 路径并验证。

统一团队风格的html代码质量与格式化实战

VS Code 保存时 HTML 不自动格式化?检查这三项配置

根本原因不是插件没装,而是 VS Code 没把 prettier 设为 HTML 的默认格式化工具。很多人只装了插件却漏掉关键绑定。

  • 打开 .vscode/settings.json,确认含以下配置:
    "html.format.enable": false,
    ——必须关掉内置 HTML 格式化,否则和 Prettier 冲突
  • 添加:
    "editor.defaultFormatter": "esbenp.prettier-vscode"
    (注意插件 ID 要准确)
  • 确保 editor.formatOnSave 为 true,且该设置未被工作区或用户级配置覆盖

prettier 对 HTML 标签换行太激进?调 htmlWhitespaceSensitivity

默认值 "css" 会让 Prettier 尽量保留空白以兼容 CSS white-space 行为,但容易把简单标签(如 <span></span>)强行拆成多行,破坏内联语义。

html-deploy
html-deploy

使用 htmlcode.fun 将 HTML 内容或文件部署到网页,适用于用户要求“部署到网页”“托管此 HTML”“生成此前端...的实时链接”等场景。

下载
  • 若项目大量使用内联元素,改用:
    "htmlWhitespaceSensitivity": "strict"
    —— 更保守,只在必要处换行
  • 配合 "html.format.wrapLineLength": 120(而非默认 80),避免短标签被无谓折行
  • 对需原样保留的标签,用 unformatted 列表排除:
    "html.format.unformatted": ["code", "pre", "textarea"]

团队成员缩进不一致?.editorconfig 比编辑器设置更可靠

VS Code 用户级缩进设置会被覆盖,而 .editorconfig 是项目级强制规则,Git 提交时就能拦截混用 Tab/空格的文件。

  • 根目录必须有 .editorconfig,且包含:
    [*.html]\nindent_style = space\nindent_size = 2
  • 别只写 [*] 全局规则——HTML 文件可能被其他语言规则覆盖,显式声明 [*.html] 才生效
  • 验证是否生效:新建一个 test.html,按 Tab 键,应直接插入 2 个空格,而非制表符

CI 流程里 Prettier 检查总失败?先确认 --list-different 路径匹配

本地跑 npx prettier --check "**/*.html" 成功,但 CI 报“no files found”,大概率是 glob 路径没适配 CI 环境的工作目录结构。

  • CI 中常用 npm run format:check,对应脚本应写为:
    "format:check": "prettier --check \"src/**/*.html\" \"public/**/*.html\""
    —— 显式限定路径,避免依赖 shell 展开
  • CI 容器中 Node 版本较低时,** 可能不被支持,降级用 src/*/**/*.html
  • 检查 Git 忽略文件(.gitignore)是否误 exclude 了 HTML 模板目录,导致 Prettier 扫不到文件
真正卡住团队的从来不是工具选型,而是 .editorconfig 里少写一行 [*.html],或是 CI 脚本里 glob 路径没加引号。这些点不手动验证,光靠文档说明根本挡不住实际提交时的报错。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

HTML速学教程(入门课程)
HTML速学教程(入门课程)

HTML怎么学习?HTML怎么入门?HTML在哪学?HTML怎么学才快?不用担心,这里为大家提供了HTML速学教程(入门课程),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

html

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
html版权符号
html版权符号

html版权符号是“©”,可以在html源文件中直接输入或者从word中复制粘贴过来,php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.14

5275

7

html在线编辑器
html在线编辑器

html在线编辑器是用于在线编辑的工具,编辑的内容是基于HTML的文档。它经常被应用于留言板留言、论坛发贴、Blog编写日志或等需要用户输入普通HTML的地方,是Web应用的常用模块之一。php中文网为大家带来了html在线编辑器的相关教程、以及相关文章等内容,供大家免费下载使用。

2023.06.21

3052

4

html网页制作
html网页制作

html网页制作是指使用超文本标记语言来设计和创建网页的过程,html是一种标记语言,它使用标记来描述文档结构和语义,并定义了网页中的各种元素和内容的呈现方式。本专题为大家提供html网页制作的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.31

2710

5

html空格
html空格

html空格是一种用于在网页中添加间隔和对齐文本的特殊字符,被用于在网页中插入额外的空间,以改变元素之间的排列和对齐方式。本专题为大家提供html空格的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.01

2739

5

html是什么
html是什么

HTML是一种标准标记语言,用于创建和呈现网页的结构和内容,是互联网发展的基石,为网页开发提供了丰富的功能和灵活性。本专题为大家提供html相关的各种文章、以及下载和课程。

2023.08.11

4639

6

html字体大小怎么设置
html字体大小怎么设置

在网页设计中,字体大小的选择是至关重要的。合理的字体大小不仅可以提升网页的可读性,还能够影响用户对网页整体布局的感知。php中文网将介绍一些常用的方法和技巧,帮助您在HTML中设置合适的字体大小。

2023.08.11

2701

3

html转txt
html转txt

html转txt的方法有使用文本编辑器、使用在线转换工具和使用Python编程。本专题为大家提供html转txt相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.31

2469

3

html文本框代码怎么写
html文本框代码怎么写

html文本框代码:1、单行文本框【<input type="text" style="height:..;width:..;" />】;2、多行文本框【textarea style=";height:;"></textare】。

2023.09.01

2248

6

HTML嵌入CSS样式的方法
HTML嵌入CSS样式的方法

HTML嵌入CSS样式的方法有内联样式、内部样式表和外部样式表。本专题为大家提供CSS样式相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.20

2248

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
GDB 17.2 官方文档集合
GDB 17.2 官方文档集合

共0课时 | 0人学习

Bootstrap 入门安装配置
Bootstrap 入门安装配置

共0课时 | 0人学习

38+ PhpStorm 提示和技巧
38+ PhpStorm 提示和技巧

共1课时 | 219人学习