Skip to content

Latest commit

 

History

History
159 lines (105 loc) · 4.07 KB

CHANGELOG.md

File metadata and controls

159 lines (105 loc) · 4.07 KB
Raw

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.

Unreleased

0.4.1 - 2023-06-08

Added

  • Error::msg creation method.

Documentation

  • Add rustdoc for Error help methods.

0.4.0 - 2022-11-24

Added

  • Features for conditional compilation of separate utilities. See #12.
  • All features enabled by default [report, error, cli-error, anyhow]. See #12.
  • cicheck shell script for quickly checking if repo will pass CI checks.
  • anyhow error reporting.

Changed

  • [BREAKING] Seal ExitCode trait. It was only useful with CliError anyway. Now the API reflects this.
  • [BREAKING] Mark CliError as non_exhaustive to allow for more variants in the future.
  • Error Debug formatting is now similar to report::err_full. Now the library is more similar anyhow in the way Result can be used.

Documentation

  • Fixed Minimum Support Rust Version formatting in Cargo.toml.
  • Add more examples.

API docs

  • Add crate root.
  • Add report module.

ErrorWrap rustdoc

  • Fixed wrong method names.
  • Added more lazy evaluation information.
  • Updated example to be more complete.

0.3.0 - 2022-10-19

Added

  • add_help and add_help_with methods for Error.
  • CliError common trait implementations.

Changed

  • Deprecate set_help and set_help_owned methods for Error type.
  • [BREAKING] Display implementation simplified for Error.
  • [BREAKING] report::err module now only prints relevant help.
  • [BREAKING] Error::downcast method no longer returns an anyhow::Result.

Testing

Add Integration Tests

  • Report module.
  • Error.
  • Chain.
  • ExitCode.
  • CliError.
  • Further wrap tests.

Documentation

  • Add minimum supported rust version: 1.61

0.2.0 - 2022-09-29

Added

  • Re-export anyhow crate.

Changed

[BREAKING] ErrorWrap

  • Seal trait so it cannot be implemented for user's types.
  • Lazily evaluated method renamed wrap_with.
  • Method wrap is no longer lazily evaluated.
  • Adding help is now done through the method add_help and lazy version add_help_with.

Other

  • [BREAKING] Fix public API typo for Error method route_cause to root_cause.

0.1.3 - 2022-09-28

Added

  • error_from macro copied from anyhow::anyhow.
  • bail macro copied from anyhow::bail.
  • Chain type for iterating through wrapped errors.
  • Re-export colored crate as narrate publicly depends on their features.
  • Re-export Color from colored for use in report::status.

Changed

  • anyhow::Chain type not used as return type of Error::chain method.

Documentation

  • Add rustdoc for the crate's public API.

0.1.2 - 2022-09-15

Changed

  • Multiple Error help messages.
  • Wrapping a Result with an Error.

0.1.1 - 2022-09-15

Added

  • Console status and error messaging with report::status and report::err.
  • Error methods delegating to inner anyhow::Error.
  • Conversion from Error to anyhow::Error.
  • More robust test-suite.

0.1.0 - 2022-09-14

Added

  • Error type to wrap around anyhow::Error with a help message.
  • ErrorWrap trait to add context to errors.
  • Result convince type.
  • ExitCode trait for sysexits.h program exit codes.