Skip to content

supdoc v0.1.1

Choose a tag to compare

@aidenzepp aidenzepp released this 30 Oct 21:13
· 358 commits to main since this release
5d1260f

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

Containment: what supdoc reads outside the project

The README now has a threat model: supdoc protects the contents of files outside the project root, not whether a path exists. These fixes make the code keep that promise.

  • extends is refused alike whether it leaves the root or goes through a symlink (#27).
  • Config discovery no longer reveals whether a symlink target exists (#23).
  • skill install refuses a project install through a symlink out of the root (#18).
  • resolve refuses a FILE outside the project root (#58).
  • Ignore files symlinked out of the root no longer decide what is scanned, and their rules are never quoted (#24).
  • A symlinked ignore file above the project root is not read (#56).

Ignore files work like git

  • Parent ignore files stop at the top of the git work tree (#48).
  • A nested repository or submodule starts a fresh ignore chain (#59).
  • A submodule's exclude file is read, global excludes are anchored at the work-tree top, and a .git counts only when git would use it (#49).
  • A symlinked .gitignore or .ignore inside the project is ignored, as git does (#42).
  • Sources under an unreadable directory are reported as unread (#17).
  • The README lists the remaining differences from git (#61).

Config and project discovery

  • One presence rule for supdoc.config.toml in discovery and the nested-project check (#37).
  • skill install finds the project root with config discovery (#39).
  • skill install --config refuses a path that is not an existing file (#57).

Messages and output

  • check and update print findings by file, then position (#22).
  • update closes on the plan and reports the line-endings change in JSONL (#15).
  • rename prints walk findings in text output (#47).
  • Files are named relative to the project in messages and runnable helps (#26).
  • A PATH that can't be looked up is reported as unreadable, not missing (#36).
  • extends errors say it must lead to a readable supdoc.config.toml (#38).
  • Help texts that misled are now runnable and effective (#19), and ignore-file wording no longer over-claims (#29).

Docs and packaging

  • README: threat model (#43, #61) and the schema_version compatibility policy (#14).
  • The packaged crate's tests compile and skip repository-only checks (#16).

Known issues

  • #60: supdoc list TARGET#symbol parses a file outside the root reached through an in-root symlink. No text or symbol names from that file are printed. Until this is fixed, the README's promise that supdoc lists no symbols from outside files does not hold for list.
  • #51: a file that an outer .gitignore ignores is still scanned. This is documented under "Differences from git".

Full changelog: v0.1.0...v0.1.1