现代Web工程中的HTML代码规范与Lint工具配置指南

夏枫大大_7610

夏枫大大_7610

2026-07-03

991人浏览

原创

htmlhint 配置需适配 html5 及模板语法,关闭默认严格规则;eslint+prettier 无法覆盖可访问性等语义问题,须引入 axe-core 等补充;lint-staged 中 html 文件须链式执行 prettier 后 htmlhint;editorconfig 与 ide 格式化需统一缩进设置。

现代web工程中的html代码规范与lint工具配置指南

HTMLHint 配置必须匹配项目实际语法风格

HTMLHint 默认规则偏向严格 XHTML 风格,比如会报错 <img src="x.jpg">(缺少闭合),但现代 HTML5 允许这种写法。不改配置就直接用,会导致大量误报。

常见踩坑点是没覆盖默认规则,尤其在 Vue/React 项目中内嵌 HTML 片段时:htmlhint 默认不识别 v-if、v-for 或 jsx 属性,会当成非法属性报错。

  • 必须新建 .htmlhintrc 文件,显式关闭干扰项:"attr-lowercase": false(允许大写属性名)、"tag-self-close": false(禁用自闭合校验)
  • 对模板类项目,加 "attr-req-value": false 和 "attr-no-duplication": false,否则 v-bind:title 或 :class 会被拦
  • 若用 Webpack + html-webpack-plugin,需在插件配置里传入 htmlhint: { options: {...} },否则 CLI 检查通过,构建时仍报错

ESLint + Prettier 组合对 HTML 内联脚本的处理边界

ESLint 只管 <script></script> 块里的 JS,不管 HTML 结构;Prettier 能格式化整个 .html 文件,但默认不校验语义或可访问性。两者叠加时,容易漏掉关键问题。

比如 <input type="text" required> 缺少 label 关联,eslint 不报,prettier 也不动——这属于可访问性缺陷,必须靠 axe-core 或 html-validate 补位。

html-to-pptx
html-to-pptx

将多页 HTML 演示文稿转换为美化的 PPTX 文件,便于分享和分发。

下载
  • prettier 的 htmlWhitespaceSensitivity 设为 "css" 才能正确处理 inline 元素间的换行,设成 "strict" 会把 <span>a</span><span>b</span> 强制拆成多行,破坏布局
  • ESLint 的 eslint-plugin-html 插件可提取 script/style 块交给 ESLint 处理,但不支持 <template></template>(Vue)或 <script setup></script>,需额外配 eslint-plugin-vue
  • 如果用 prettier 格式化后 ESLint 报 no-unused-vars,大概率是 Prettier 把变量重命名了(如 const foo = 1 → const _foo = 1),这时要关掉 Prettier 的 proseWrap 或换用 eslint-config-prettier 屏蔽冲突规则

Git pre-commit hook 中 lint-staged 对 HTML 文件的执行顺序陷阱

lint-staged 默认按 glob 匹配并行执行任务,但 HTML 文件常同时被 htmlhint、prettier、stylelint(处理内联 style)调用。顺序错乱会导致格式化后又被 lint 报错,或修复被覆盖。

典型现象:保存后 prettier 把缩进改成 2 空格,htmlhint 却按 4 空格规则检查,立刻标红。

  • 必须在 lint-staged 配置中明确链式调用:"*.html": ["prettier --write", "htmlhint"],不能写成 ["prettier --write", "htmlhint"] 无 glob 键,否则所有文件都跑一遍
  • 若项目含内联 CSS/JS,stylelint 和 eslint 必须放在 prettier 之后,否则 Prettier 格式化会破坏 stylelint 认为合法的缩进(如 CSS 属性换行位置)
  • 注意 htmlhint 的 exit code:默认错误时返回 1,但某些旧版 lint-staged 会因非零退出码中断流程,需加 --quiet 或升级到 v15+ 并启用 ignore 选项跳过警告

EditorConfig 与 IDE HTML 格式化功能的冲突点

EditorConfig 控制基础缩进/换行,但 WebStorm、VS Code 的 HTML 格式化引擎(如 VS Code 的内置 HTML formatter)有独立设置。两者不一致时,保存即打架。

例如 EditorConfig 设 indent_size = 2,而 WebStorm 的 HTML 代码风格设为 4 空格缩进,结果每次保存 HTML 文件,缩进先被 EditorConfig 调整为 2,再被 WebStorm 强制拉回 4。

  • VS Code 用户必须关掉内置 formatter:"html.format.enable": false,改用 esbenp.prettier-vscode 插件,并确保其 prettier 配置与 .editorconfig 中的 indent_size 一致
  • WebStorm 用户要在 Settings > Editor > Code Style > HTML > Tabs and Indents 里勾选 Use tab character 吗?别——除非 .editorconfig 明确写了 indent_style = tab,否则保持空格,且 Tab size 和 Indent 都设为 2
  • Sublime Text 的 HTML-CSS-JS Prettify 插件默认无视 .editorconfig,必须手动在插件设置里填 "indent_size": 2,否则它坚持用 4 空格格式化 <div> 嵌套 实际落地时,最易被忽略的是 HTML 的“语义层”和“结构层”检查分离——<code>htmlhint 管结构,axe-cli 管语义,prettier 管格式,三者缺一不可,但没人自动帮你串起来。

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

相关文章

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

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

下载

相关标签:

html 代码规范

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

相关专题

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

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

2023.06.14

5355

7

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

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

2023.06.21

3092

4

html网页制作
html网页制作

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

2023.07.31

2750

5

html空格
html空格

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

2023.08.01

2779

5

html是什么
html是什么

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

2023.08.11

4659

6

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

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

2023.08.11

2721

3

html转txt
html转txt

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

2023.08.31

2509

3

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

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

2023.09.01

2288

6

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

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

2023.09.20

2268

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共1课时 | 219人学习