Repository navigation
Immutable
release. Only release title and notes can be modified.
supdoc v0.6.0 checks code blocks in SQL, HTML, Makefile and XML end to end, and adds npm packages that carry the release binaries. The lockfile format is unchanged. What shipped is in the v0.6.0 milestone.
Install
- From v0.6.0 on,
npx supdocruns supdoc andnpm i -g supdocinstalls it. Thesupdocpackage pulls in one@supdoc/<os>-<cpu>package holding the release binary for macOS, Linux (statically linked) or Windows, on x64 or arm64. Nothing is compiled and no install script runs (#402). supdoc upgraderefuses a binary that an npm package installed and prints the npm command to run instead, so it never rewrites a file insidenode_modules.
More code-block languages
Each language is turned on by its own table, such as [features.code-blocks.xml].
- SQL blocks are now linted with sqruff as well as formatted. An unparsable block fails, and a
noqacomment can't hide a parse error (#437). - HTML blocks are now linted with biome as well as formatted with superhtml (#436).
- Makefile blocks (tagged
make,makefile,Makefileormk) are formatted with mbake and linted with checkmake. supdoc never asks mbake to validate, which would runmake, and always passes each tool a vetted copy of the project's config (#439). - XML blocks (tagged
xml,svg,xsd,xsl,xsltorxhtml) are linted and formatted with xmllint, without network access or catalogs. A block whose DOCTYPE names an external identifier or that declares an entity is left unchecked with a warning (#440).
Also
- The remaining code-block read guards refuse a root that can't be resolved, and tests pin it (#454).
Full changelog: v0.5.0...v0.6.0