萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網頁製作 >> HTML5 教學

HTML 格式化/美化完整指南:編輯器設定、命令列工具、CI 整合與團隊規範

為什麼要格式化 HTML?

  • 統一縮排、換行、屬性順序,降低認知負荷
  • Git Diff 乾淨,Code Review 專注邏輯而非格式
  • 配合 Prettier/HTMLHint 等工具自動化,零心智負擔
  • 團隊新成員零學習成本遵循規範

主流編輯器一鍵格式化

編輯器快捷鍵設定檔備註
VS CodeShift+Alt+F (Win) / Shift+Option+F (Mac).vscode/settings.json + .prettierrc內建格式化,推薦 Prettier 擴充
WebStorm/PhpStormCtrl+Alt+LSettings > Editor > Code Style > HTML強大內建,可匯出 .editorconfig
Sublime Text需安裝 HTML-CSS-JS PrettifyPackage Settings需 Node 環境
Vim/Neovimgg=G (內建) 或 neoformat/conform.nvim.vimrc/init.lua搭配 Prettier/LSP

命令列工具:Prettier 為標準

# 安裝
npm i -D prettier

# 格式化單檔
npx prettier --write index.html

# 格式化整個專案
npx prettier --write "**/*.html"

# 檢查不修改 (CI 用)
npx prettier --check "**/*.html"

.prettierrc 推薦設定

{
  "printWidth": 120,
  "tabWidth": 2,
  "useTabs": false,
  "singleQuote": false,
  "bracketSameLine": false,
  "htmlWhitespaceSensitivity": "css",
  "endOfLine": "lf"
}

屬性排序建議

Prettier 不強制屬性排序,建議搭配 @html-eslint/parser + eslint-plugin-html 自訂規則,或使用 HTMLHint 規則 attr-order:

"attr-order": [
  "id",
  "class",
  "name",
  "data-*",
  "src", "href",
  "type", "value",
  "placeholder",
  "disabled", "readonly", "required",
  "style",
  "on*"
]

CI/CD 整合

# GitHub Actions 範例
- name: Check HTML formatting
  run: npx prettier --check "**/*.html"

# Husky + lint-staged (提交前自動格式化)
# package.json
"lint-staged": {
  "*.html": ["prettier --write", "git add"]
}

避坑指南

  • 不要手動調整格式 — 交給工具,專注業務邏輯。
  • 模板語法衝突:Jinja2, Blade, Twig, Vue SFC 的模板語法可能被 Prettier 誤判 → 使用 prettier-plugin- 對應插件或 // prettier-ignore。
  • 大檔案效能:超過 500KB HTML 格式化較慢,考慮拆分元件/局部。
  • 舊專案一次性格式化:單獨 PR,標明「chore: format html」,避免混入功能變更。

延伸閱讀

copyright © 萬盛學電腦網 all rights reserved