618 Commits

Author SHA1 Message Date
Manish Goregaokar
7b1a204066 Clippy fixes 2025-05-01 09:26:43 -07:00
Manish Goregaokar
c4ee249f7c
Bump color-eyre to 0.6.3, color-spantrace to 0.2.2 to publish owo-colors bump (#207)
owo-colors has a potential soundness bug, which I'm attempting to fix in
https://github.com/jam1garner/owo-colors/pull/131. However, a lot of
crates rely on the 3.x series, which may not get patched. Preemptively
updating them, would appreciate a release!!
2025-01-24 15:35:08 -08:00
Jane Losare-Lusby
7706273bcf
emit rustc-check-cfg info and fix doc_lazy_continuation clippy warning (#200)
This should resolve clippy warnings on master
2024-08-29 13:56:05 -07:00
Nikita Bishonen
fc83cb8125
chore(color-eyre): Set color-eyre dependency on eyre via path. (#197)
Good day, dear eyre contributors.

I really like to use eyre in all my projects. Right now I use master to
stay on 1.0 version.
Unfortunately when I want to start using color-eyre the same way it
conflicts with eyre, because it uses 0.6.1 version.
What this PR addresses is to temporary set color-eyre -> eyre dependency
via path, not a version, until 1.0 will be released.

If it's not something you want to have in the codebase, just please let
me know, I will then switch to my fork and keep it sync with the main
repo. Thank you in advance, you are awesome! 💜
2024-08-22 12:26:43 +01:00
Jackson
9cb4c0af3b
Remove random word from color-eyre readme (#191)
The word "developer" appears at the end of a sentence and it doesn't
make sense at all in that context. Maybe you meant to say "while
developing" but i just removed it entirely.
2024-08-22 11:34:00 +01:00
Freja Roberts
e5d92c3ad2
Fix broken links in README.md (#186)
Links would return 404 for the given URLs. I change the links to again
link to the correct file on Github.
2024-07-22 16:56:30 +02:00
Christer Jensen
5d93c1adaf
Fix broken links in README.md
Links would now return 404 for the given URL.
2024-07-22 13:33:30 +02:00
Freja Roberts
2dc0688d33
Bump backtrace-rs (#175)
0.3.59 is the first version of backtrace-rs that doesn't use
`gimli-symbolize`:
5fc4f79674

While the feature is still there, it is unused and later on removed in
4cbe6b69ea.
Original [PR #615](https://github.com/rust-lang/backtrace-rs/pull/615)

Closes https://github.com/eyre-rs/eyre/issues/174
2024-07-20 18:50:52 +02:00
Freja Roberts
a6c8a61628
Merge branch 'master' into bump-backtrace-rs 2024-07-20 18:47:24 +02:00
Freja Roberts
df42dc4338
Fix compile probe and nightly backtraces (#160)
This addresses the invalid compile probe testing for a non-longer
existing feature by updating it and eyre to use the
`error_generic_member_access` features instead.

The report and errors have all been updated to accomodate this and the
new backtrace provide API

Fixes: #84 and #97
2024-07-18 22:24:24 +02:00
Freja Roberts
87ee15eec8
Merge branch 'master' into fix-nightly-backtraces 2024-07-18 22:08:57 +02:00
Freja Roberts
dded7deded
fix(color_eyre): build warnings (#182)
Remove structs that are unused and have been migrated to use the eyre
versions of the same:
- color_eyre::config::InstallError -> eyre::InstallError
- color_eyre::config::InstallThemeError -> eyre::InstallThemeError
- color_eyre::config::InstallColorSpantraceThemeError -> no equivalent

Add cfg guards to the DisplayExt, FooterWriter, Footer, and Header
to prevent unused warnings when the issue-url feature is not enabled.

---

Warnings:
```
   Compiling color-eyre v0.6.2 (/Users/joshka/local/eyre/color-eyre)
warning: struct `InstallError` is never constructed
   --> color-eyre/src/config.rs:15:8
    |
15  | struct InstallError;
    |        ^^^^^^^^^^^^
    |
note: the lint level is defined here
   --> color-eyre/src/lib.rs:352:5
    |
352 |     unused,
    |     ^^^^^^
    = note: `#[warn(dead_code)]` implied by `#[warn(unused)]`

warning: struct `InstallThemeError` is never constructed
  --> color-eyre/src/config.rs:26:8
   |
26 | struct InstallThemeError;
   |        ^^^^^^^^^^^^^^^^^

warning: struct `InstallColorSpantraceThemeError` is never constructed
  --> color-eyre/src/config.rs:37:8
   |
37 | struct InstallColorSpantraceThemeError;
   |        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

warning: trait `DisplayExt` is never used
  --> color-eyre/src/writers.rs:31:18
   |
31 | pub(crate) trait DisplayExt: Sized + Display {
   |                  ^^^^^^^^^^

warning: struct `FooterWriter` is never constructed
  --> color-eyre/src/writers.rs:83:19
   |
83 | pub(crate) struct FooterWriter<W> {
   |                   ^^^^^^^^^^^^

warning: struct `Footer` is never constructed
   --> color-eyre/src/writers.rs:102:19
    |
102 | pub(crate) struct Footer<B, H>
    |                   ^^^^^^

warning: struct `Header` is never constructed
   --> color-eyre/src/writers.rs:133:19
    |
133 | pub(crate) struct Header<B, H>
    |                   ^^^^^^

warning: `color-eyre` (lib) generated 7 warnings
```
2024-07-03 12:24:41 +02:00
Josh McKinney
d717cf9cac
fix(color_eyre): build warnings
Remove structs that are unused and have been migrated to use the eyre
versions of the same:
- color_eyre::config::InstallError -> eyre::InstallError
- color_eyre::config::InstallThemeError -> eyre::InstallThemeError
- color_eyre::config::InstallColorSpantraceThemeError -> no equivalent

Add cfg guards to the DisplayExt, FooterWriter, Footer, and Header
to prevent unused warnings when the issue-url feature is not enabled.
2024-06-29 07:42:39 -07:00
Freja Roberts
94986778fb
Make ContextCompat consistent and non-ambiguous with WrapErr (#150)
See: #149

Fixes: #149
2024-06-28 17:46:17 +02:00
Tei Leelo Roberts
c98bc8cc1c fix: consistent naming and duplicated tests 2024-06-28 17:39:22 +02:00
Tei Leelo Roberts
0eabf81eef fix: import consistency 2024-06-28 17:35:43 +02:00
Freja Roberts
231090d5f6 fix: typo in doc comment 2024-06-28 17:35:43 +02:00
Tei Leelo Roberts
4d6e73e5a9 fix: different call machinery between linux and windows
This filters out diverging backtraces caused by different before-main
and test calling machinery on windows and linux
2024-06-21 20:05:30 +02:00
Freja Roberts
39ec86532c
Merge branch 'master' into fix-ambiguous-methods 2024-06-21 19:48:03 +02:00
Kristof Mattei
254309ffa0
Bump backtrace-rs
0.3.59 is the first version of backtrace-rs that doesn't use `gimli-symbolize`: 5fc4f79674

While the feature is still there, it is unused and later on removed in 4cbe6b69ea. Original [PR #615](https://github.com/rust-lang/backtrace-rs/pull/615)

Closes https://github.com/eyre-rs/eyre/issues/174
2024-05-31 06:07:40 -07:00
Freja Roberts
907daa2cc6
Fix typo in CI (#173)
The lint group is `clippy::suspicious`, not `clippy::suspiscious`


https://github.com/eyre-rs/eyre/actions/runs/9112483886/job/25051828362#step:5:176

```
warning[E0602]: unknown lint: `clippy::suspiscious`
Warning:   |
  = help: did you mean: `clippy::suspicious`
  = note: requested on the command line with `-D clippy::suspiscious`
  = note: `#[warn(unknown_lints)]` on by default
```
2024-05-30 10:25:44 +02:00
Malloc Voidstar
dbf32d9cbe
Remove empty doc comments 2024-05-29 15:49:13 -07:00
Malloc Voidstar
f21bfc253c
Fix typo in CI 2024-05-29 10:55:52 -07:00
Freja Roberts
a0f3f641df
Fix overly strict clippy lint (#172)
Deny style, suspicious and complexity categories, rather than all
warnings

If we find issues that could have been caught by a clippy lint we can
add that lint on as *deny* too, as for now, they still appear as
warnings but won't prevent CI from running.

This most notably fixes random CI breakages when clippy/rust updates and
introduces new warn level lints
2024-05-16 13:43:04 +01:00
Freja Roberts
dd05aa3557
fix: empty doc comments disallowed by clippy 2024-05-13 18:51:38 +02:00
Freja Roberts
dacfb5566e
Merge branch 'master' into fix-nightly-backtraces 2024-05-13 18:47:47 +02:00
Pavan Kumar Sunkara
aed87e4eb0
Bump workspace to owo-colors 4.0 (#167)
Requires adding a path dependency in color-eyre on color-spantrace so
that the versions agree. Fortunately we can do that now!
2024-04-25 22:56:45 +01:00
Pavan Kumar Sunkara
be43daec57
Merge branch 'master' into bump-owo-colors-for-everyone 2024-04-25 22:52:33 +01:00
DaniPopes
1369e09fb2
Don't evaluate 1-argument ensure! condition twice (#166)
`ensure!($cond:expr)` currently expands to two nested `if !$cond {}`.

Co-authored-by: Jane Losare-Lusby <jlusby@yaah.dev>
2024-04-25 22:52:12 +01:00
nori li
5aea38b51c
Merge branch 'master' into bump-owo-colors-for-everyone 2024-04-25 14:47:32 -07:00
Freja Roberts
3d7b20de97 fix: remove duplicate thiserror reference 2024-04-25 23:42:12 +02:00
LeoniePhiline
586e359220
fix(docs): enclose inline code in backticks (#170)
Fixes #169

Besides enclosing inline code in backticks, I also made two tiny
documentation improvements - please let me know if you want them undone:

- In the `Report::msg` docs, the user is referred to `Report::new`. I
changed this from plain inline code into a link.
- I expanded _"`Display` impl"_ to _"`Display` implementation"_, since
`impl` is a Rust token, but
  - _"`Display` `impl`"_ looked silly, and 
  - _"`impl Display`"_ disturbed the flow of reading.

Co-authored-by: Jane Losare-Lusby <jlusby@yaah.dev>
2024-04-25 14:36:46 -07:00
Jubilee Young
b65fb592de Pin trybuild to maintain MSRV
Also, check in our lockfile, due to Cargo's change in guidance for libs.
2024-04-25 14:27:36 -07:00
Freja Roberts
92b6a5701d fix: use RUST_WORKSPACE_WRAPPER in compile probe 2024-04-25 23:27:21 +02:00
Freja Roberts
f80de3e49e fix: compile probe and nightly backtraces
This addresses the invalid compile probe testing for a non-longer
existing feature by updating it and eyre to use the
`error_generic_member_access` features instead.

The report and errors have all been updated to accomodate this and the
new backtrace provide API

Fixes: #84 and #97
2024-04-25 23:27:18 +02:00
Jubilee Young
6e2ffcc0c2 Bump workspace to owo-colors 4.0
Requires adding a path dependency in color-eyre on color-spantrace
so that the versions agree. Fortunately we can do that now!
2024-04-25 14:26:24 -07:00
nori li
b0c3e3ff9c
Add a gitattributes file to specify LF line endings (#126)
Since almost all files not on our gitignore are text files, it uses `*
text` as a catch-all and specifies *.png as binary.

Co-authored-by: Jane Losare-Lusby <jlusby@yaah.dev>
2024-04-25 14:24:21 -07:00
Freja Roberts
41699aa483
Fix ci breaking due to new dependencies and rustc changes (backport to master) (#163)
Applies the same fixes that was applied to `color-eyre-0.6` to master,
namely the new update to `trybuild` that breaks our MSRV requirement,
requiring us to pin the version, as the dependency only bumped the patch
version for the updated MRSV.

It also fixes the theme test breaking on windows due to new
*before-main* machinery on windows affecting the backtrace. This is
fixed by filtering out the functions before and including main(due to no
take_until iter adapter in std), but still includes the panicking
function call.

There are currently three branches that need/needed this fix

- master: containing latest breaking code for 1.0
- color-eyre-0.6
- release-0.6 (does not include the theme test change as color-eyre is
not present there)
2024-04-25 14:18:20 -07:00
Freja Roberts
90645efddc fix: warnings from new clippy lints 2024-03-29 10:51:15 +01:00
Freja Roberts
2b32acdd03
Merge branch 'master' into fix-ambiguous-methods 2024-03-28 22:01:37 +01:00
Freja Roberts
a03951740c fix: remove ambiguity between options and results trait methods
1. Remove the conditional trait methods `context` and `with_context`
   from `WrapErr`
2. Remove ambiguity between "wrapping errors" with another, and
   converting a `None` value to an error.

The anyhow compatibility methods (`context` and `with_context`) were
introduced as conditional required methods for the trait `WrapErr`, as
well as another separate trait `ContextCompat`, implemented for options
*and* results.

The latter trait also provided methods `wrap_err` and `wrap_err_with`.
This led to confusion as the two distinct traits had the same methods,
one was implemented on results, and the other on both options and
results.

Furthermore, wrapping options does not align with our error model where
errors are wrapped around other errors; an error wrapping `None` should
just be a single error and should not be wrapped.

See: #149
2024-03-28 21:35:34 +01:00
Freja Roberts
7a5c32acd7
Add color-eyre to workspace (#110) 2024-03-14 22:36:59 +01:00
Freja Roberts
eb8d059c50 Merge remote-tracking branch 'origin/master' into color-eyre 2024-03-14 18:05:00 +01:00
LeoniePhiline
75beaaea3f
fix: remove anyhow feature flag from OptionExt location test (#148)
# 1. Clarify trait usage in location test


[`8522f02`](8522f02518)

Both `WrapErr` and `ContextCompat` expose `anyhow` compatibility
methods.

- `ContextCompat` is completely feature gated behind the `anyhow` flag.

- `WrapErr`, on the other hand, feature-gates individual functions
behind the `anyhow` flag.

This has led to [confusion][confusion] in the past.

This change moves the `use eyre::WrapErr` statement from the top of the
module into each individual test, as [identically named
functions](https://github.com/eyre-rs/eyre/issues/149) (`wrap_err.*`)
are exposed both by `WrapErr` and `ContextCompat`.

With `use eyre::WrapErr` moved directly into the tests, it becomes clear
which trait-provided `fn` is being called.

[confusion]:
https://github.com/eyre-rs/eyre/pull/138#discussion_r1432909562

# 2. Remove `anyhow` feature flag from `OptionExt` location test 


[`68744f1`](68744f19fb)

This bug was introduced (by me) in
34bd1d9893 (diff-1ff47dac6cf55e34ff587968c5b1f1ec6b6ae39d2668a66ecba3633163a21fc5R86)
- partly due to the confusion fixed with the above commit.

Fixes https://github.com/eyre-rs/eyre/issues/147
2024-03-14 18:01:32 +01:00
Jubilee
e570151950
color-spantrace: bump owo-colors to 4.0 (#156) 2024-02-15 21:41:55 +00:00
Freja Roberts
cb4bab6fd0 chore: update issues redirect 2024-01-29 14:54:22 +01:00
Freja Roberts
8ebc308a0a fix: make theme test more lenient
The test now only considers our part of the backtrace, allowing for
changes in rust std library to not break the test
2024-01-29 14:54:20 +01:00
Freja Roberts
eb26e0202f fix: color-eyre theme test suite backtraces to match the tested MSRV 2024-01-23 11:51:43 +01:00
Freja Roberts
1da23d9081
Merge branch 'master' into color-eyre 2024-01-23 10:23:48 +01:00
LeoniePhiline
34bd1d9893
feat: introduce an "anyhow" compatibility layer feature flag (#138)
This change hides the `anyhow` compatibility layer behind an `"anyhow"`
feature flag.
In `eyre` v1.0.0 the feature is currently enabled by default.

Fixes #131

---------

Co-authored-by: Freja Roberts <ten3roberts@gmail.com>
2024-01-16 17:10:12 +01:00