团队协作下HTML编码规范(Style Guide)的自动化落地

梦瑶姑娘_3715

梦瑶姑娘_3715

2026-07-15

770人浏览

原创

Prettier 配置必须写进 .prettierrc 并提交至 Git,仅靠 VS Code 的 formatOnSave 设置无法保证团队统一;需显式声明 tabWidth、singleQuote(HTML 用双引号)、htmlWhitespaceSensitivity、endOfLine 等关键项,避免属性顺序混乱、CRLF 污染及格式不一致。

团队协作下html编码规范(style guide)的自动化落地

prettier 配置必须写进 .prettierrc,不能只靠编辑器设置

VS Code 里开 formatOnSave 只对当前用户生效,新人 clone 项目后若没手动启用 Prettier 插件,

就可能变成
,属性顺序一乱,diff 就全是噪音。真正的落地点是配置文件本身:
  • .prettierrc 必须提交到 Git,且至少包含 tabWidth: 2、singleQuote: false(HTML 属性强制双引号)、htmlWhitespaceSensitivity: "css"
  • 不推荐用 printWidth: 100 处理 HTML:长 data-* 属性会被硬折行,破坏可读性;设为 80 或保留默认 80 更稳妥
  • endOfLine: "lf" 要显式声明,否则 Windows 用户提交的 CRLF 会污染 CI 流水线中的校验结果

stylelint 管类名,prettier 不管命名逻辑

很多人以为 prettier 能约束 btn-primary 还是 primary-btn,其实它完全不碰类名内容。真正起作用的是 stylelint 的 selector-class-pattern 规则:

  • 在 .stylelintrc 中配 "^[a-z][a-zA-Z0-9-]*$",直接拦截 BigRedBtn 或 user_name
  • 配合 stylelint-selector-bem-pattern 插件可强制 BEM,但别全量启用——组件库可用,业务页面过度约束反而拖慢迭代
  • 模板文件(如 _header.html)里预埋带注释的类名示例:,比口头培训管用

husky + lint-staged 必须限定 HTML 文件范围

git commit 时跑全量 prettier --write 很慢,尤其当项目混着 Vue/JSX,Prettier 会尝试解析 .vue 里的 template,报一堆无关错误。关键在 lint-staged 的匹配规则:

  • 配置 "*.html": ["prettier --write"],不要写成 "**/*.{html,htm}" —— 某些构建产物目录(如 dist/)下的 HTML 也会被误触
  • 加一层保护:在 package.json 的 scripts 里定义 "prettier:check": "prettier --check \"src/**/*.html\"",CI 阶段只校验不修改
  • 如果用了 eslint-plugin-html 做语义检查,记得把它和 prettier 分开运行——二者规则维度不同,混在一起容易漏报 缺 alt 这类问题

空行和注释必须参与自动化校验

空行不是“视觉舒适区”,而是模块边界的信号;注释也不是可有可无的说明,而是维护线索。这两项恰恰最难靠人工坚持,必须进工具链:

财经HTML高端海报生成
财经HTML高端海报生成

复杂得财经如何变成清晰,适合手机看的海报?如何加上你的IP

下载
  • Prettier 默认不处理空行逻辑,得用 prettyhtml 替代,或在 .prettierrc 加 "htmlWhitespaceSensitivity": "ignore" + 自定义插件
  • 注释强制英文不是为了洋气,而是避免 在某些 Webpack loader 里因编码识别失败导致构建中断
  • 关键 data-* 属性旁必须跟注释,例如
    ;这类注释可用正则在 CI 中扫描,缺失即 fail

    实际落地最易被忽略的点:所有配置文件(.prettierrc、.stylelintrc、.editorconfig)必须出现在 git status 的 tracked 列表里。有人把它们加进 .gitignore,以为“配置是个人偏好”,结果团队永远在同步一套不存在的标准。

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

相关文章

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

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

下载

相关标签:

html格式化 html

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

相关专题

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

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

2023.06.14

6955

7

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

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

2023.06.21

3852

4

html网页制作
html网页制作

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

2023.07.31

3510

5

html空格
html空格

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

2023.08.01

3539

5

html是什么
html是什么

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

2023.08.11

5099

6

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

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

2023.08.11

3481

3

html转txt
html转txt

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

2023.08.31

3289

3

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

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

2023.09.01

2848

6

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

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

2023.09.20

2988

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共1课时 | 232人学习