Skip to content

supdoc v0.1.2

Choose a tag to compare

@aidenzepp aidenzepp released this 01 Nov 17:18
· 341 commits to main since this release
c8abc9d

supdoc v0.1.2 is a fix release. Nothing in the lockfile format or the config schema changes, so v0.1.1 projects work unchanged.

Faster

supdoc check on a project with 20,000 links drops from 10.9 s to 1.6 s (6.8x), measured with hyperfine on the same project and machine. Output is unchanged.

  • Lock parsing and finding locations no longer count newlines from the start of the file for every link (#70).
  • A comment region with no [ is no longer parsed for links (#65).

Stays inside the project

  • list TARGET#symbol no longer reads outside the project root, and a target that resolves outside it is refused with cli-path-outside-project (#75, #76, fixes #60).
  • A target path containing .. is refused when parsed (#75).
  • A target that is not a regular file, such as a FIFO, is refused instead of hanging list, check or resolve (#75).

Fewer silent surprises

  • list TARGET refuses a misspelled symbol, a missing file or an unknown namespace instead of printing "No links" and exiting 0 (#76).
  • A doc file whose name is not a valid source path is reported as a scan-invalid-source-path warning instead of being skipped silently (#71).
  • Naming a file under a symlinked directory warns with scan-explicit-path-symlinked instead of blaming a nonexistent ignore rule (#68).

Clearer errors

  • A failed link prints supdoc update PATH --yes with a path that runs from where you ran check, quoted (#74).
  • supdoc resolve FILE#SYMBOL says to write supdoc resolve FILE SYMBOL (#74).
  • resolve suggests only close symbol names, explains that line anchors are unsupported, and says to link the whole file when a file has no symbols (#72).
  • A broken supdoc.lock header says to write version = 1 or to recreate the lock, not to delete an entry (#69).
  • extends naming a directory, and include given a string, now say what to write instead (#73).
  • The unknown --format tip points at --output json and --json (#66).

Internal

  • CI token is read-only, actions are pinned to commit SHAs, and a cargo-deny job runs (#64).
  • Removed the unused Trace verbosity and the empty output::schema module. The cli-not-built error code is gone (#67).
  • Tests: dropped fixture-only goldens and added rename lock/config guards (#77); pinned the JSON fix object and the SUPDOC_YES / SUPDOC_DRY_RUN writes (#78).

New codes

  • scan-invalid-source-path (warning)
  • scan-explicit-path-symlinked (warning)
  • cli-resolve-fragment (error, exit 2)