Repository navigation
Release v0.5.0
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).
- Dry-run ⇒
- Apply intent plumbing end-to-end:
Config.apply_changes(tri-state) consumed viaapply_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
-vfor more detail). filetypesandprocessorsnow 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 (
PREVIEWEDvs terminal write statuses).
- Apply vs preview consistently reflected in per-file results (
🐛 Fixed
- Pre-commit hooks
- Removed redundant
--quiet(default output already terse). - Fixed flag placement.
- Removed redundant
📖 Docs
- Refreshed CLI docs:
- Explicit subcommands in examples.
- Stdin examples use
topmark check - …. - Clarify dry-run vs apply summary text (
- previewedvs- inserted/- replaced/- removed). - Added “Numbered output & verbosity” notes to
filetypes/processors. - Added
versioncommand page; tidied headings and separators.
⚠️ Breaking (pre-1.0)
- Dry-run summaries now end with
- previewedinstead of terminal verbs.- Update any scripts/tests parsing summaries that previously matched
- inserted/- removed/- replacedduring dry-run.
- Update any scripts/tests parsing summaries that previously matched
- Human-readable CLI output may differ (verbosity-gated banners and numbered lists).
📦 Installing / Upgrading
pip install -U topmarkLinks
- PyPI: https://pypi.org/project/topmark/
- Docs: https://shutterfreak.github.io/topmark/
- Full changelog: see
CHANGELOG.mdin the repo - Full Changelog: v0.4.0...v0.5.0