Jonathan Dönszelmann
251d6d5929
fix(docs): add example to README and docs fixing #96 ( #319 )
2023-11-15 10:35:46 -08:00
Zanie Blue
fd77257cee
feat(graphical): Expose additional `textwrap` options ( #321 )
2023-11-15 10:34:24 -08:00
ManicMarrc
c7ba5b7e52
feat(derive): Make `miette-derive` be able to be turned off ( #304 )
2023-11-09 13:22:47 -08:00
Gavrilikhin Daniil
bfacb6329f
doc: document `#[diagnostic(transparent)]` ( #266 )
2023-07-15 18:46:54 -07:00
Gavrilikhin Daniil
024145dbdd
Add dynamic diagnostic ( #262 )
2023-05-13 13:59:43 -07:00
Aria Beingessner
0b445dc2b4
fix(tests): disable doctest that doesn't work with default feature flags ( #248 )
2023-03-30 09:19:51 -07:00
Lucas Kent
ebc61b5cf8
docs: Mention miette::miette! macro under "... in application code" ( #233 )
2023-01-30 10:21:50 -08:00
Pig Fang
12279f83a8
docs: remove sentence about `cargo-edit` ( #198 )
2022-08-21 08:33:51 -07:00
Luca Palmieri
b9ea587159
feat(graphical): Allow miette users to opt-out of the rendering of the cause chain ( #192 )
...
Fixes: https://github.com/zkat/miette/issues/191
2022-08-09 17:32:02 -07:00
Kat Marchán
e286c705fd
fix(docs): readme was getting cut off during generation
...
Fixes: https://github.com/zkat/miette/issues/174
2022-07-24 10:24:07 -07:00
Kat Marchán
0a4cf4ad24
fix(tests): add Display impl to diagnostic_source example
2022-05-05 12:44:49 -07:00
Kat Marchán
a03bfe2e1b
docs: document new diagnostic_source feature
2022-05-05 08:56:27 -07:00
Matthias Beyer
bc449c8426
feat(diagnostic_source): add protocol method for Diagnostic-aware source chaining ( #165 )
...
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2022-05-05 08:32:37 -07:00
Kat Marchán
9da62cd05d
feat(label): use macro magic instead of optional flag for optional labels
2022-04-17 22:43:01 -07:00
Kat Marchán
ea55f458fa
feat(help): allow non-option values in #[help] fields
2022-04-17 22:43:01 -07:00
Kat Marchán
23ee3642d1
feat(labels): allow optional labels in derive macro ( #153 )
...
Fixes: https://github.com/zkat/miette/issues/110
2022-04-17 19:41:10 -07:00
Kat Marchán
45093c2f58
feat(help): update macro to allow optional help text ( #152 )
...
Fixes: https://github.com/zkat/miette/issues/148
2022-04-17 18:19:28 -07:00
Bartek Iwańczuk
5151411ebb
feat: add fancy-no-backtrace feature ( #144 )
2022-03-22 12:30:52 -07:00
Moritz Mœller
5d23c0d61d
fix(docs): Docs overhaul ( #124 )
...
* Fixed/formatted all intradoc links. Various other small doc fixes/typography/etc.
* Clarified semantic similarity with anyhow/eyre types/macros.
* Removed unused MietteError::SetPrinterFailure.
* README now generaed from lib.rs via `cargo readme`.
* More doc fixes, made ErrorHook type public.
* Indentation (docs).
2022-02-25 08:39:18 -08:00
Kat Marchán
55ca8e0b7f
fix(api): put panic handler properly behind a flag
2021-09-22 16:34:21 -07:00
Kat Marchán
c6daee7b93
feat(panic): Add basic panic handler and installation function
...
Fixes: https://github.com/zkat/miette/issues/22
2021-09-22 16:34:21 -07:00
Kat Marchán
247e8f8b39
feat(deps): move fancy reporter (and its deps) to a feature
...
BREAKING CHANGE: The default fancy reporter is no longer available unless you enable the "fancy" feature. This also means you will not be pulling in a bunch of deps if you are using miette for a library
Fixes: https://github.com/zkat/miette/issues/25
2021-09-22 16:34:21 -07:00
Kat Marchán
4c2463f9ae
feat(report): make a single big MietteHandler that can switch modes
...
BREAKING CHANGE: linkification option method on GraphicalReportHandler has been changed to .with_links(bool)
2021-09-22 16:34:21 -07:00
Kat Marchán
673b435892
tests: remove compile_tests
2021-09-13 18:33:13 -07:00
Kat Marchán
3f9da04b86
feat(report): anyhow-ify DiagnosticReport ( #35 )
...
This PR overhauls the toplevel/main experience for `miette`. It adds a new `Report` type based on `eyre::Report` and overhauls various types to fit into this model, as well as prepare for some [future changes in Rust](https://github.com/nrc/rfcs/pull/1 ) that will make it possible to integrate `miette` directly with crates like `eyre` instead of having to use this specific `Report`.
As such, this PR is a major breaking change, especially for anyone using `DiagnosticReport` and company.
BREAKING CHANGES:
* `DiagnosticReport` is now just `Report`, and is a different, `eyre::Report`-like type.
* `DiagnosticResult` is now just `Result`.
* `.into_diagnostic()` now just transforms the error into a `Report`.
* `DiagnosticReportPrinter` has been replaced with `ReportHandler`
* `set_printer` has been replaced by `set_hook`
* `code` is now optional.
* `.into_diagnostic()` no longer takes a `code` argument.
* `#[diagnostic]` is now optional when deriving `Diagnostic`.
2021-09-04 21:22:46 -07:00
Cormac Relf
53f5d6d1d6
feat(derive): Add `#[diagnostic(transparent,forward)]` ( #36 )
...
Fixes: https://github.com/zkat/miette/issues/16
2021-08-29 12:33:16 -07:00
Kat Marchán
949174e598
misc: more aggressive linting for quality~
2021-08-21 23:13:25 -07:00
Kat Marchán
20bb3db3fa
docs: overhaul readme and make sure everything is documented
...
Fixes: https://github.com/zkat/miette/issues/15
2021-08-21 22:57:16 -07:00
Kat Marchán
d675334e48
feat(reporter): fancy new reporter with unicode, colors, and multiline ( #23 )
...
Fixes: https://github.com/zkat/miette/issues/3
Fixes: https://github.com/zkat/miette/issues/5
2021-08-20 20:09:23 -07:00
Kat Marchán
0e7702700d
feat(derive): added basic derive macro
...
This should be good for most basic use cases. More features will be added over time :)
2021-08-15 11:49:02 -07:00
Kat Marchán
a960136802
feat(utils): various convenience utilities for creating and working with Diagnostics
2021-08-14 13:32:22 -07:00
Kat Marchán
b08e5cca62
format: cargo fmt
2021-08-10 19:21:31 -04:00
Kat Marchán
6b51694733
feat(protocol) overhauled entire protocol to be based on byte offsets ( #1 )
...
Includes other improvements!
BREAKING CHANGE: Yeah this is pretty much a rewrite.
2021-08-04 20:27:12 -07:00
Kat Marchán
a437f44511
feat(reporter): dummy reporter implementation + tests
2021-08-03 00:52:10 -07:00
Kat Marchán
e2387ce2ed
feat(protocol): sketched out a basic protocol
2021-08-02 23:08:51 -07:00
Kat Marchán
457849721f
initial commit
2021-08-02 19:36:02 -07:00