Skip to content

Release v0.5.0

Choose a tag to compare

@github-actions github-actions released this 09 Sep 20:54
· 1014 commits to main since this release

TopMark v0.5.0 — Release Notes

✨ A feature release introducing apply vs dry-run consistency, improved CLI output, and better configuration handling.

✨ Added

  • Honest write statuses across the pipeline:
    • Dry-run ⇒ WriteStatus.PREVIEWED.
    • Apply (--apply) ⇒ terminal statuses (INSERTED, REPLACED, REMOVED).
  • Apply intent plumbing end-to-end:
    • Config.apply_changes (tri-state) consumed via apply_cli_args() and respected in updater.
    • CLI and public API forward apply to the pipeline.

🔄 Changed

  • CLI & console output
    • Decoupled program-output verbosity from internal logging.
    • All user output routed through ConsoleLike.
    • Banners/extra guidance gated by verbosity (quiet by default; add -v for more detail).
    • filetypes and processors now render numbered lists with right-aligned indices.
    • dump-config / init-config: emit plain TOML by default; BEGIN/END markers at higher verbosity.
  • Public API (behavioral)
    • Apply vs preview consistently reflected in per-file results (PREVIEWED vs terminal write statuses).

🐛 Fixed

  • Pre-commit hooks
    • Removed redundant --quiet (default output already terse).
    • Fixed flag placement.

📖 Docs

  • Refreshed CLI docs:
    • Explicit subcommands in examples.
    • Stdin examples use topmark check - ….
    • Clarify dry-run vs apply summary text (- previewed vs - inserted/- replaced/- removed).
    • Added “Numbered output & verbosity” notes to filetypes / processors.
    • Added version command page; tidied headings and separators.

⚠️ Breaking (pre-1.0)

  • Dry-run summaries now end with - previewed instead of terminal verbs.
    • Update any scripts/tests parsing summaries that previously matched - inserted / - removed / - replaced during dry-run.
  • Human-readable CLI output may differ (verbosity-gated banners and numbered lists).

📦 Installing / Upgrading

pip install -U topmark

Links