VSCode format-on-save reflows the shared footer on every page it touches
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 65/100
- Issue 类型
- 重构
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- html, vscode
调研方向
First, examine the .vscode/settings.json file to understand the current format-on-save configuration. Then, run the provided js-beautify command on a sample HTML file (like coffee.html) to see the changes. The goal is to normalize all footers to be identical, then apply the formatter. After making changes, run pre-commit checks and verify the MegaLinter output to ensure no regressions. The final state should have all shared footer regions byte-identical across pages.
由索引模型根据 Issue 内容生成。
描述
.vscode/settings.json sets "editor.formatOnSave": true, and VSCode's built-in HTML formatter reformats the whole document, not just the region being edited. So editing any page's copy also rewrites its footer, its social links and its <!-- Scripts --> block: exactly the regions CLAUDE.md requires to stay byte-identical across every page.
It happened in #182. A copy pass over coffee.html reflowed the footer's <li> elements, giving that region a third variant. It was spotted in review and restored by hand before committing, but only because someone was looking.
What the formatter is
VSCode's built-in HTML formatter is js-beautify. Its output is reproducible outside the editor:
npx js-beautify@1 --type html --wrap-line-length 120 --indent-size 2 -f coffee.html
That reproduces VSCode's footer byte for byte. Prettier does not: at --print-width 120 it rewrites about 626 lines of index.html, so whatever shaped this tree, it was not Prettier.
The tree is close to js-beautify's shape already. Running it over every page changes about 460 lines in total, roughly 28 a page, and most of that is the footer.
The catch that decides the approach
js-beautify is idempotent but not convergent. It preserves existing newlines, so it keeps whatever line breaks a file already has rather than imposing its own. Running it a second time changes nothing, but running it over pages whose footers already differ leaves them differing: four distinct footer shapes survive the pass.
So "get VSCode to touch all the footers so they agree" does not work by formatting alone. The footers have to be made identical first; formatting then keeps them that way.
Options
A. Turn format-on-save off for HTML. One line in .vscode/settings.json:
"[html]": { "editor.tabSize": 2, "editor.formatOnSave": false }
No diff, no risk, and manual edits stay exactly as typed. It binds only whoever has this repo's settings, and it means hand-formatting new markup.
B. Normalise once, then let the formatter hold the line. Paste one canonical footer into every page, run the formatter over the tree at fixed settings, commit the result. After that, saving an untouched page is a no-op, and saving an edited page reproduces the canonical footer rather than a new variant. One PR of about 460 lines, and it clears the drift in #185 at the same time.
C. Pin the formatter's settings, whichever of A or B is chosen:
"html.format.wrapLineLength": 120,
"html.format.indentInnerHtml": false
Today those are defaults, so a VSCode version that changes a default silently changes the shape of the tree. Pinning them costs nothing.
Recommendation: B and C, with #185's check as the backstop. An editor setting binds one person on one machine; a CI check that the shared regions are byte-identical is what actually makes this survive. B without that check just resets the clock.
Hazards for whoever does B
- Reformatting HTML moves whitespace between inline elements, and whitespace between inline elements is rendered.
render.ymlwill not catch a stray or missing space. The credit badges are the place to look first: their<span>s sit directly against text with no space in between, andcoffee.htmlhas seven of them. - The formatter's output has to keep MegaLinter green. djlint already reports findings locally that MegaLinter never surfaces (#109), so run
pre-commit run --all-filesand check the MegaLinter run on the PR rather than assuming. - The
<!-- Scripts -->block and theis-loadinggate must come through unchanged: same scripts, same order, sameonerrorattributes.
Related: #185 (the check), #182 (where this surfaced), #109 (djlint).
- 主要语言
- HTML
- 星标
- 0
- 派生
- 0
- 平均合并
- 9 小时 52 分钟
- 30 天内合并 PR
- 59
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
laywill/laywill.github.io 的其他 Issue
-
design
难度 2/5 1-3 小时 新手友好度 75/100
laywill/laywill.github.io#186 ·
维护者通常 1 天内回复
-
design
难度 2/5 1-3 小时 新手友好度 68/100
laywill/laywill.github.io#183 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 半天 新手友好度 74/100
laywill/laywill.github.io#135 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
laywill/laywill.github.io#106 ·
维护者通常 1 天内回复
-
infra needs-william
难度 2/5 1-3 小时 新手友好度 82/100
laywill/laywill.github.io#35 · 1 条评论 ·
维护者通常 1 天内回复
查看 laywill/laywill.github.io 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 92/100
-
难度 2/5 1-3 小时 新手友好度 88/100
gruntwork-io/boilerplate#329 ·
-
难度 2/5 1-3 小时 新手友好度 68/100
-
bug
难度 2/5 1-3 小时 新手友好度 88/100
freeCodeCamp/curriculum-helpers#607 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 84/100
PedestrianDynamics/pyFDS-Evac#326 ·
维护者通常 1 天内回复