Skip to content

ds 0.1.8 — the CLI (downloads)

Choose a tag to compare

@khanakia khanakia released this 11 Oct 07:28
· 7 commits to main since this release

ds 0.1.8: copies ds refresh cannot write are reported instead of staying stale forever, and directives are read only where they are real. Fixes issue 4.

What changed

  • A lines= range that does not fit its block is reported as what it is. In repo mode, a ds:block whose lines= ran past the end of the block (or was not a range, such as lines=abc) was reported stale with "run ds refresh" as the fix, forever: refresh skipped the copy without saying why, and ds ack did not clear it. ds check now reports it as range, an error where the page owes a copy, with "adjust lines=" as the fix (bug 136).
  • ds refresh never skips a copy silently. It names each copy it could not write, and why, and each copy it wrote with only its caption and link:
    $ ds refresh
    0 repo-mode copies rewritten
    skipped doc.md:3: lines=1-46 is outside the block's 45 lines
    1 repo-mode copies skipped
    0 moved; ledger updated
    
    --dry-run prints the same. The library has System.FencesReport for the same notes.
  • The same class, fixed with it. A copy citing env=prod was rendered from another environment's def and stayed stale (bug 137). A ds:block of a secret, which never renders, stayed stale; it is now a problem naming a carrier that works (bug 138). In build mode, a copy already in a page was compared but never refreshed; ds refresh now keeps it current and adds none (bug 141).
  • Directives are read only where they are real (SPEC "Reading directives" is now a table). A ds: link inside a JSON string or CSV cell is data, not a citation (bug 139). A whole-line ds:block outside a comment in JSON, CSV, go.sum, .gitignore and similar files is reported as damage instead of read as a citation (bug 140). A link inside a YAML, TOML or HCL comment is now a citation, as in every other comment (bug 142). A bare ds:def line in INI, env, HTML, Markdown and AsciiDoc files is now reported, as it already was in code (bug 143). A link inside a string literal in code is a citation, because strings hold prose; a whole-line directive in a string is not.

To update: ds update (or wait for the daily automatic update). Full list in the changelog; the decisions and their reasons are in SPEC §36.

Install

macOS (Apple silicon) and Linux (amd64, arm64):

curl -fsSL https://raw.githubusercontent.com/ubgo/docsync/main/install.sh | sh

Windows (amd64, ARM64), in PowerShell:

irm https://raw.githubusercontent.com/ubgo/docsync/main/install.ps1 | iex

With Go 1.26+ and a C compiler:

go install github.com/ubgo/docsync/cli/cmd/[email protected]

Every archive holds ds and the six secret-resolver plugins, with a checksums.txt.