Merge pull request #11 from LuisFerLCC/impl_error_stack

Prepare release 0.1.0

Author: luisfi-dev

Cargo.lock

@@ -0,0 +1,56 @@
+# `error-stack-macros2` v0.1.0
+
+The very first development version of `error-stack-macros2` is finally here!
+
+## Features
+
+This version (0.1.0) offers a derive macro for the [`Error`](https://doc.rust-lang.org/stable/core/error/trait.Error.html) trait which encourages the best practices for defining [`error-stack`](https://crates.io/crates/error-stack) context types.
+
+Here's an example. This code:
+
+```rust
+use std::{
+    error::Error,
+    fmt::{self, Display, Formatter},
+};
+
+#[derive(Debug)]
+pub enum CreditCardError {
+    InvalidInput(String),
+    Other,
+}
+
+impl Display for CreditCardError {
+    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+        let msg = match self {
+            Self::InvalidInput(_) => "credit card not found",
+            Self::Other => "failed to retrieve credit card",
+        };
+
+        f.write_str(msg)
+    }
+}
+
+impl Error for CreditCardError {}
+```
+
+...can now be reduced to this code:
+
+```rust
+use error_stack_macros2::Error;
+
+#[derive(Debug, Error)]
+pub enum CreditCardError {
+    #[display("credit card not found")]
+    InvalidInput(String),
+
+    #[display("failed to retrieve credit card")]
+    Other,
+}
+```
+
+This new release also means that we will now be listening to feedback and accepting new features (macros, obviously). We are also now committed to maintaining this macro going forward and keeping our dependencies up to date.
+
+## Previous release notes
+
+If you want to take a look at the notes from previous releases, go to [GitHub Releases](https://github.com/LuisFerLCC/error-stack-macros2/releases).

RELEASE.md

@@ -4,7 +4,7 @@
 
 | Version | Supported |
 | ------- | --------- |
-| -       | -         |
+| 0.1.0   | ✅        |
 
 ## Report a vulnerability
 

SECURITY.md

@@ -1,6 +1,6 @@
 [package]
 name = "error-stack-macros2"
-version = "0.0.0-reserved"
+version = "0.1.0"
 authors = ["LuisFerLCC"]
 edition = "2024"
 rust-version = "1.90.0"

impl/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "error-stack-macros2-tests"
-version = "0.0.0-reserved"
+version = "0.1.0"
 authors = ["LuisFerLCC"]
 edition = "2024"
 rust-version = "1.90.0"