From b4dfdfff4b3b6008a4ab04337a497b8ae7a7c558 Mon Sep 17 00:00:00 2001 From: Andret Carpizo Date: Tue, 26 Dec 2023 01:29:19 -0600 Subject: [PATCH] Release v2.0.0 --- CHANGELOG.md | 61 ++++++--------------------------------------------- Cargo.lock | 2 +- Cargo.toml | 2 +- Makefile.toml | 2 +- 4 files changed, 10 insertions(+), 57 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1cf09f3..07423f2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,67 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/). ## [[Unreleased]] - 2023-12-25 -### Added -- IconKind:: - - NfFaFolder - - NfFaFolderOpen - - NfFaeEqual - -### Removed -- Remove: DEVLOG.md -- Remove: mutex lock on color_fn -- Remove: whisper_or_else +## [2.0.0] - 2023-12-26 ### Breaking Changes -- NfMd Variants are deprecated and will be replaced by their equivalent NfFa Variant in the next release - - NfMdGreaterThan - - NfMdLessThan - - NfMdEqual - - NfMdThumbsUp - - NfMdThumbsDown - - NfMdFolder - - NfMdFolderOpen +- Breaking Change: NfMd Variants are deprecated and will be replaced by their equivalent NfFa Variant in the next release +- Breaking Change: #[non_exhaustive] attribute to WhisperError enum +- Breaking Change: non_exhaustive attribute to IconKind enumeration +- Breaking Change: Remove all md variants from icon_map.rs -- Add: IconKind enum has been marked #[non_exhaustive]. - - Pattern-matching on it outside of its crate must now include a wildcard pattern like `_`, or it will fail to compile. - -### Configuration -- Allow: deprecated code in Cargo.toml lints settings. +### Changed +- Refactor: from Mutex to RwLock on ICON_MAP . ### Added -- Add: example -- Add: new test functions to lib.rs - Add: whisper_err and whisper_out experimental -- Add: non_exhaustive attribute to IconKind enumeration - Add: examples folder -- Add: whisper_with_fallback method experimental - -### Documentation -- Update: README.md content and structure -- #![doc(html_root_url = "https: //docs.rs/murmur/")] -- Update: lib.rs documentation structure -- Update: `IconKind` enum link in documentation -- Refactor: some crate docs to example . - -### Fixed -- Breaking: Change #[non_exhaustive] attribute to WhisperError enum -- Refactor: `Display` trait implementation for `IconKind` to include error handling. - -### Changed -- Update: gitignore -- Update: Makefile.toml tasks -- Refactor: from Mutex to RwLock on ICON_MAP in lib.rs file. -- Refactor: from Mutex to RwLock in ICON_MAP in color_map.rs -- Refactor: color map type definitions in color_map.rs -- Refactor: simplifies color map implementation -- Replace: Arc and Mutex with Box in ColorFunction -- Update: changelog -- Update: changelog -- Update: icon_map.rs deprecate NfMd icon variants and replace with NfFa equivalents -- Change: whisper or else fallback ok -- Change: whisper_or_else fallback err -- Rename: to whisper_or_else -- Update: makefile ## [1.2.1] - 2023-12-22 diff --git a/Cargo.lock b/Cargo.lock index 2b91e15..76c6c51 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -155,7 +155,7 @@ dependencies = [ [[package]] name = "murmur" -version = "1.2.1" +version = "2.0.0" dependencies = [ "color-backtrace", "color-eyre", diff --git a/Cargo.toml b/Cargo.toml index 165f1c0..55616a8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "murmur" -version = "1.2.1" +version = "2.0.0" edition = "2021" license = "MIT" description = "This library provides a simple and flexible way to format colored messages with optional `NerdFonts` or `Unicode` icons." diff --git a/Makefile.toml b/Makefile.toml index 2cdf947..6d50ae0 100644 --- a/Makefile.toml +++ b/Makefile.toml @@ -1,5 +1,5 @@ [env] -VERSION = "1.2.1" +VERSION = "2.0.0" [tasks.cargo-fmt] install_crate = "rustfmt"