CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.13.4] - 2026-04-03

Fixed

• Fixed a bug where search mode checkboxes were clipped in the statusbar in app.rs

Changed

• Refactored the statusbar layout logic to size sections to their actual content in app.rs

[0.13.3] - 2026-03-29

Changed

• Refactored the document progress calculation logic to handle empty documents and 100% progress in app.rs

[0.13.2] - 2026-03-28

Added

• Introduced a new SearchStrategy enum to encapsulate the search strategy in app.rs for better type safety.

Changed

• Refactored whether the search should be done in parallel manner in app.rs.

[0.13.1] - 2026-03-27

Fixed

• Fixed a bug where the search info from the previous search would still be shown when entering a new search in app.rs
• Remove stale search highlight when entering a new search in app.rs

[0.13.0] - 2026-03-27

Changed

• Text search now runs in parallel for large documents in app.rs, improving performance.

[0.12.0] - 2026-02-05

Added

• Migrated common types to a new types module in types.rs
• Introduced RfcNum type alias for RFC document numbers in types.rs

Changed

• Restricted RFC document numbers to never include 0 across the codebase, including app.rs, cache.rs, client.rs, toc_panel.rs and main.rs

[0.11.4] - 2026-01-28

Changed

• Refactored event handling logic to redraw only on relevant events in src/main.rs

[0.11.3] - 2026-01-05

Fixed

• Aligned ratatui::backend::Backend::Error's bounds with std::error::Error in main.rs and guard.rs

[0.11.2] - 2025-12-02

Added

• Introduce MAX_POLL_WAIT constant to improve shutdown signal responsiveness during event polling in event.rs

[0.11.1] - 2025-11-19

Added

• Added a new test for the cache in cache.rs

Changed

• Use Box<Path> instead of PathBuf in cache.rs
• Use context for cache initialization in main.rs

[0.11.0] - 2025-11-07

Fixed

• The log files directories are now removed when clearing the log files in logging.rs

Changed

• Add additional logs directory to the log files directory path in logging.rs
• Change log file path to use the new logs directory in logging.rs

[0.10.0] - 2025-11-07

Changed

• Change log file path to use $XDG_STATE_HOME on Linux in logging.rs
• Use &Path instead of PathBuf in logging.rs
• Change log files location to local data directory on non-Linux platforms in logging.rs

[0.9.1] - 2025-11-07

Changed

• Change wording from "log file" to "log files" in logging.rs and main.rs

[0.9.0] - 2025-11-06

Added

• Added a log file rotation mechanism with compression in logging.rs

[0.8.2] - 2025-11-06

Changed

• Use Box<Path> instead of PathBuf in logging.rs

[0.8.1] - 2025-10-29

Added

• Introduce an accessor function instead of directly using the log file path in logging.rs

[0.8.0] - 2025-10-14

Changed

• The search box now supports a cursor for better text editing in app.rs
• Made the search box input prompt constant in app.rs

[0.7.0] - 2025-10-10

Added

• Added support for case-sensitive and regex searches in app.rs and main.rs

Changed

• Regexes are now cached to improve performance in app.rs

[0.6.3] - 2025-09-28

Added

• Added reasons for lint exceptions in main.rs

Changed

• Modified the regex for document section headings in toc_panel.rs
• Replace std::io::Result with anyhow::Result for consistency in error handling in guard.rs
• Slightly refactored search logic in app.rs
• Use total line count instead of the byte count of the document when scrolling the view in main.rs

[0.6.2] - 2025-09-05

Added

• Introduced new lints in Cargo.toml and applied them in app.rs, guard.rs and toc_panel.rs

[0.6.1] - 2025-09-04

Changed

• Refactor the ToC panel creation process in app.rs

[0.6.0] - 2025-08-22

Changed

• Updated dependencies to their latest versions
• Moved the constants to their respective methods in app.rs for better organization
• Use Box<str> instead of String for RFC content and ToC panel contents in cache.rs, client.rs, app.rs and toc_panel.rs

[0.5.4] - 2025-08-14

Changed

• Simplified argument parsing logic in main.rs

[0.5.3] - 2025-08-12

Changed

• Replace context with with_context where format! is used in cache.rs, client.rs, and main.rs

Fixed

• The RFC file is now deleted when writing to it fails in cache.rs

[0.5.2] - 2025-08-11

Changed

• Grouped maintenance commands (--list, --clear-cache, --clear-log) under a single ArgGroup for clearer help output in main.rs

Fixed

• Relaxed positional RFC number requirement when using maintenance flags in main.rs
• Prevented combining an RFC number with maintenance actions (now rejected early) in main.rs

[0.5.1] - 2025-08-10

Changed

• Tightened the argument validation and reduce runtime error paths in main.rs
• The app now warns the user when the window title cannot be set in app.rs
• Avoid panicking when the scroll position is out of bounds in app.rs
• Use constants for UI elements in app.rs

[0.5.0] - 2025-08-09

Changed

• Slightly modified the logging format in logging.rs
• Clamp indexes to the line length to avoid out of bounds access and use safe slicing with str::get for better error handling in app.rs

Removed

• Remove unnecessary std::sync::Mutex from LOG_FILE_PATH as std::sync::LazyLock is thread-safe in logging.rs

[0.4.3] - 2025-08-07

Changed

• Use env!() to avoid hardcoding the crate name in logging.rs and cache.rs
• Refactor cache.rs to warn the user about non-RFC documents, inform about the RFC index
• Improve the RFC number extraction logic and error handling in cache.rs

[0.4.2] - 2025-08-06

Changed

• Disable unused crossterm features in Cargo.toml to reduce compile time
• Roll back crossterm version to 0.28.1 from 0.29.0 to align with ratatui's crossterm dep, avoiding compiling twice

Removed

• Remove rustls dependency from Cargo.toml to use only native-tls for ureq

[0.4.1] - 2025-08-03

Changed

• Replace return Err(anyhow!(...)); with bail!(...) cleaner code in main.rs and cache.rs

[0.4.0] - 2025-07-30

Added

• Added a minimum size for the application in app.rs
• Added a message to the user when the terminal is too small in app.rs

[0.3.1] - 2025-07-30

Changed

• Moved tempfile to dev dependencies.

[0.3.0] - 2025-07-29

Added

• Refactored RfcClient to use native-tls in client.rs
• Added timeout parameter to RfcClient in client.rs

[0.2.4] - 2025-07-29

Changed

• Update lint configuration and adjust thread count for builds

[0.2.3] - 2025-07-15

Changed

• Return Result instead of Option for better error handling in cache.rs

[0.2.2] - 2025-07-13

Changed

• Use binary search instead of relying on HashSet in app.rs

[0.2.1] - 2025-07-13

Changed

• update lint configuration in Cargo.toml

[0.2.0] - 2025-07-11

Added

• Show the version by a -v flag

[0.1.2] - 2025-07-11

Fixed

• Used Option to avoid confusing sentinels in app.rs

[0.1.1] - 2025-07-11

Added

• Early return pattern for search matches to reduce code complexity in app.rs

Changed

• Refactored line highlighting logic in app.rs
• Improved comments in app.rs for clarity and consistency

[0.1.0] - Initial Release

Added

• Core displaying, fetching and caching functionalities