eyre フレーバーと tracing フレーバーを追加 (#113)

* feat: eyre & tracing の flavor を追加

* feat: eyre flavor と tracing flavor のテストを追加

* feat: flavor-eyre のドキュメント説明を追加

* feat: flavor-tracing のドキュメント説明を追加

* fix: cargo sort 忘れ

Author: anotherhollow1125

Cargo.lock

@@ -6,8 +6,10 @@ hooqクレートにもいくつかのfeaturesが存在します。本ページ
 |:---------|:--------:|:----|
 | default | o | デフォルトfeature。 `consume-question` 以外を含む |
 | full | x | すべてのfeatureを含むfeature |
-| log | o | logフレーバーを提供するfeature |
 | anyhow | o | anyhowフレーバーを提供するfeature |
+| eyre | o | eyreフレーバーを提供するfeature |
+| log | o | logフレーバーを提供するfeature |
+| tracing | o | tracingフレーバーを提供するfeature |
 | consume-question | x | `!` (Exclamation Mark)による `?` 演算子 (Question Operator) の削除を行えるようになるfeature |
 
 `consume-question` のみがデフォルトから外れた機能であり、フレーバーを提供するためのfeatureはデフォルトで含まれています。

docs/ja/hooq-mdbook-ja/src/reference/features.md

@@ -9,10 +9,10 @@
 | [default](#default) | - | 何も指定しない場合に設定されるフレーバー。hooq.tomlで上書き可 |
 | [empty](#empty) | - | 全く何もフックしない場合に用いるフレーバー。上書きは不可 |
 | [hook](#hook) | - | [`hooq::HooqMeta`](https://docs.rs/hooq/latest/hooq/struct.HooqMeta.html) を引数に取る `hook` メソッドを挿入するフレーバー。ユーザー定義のトレイト経由での利用を想定。上書き可 |
-| [log](#log) | log | [`::log::error!`](https://docs.rs/log/latest/log/macro.error.html) を呼び出す `inspect_err` メソッドを挿入するフレーバー。上書き可 |
 | [anyhow](#anyhow) | anyhow | [`with_context`](https://docs.rs/anyhow/latest/anyhow/trait.Context.html#tymethod.with_context) メソッドを挿入するフレーバー。上書き可 |
-| [eyre](#eyre--color-eyre) | eyre | (WIP) |
-| [tracing](#tracing) | tracing | (WIP) |
+| [eyre](#eyre) | eyre | [`wrap_err_with`](https://docs.rs/eyre/latest/eyre/trait.WrapErr.html#tymethod.wrap_err_with) メソッドを挿入するフレーバー。上書き可 |
+| [log](#log) | log | [`::log::error!`](https://docs.rs/log/latest/log/macro.error.html) を呼び出す `inspect_err` メソッドを挿入するフレーバー。上書き可 |
+| [tracing](#tracing) | tracing | [`::tracing::error!`](https://docs.rs/tracing/latest/tracing/macro.error.html) を呼び出す `inspect_err` メソッドを挿入するフレーバー。上書き可 |
 
 一応feature名を記載しましたが、フレーバーに関係するfeatureはdefault featureに含まれているので明示的にCargo.tomlの `features` に含める必要はありません。
 
@@ -126,6 +126,59 @@ hookフレーバーの設定は次の通りです。(コメント部分は気に
 {{#rustdoc_include ../../../../../mdbook-source-code/flavor-hook/src/main.expanded.rs:37:53}}
 ```
 
+## anyhow
+
+> `anyhow` feature が必要ですが、defaultに含まれています。
+
+[anyhowクレート](https://docs.rs/anyhow/latest/anyhow/) と共に使うことを想定したフレーバーです。
+
+次の設定になっています。
+
+```rust
+{{#rustdoc_include ../../../../../hooq-macros/src/impls/flavor/presets/anyhow.rs:7:28}}
+```
+
+[`.with_context(...)`](https://docs.rs/anyhow/latest/anyhow/trait.Context.html#tymethod.with_context) メソッドを利用するために、 `anyhow::Context` トレイトをuseしています。
+
+
+使用例:
+
+```rust
+{{#rustdoc_include ../../../../../mdbook-source-code/flavor-anyhow/src/main.rs}}
+```
+
+実行結果:
+
+```bash
+{{#include ../../../../../mdbook-source-code/flavor-anyhow/tests/snapshots/test__flavor-anyhow.snap:8:13}}
+```
+
+## eyre
+
+> `eyre` feature が必要ですが、defaultに含まれています。
+
+[eyreクレート](https://docs.rs/eyre/latest/eyre/) と共に使うことを想定したフレーバーです。anyhowとはuseしているトレイト、呼び出しているメソッドが異なるだけでほぼ同じです。
+
+次の設定になっています。
+
+```rust
+{{#rustdoc_include ../../../../../hooq-macros/src/impls/flavor/presets/eyre.rs:7:28}}
+```
+
+[`.wrap_err_with(...)`](https://docs.rs/eyre/latest/eyre/trait.WrapErr.html#tymethod.wrap_err_with) メソッドを利用するために、 `eyre::WrapErr` トレイトをuseしています。
+
+使用例:
+
+```rust
+{{#rustdoc_include ../../../../../mdbook-source-code/flavor-eyre/src/main.rs}}
+```
+
+実行結果:
+
+```bash
+{{#include ../../../../../mdbook-source-code/flavor-eyre/tests/snapshots/test__flavor-eyre.snap:8:22}}
+```
+
 ## log
 
 > `log` feature が必要ですが、defaultに含まれています。
@@ -150,37 +203,28 @@ hookフレーバーの設定は次の通りです。(コメント部分は気に
 {{#include ../../../../../mdbook-source-code/flavor-log/tests/snapshots/test__flavor-log.snap:8:11}}
 ```
 
-## anyhow
+## tracing
 
-> `anyhow` feature が必要ですが、defaultに含まれています。
+> `tracing` feature が必要ですが、defaultに含まれています。
 
-[anyhowクレート](https://docs.rs/anyhow/latest/anyhow/) と共に使うことを想定したフレーバーです。
+[tracingクレート](https://docs.rs/tracing/latest/tracing/) と共に使うことを想定したフレーバーです。
 
 次の設定になっています。
 
 ```rust
-{{#rustdoc_include ../../../../../hooq-macros/src/impls/flavor/presets/anyhow.rs:7:28}}
+{{#rustdoc_include ../../../../../hooq-macros/src/impls/flavor/presets/tracing.rs:7:33}}
 ```
 
-[`.with_context(...)`](https://docs.rs/anyhow/latest/anyhow/trait.Context.html#tymethod.with_context) メソッドを利用するために、 `anyhow::Context` トレイトをuseしています。
-
+`#[tracing::instrument]` と併用する場合、 `#[hooq(tracing)]` が先に適用される必要があるため、 `#[tracing::instrument]` より上に `#[hooq(tracing)]` を書くことを推奨します。
 
 使用例:
 
 ```rust
-{{#rustdoc_include ../../../../../mdbook-source-code/flavor-anyhow/src/main.rs}}
+{{#rustdoc_include ../../../../../mdbook-source-code/flavor-tracing/src/main.rs}}
 ```
 
 実行結果:
 
 ```bash
-{{#include ../../../../../mdbook-source-code/flavor-anyhow/tests/snapshots/test__flavor-anyhow.snap:8:13}}
+{{#include ../../../../../mdbook-source-code/flavor-tracing/tests/snapshots/test__flavor-tracing.snap:5:11}}
 ```
-
-## eyre / color-eyre
-
-(WIP！準備中です)
-
-## tracing
-
-(WIP！準備中です)

docs/ja/hooq-mdbook-ja/src/reference/flavors.md

@@ -16,10 +16,12 @@ readme = "docs/README.md"
 proc-macro = true
 
 [features]
-default = ["anyhow", "log"]
+default = ["anyhow", "log", "tracing", "eyre"]
 log = []
 anyhow = []
 consume-question = []
+tracing = []
+eyre = []
 
 [dependencies]
 proc-macro-crate = "3.4.0"