Skip to content

v0.5.0

Choose a tag to compare

@github-actions github-actions released this 10 Nov 21:26
· 11 commits to main since this release
Immutable release. Only release title and notes can be modified.
f567032

supdoc v0.5.0 ships prebuilt binaries for eight targets, builds and runs on Windows, and checks code blocks in four more languages. The lockfile format is unchanged. The JSON output of supdoc upgrade gains fields; nothing is removed. Most of what shipped is in the v0.5.0 milestone; SQL and HTML formatting are the first parts of #437 and #436, which stay open for v0.6.0.

Upgrading

  • A v0.4.0 release binary can't upgrade itself. supdoc upgrade for a downloaded binary starts at v0.5.0, so download the v0.5.0 archive by hand once. A cargo install upgrades through cargo as before (#370).

Install

  • Each release carries prebuilt archives for eight targets: macOS (arm64, x86_64), Linux (arm64, x86_64, each glibc and musl) and Windows (x86_64, arm64), with a SHA256SUMS file and build attestations (#368).
  • cargo binstall supdoc installs the prebuilt binary (#405).
  • From v0.5.0 on, releases are immutable: a published release's assets can't be replaced (#403).
  • supdoc upgrade [VERSION] now also upgrades a downloaded release binary. It fetches the archive with the system curl over HTTPS from GitHub, checks it against SHA256SUMS, and replaces the binary in place; on Windows the old one is left as supdoc.exe.old, which a later upgrade removes. A cargo install still upgrades through cargo, except on Windows, where upgrade prints the cargo command to run from another shell. Any other install is refused with the manual step. Without --yes it only previews (#370, #431).
  • supdoc upgrade --json gains method (cargo or release-binary), asset, sha256 and notes.

Windows

  • supdoc builds and its test suite passes on Windows x86_64 and arm64, and both are required CI checks. The trust store and the code-block cache live under %LOCALAPPDATA%\supdoc (#369).

More code-block languages

Each language is turned on by its own table, such as [features.code-blocks.sql].

  • CSS and SCSS blocks are formatted and linted with biome (#441).
  • Dockerfile blocks (also tagged containerfile) are linted with hadolint and formatted with dockerfmt (#438).
  • SQL blocks are formatted with sqruff. dialect in [features.code-blocks.sql] picks the dialect (ansi by default), and a block tagged with a dialect, such as postgres or tsql, uses it whatever the setting says. There is no built-in SQL linter yet (#437).
  • HTML blocks are formatted with superhtml. A block holding a <textarea>, <xmp>, <listing>, <plaintext> or <noscript>, or a <script> or <style> whose body superhtml would rewrite, is left unformatted with a warning. There is no built-in HTML linter yet (#436).
  • linter = "markdownlint-cli2" in [features.code-blocks.markdown] is refused with an explanation: markdownlint-cli2 can't apply its per-directory config to a block passed on stdin. Use rumdl or a custom linter = { command = [...] } (#325).

Also

  • supdoc skill install --target agents or --target claude writes only that one skill copy (#401).
  • TypeScript, TSX and JavaScript get symbols for the keys of a default-exported object (#404), and for a namespace A.B.C.D of four to ten parts (#249).
  • supdoc init works on a filesystem without hard links (#250).
  • check, update, fix and list check a path as typed: nope/.. exits 2 with cli-path-missing when nope doesn't exist, instead of checking the whole project, and so does file.md/.. (#248).
  • The link-outside-root help for a namespace link that climbs out of its namespace no longer suggests moving the config (#251).
  • Code-block read guards use one shared containment check (#371), and raw path joins outside the path module fail clippy in CI (#357).

Full changelog: v0.4.0...v0.5.0