sneak
3e0694e6e0
All checks were successful
check / check (push) Successful in 59s
REPO_POLICIES.md scopes prettier to JS/CSS/Markdown/HTML, but script/fmt
and script/fmt-check covered only '*.md' - top-level markdown. The
canonical scripts use '**/*.md'. Both now run over '**/*.md' and
'**/*.css', and both header comments, which still described the old
top-level-only scope, were rewritten.
That brings themes/loravega/static/css/style.css into the gate. It is
inlined into every page by baseof.html via readFile, and its formatting
is whitespace-only: the minified <style> block in the built
public/index.html is byte-identical across the reformat, which is the
preceding commit.
Two paths are excluded, each with the reason recorded in
.prettierignore so the exclusion reads as a decision rather than an
oversight:
themes/loravega/layouts/ - these are not HTML. They are Go templates
carrying {{ define }}, {{ block }}, {{ .Content }} and
{{ readFile ... | safeCSS }}, and prettier has no Go-template parser; it
would fail or reflow the delimiters into markup Hugo cannot parse.
Covering them needs an out-of-tree plugin and therefore a package.json,
which this repo deliberately does not have.
content/ - excluded on measurement, not on the earlier assumption. With
content/ in scope, prettier re-wrapped one list item in
content/_index.md, and the rendered public/index.html changed with it:
the wrap landed as a literal newline between "7 PM at" and the following
<a> tag. HTML collapses that newline to a space, so the page looks the
same, but the published bytes do not match, and this content carries raw
div/span/br blocks that goldmark passes through verbatim because
hugo.toml sets markup.goldmark.renderer.unsafe = true. A formatter that
can silently change a published page is not worth the consistency.
archetypes/ stays covered - it is a template for new content, not
published output, and prettier leaves it unchanged.
Verified by extracting public/ from the built image before and after.
With the final scope, index.html, index.xml and sitemap.xml are
byte-identical; only the verbatim-copied public/css/style.css differs,
in whitespace. Each commit on this branch passes make check on its own -
the reformat lands first, under the old narrow glob that does not look
at CSS, so the widening commit arrives on an already-clean tree and no
merge commit is required to land it.
22 lines
701 B
Bash
Executable File
22 lines
701 B
Bash
Executable File
#!/bin/sh
|
|
# script/fmt: format this repo's markdown and CSS with prettier, using
|
|
# our standard settings. Scope is every markdown and CSS file in the
|
|
# tree, per REPO_POLICIES.md ("prettier for JS/CSS/Markdown/HTML").
|
|
# What is deliberately NOT covered is recorded in .prettierignore, with
|
|
# the reason next to each entry: the Hugo layout templates, which are
|
|
# Go templates and not HTML, and content/, whose reformatting was
|
|
# measured to change the rendered page.
|
|
set -eu
|
|
|
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
|
|
PRETTIER_VERSION="3.4.2"
|
|
|
|
main() {
|
|
cd "$ROOT"
|
|
npx --yes "prettier@${PRETTIER_VERSION}" --write \
|
|
'**/*.md' '**/*.css' --tab-width 4 --prose-wrap always
|
|
}
|
|
|
|
main "$@"
|