error-stack: introduction of color modes

[indietyp]

🌟 What is the purpose of this PR?

This implements the notion of color modes, determining if colors and which type of coloring/styling are requested.

This enables users to override the preferred mode while preserving the convenience of environment variables like NO_COLOR and FORCE_COLOR. This has been moved into an example.

The available color modes are Color, None, and Emphasis. This mode is available for hooks so that they can easily adapt. A perfect example of this is the location hook, which now will use the mode to either print in bright black or italic.

If no color mode is set, the mode is automatically determined using owo-colors using supports-colors and the specified override. If no color mode is set, the mode is set to Color::Emphasis if the color feature (opt-in) is enabled.

Note: as a drive-by, supports-colors is now only enabled on std, supports-color implies std (not as a feature, found this by accident), which meant that no-std colors would fail, even tho they shouldn't.

🔗 Related links

• Can't see crash output when using solarized-dark color scheme #1782

🔍 What does this change?

• Report::format_color_mode_preference
• HookContext::mode() is now available

📜 Does this require a change to the docs?

Yes, the new ColorMode needs to be explained. This is already done.

We might want to add additional explanation/info in lib.rs

🏃 Next Steps

1. Ideally we'd temporarily set the mode from owo-colors, if possible, this needs overwrite color support temporarily during function execution jam1garner/owo-colors#84

⚠️ Known issues

🛡 What tests cover this?

• Existing tests
• New snapshot tests

📹 Demo

[codecov]

Codecov Report

Merging #1800 (8983737) into main (1394be1) will increase coverage by 0.22%.
The diff coverage is 93.40%.

@@            Coverage Diff             @@
##             main    #1800      +/-   ##
==========================================
+ Coverage   57.05%   57.27%   +0.22%     
==========================================
  Files         261      265       +4     
  Lines       18700    18802     +102     
  Branches      421      421              
==========================================
+ Hits        10669    10769     +100     
- Misses       8026     8028       +2     
  Partials        5        5              

Flag	Coverage Δ
backend-integration-tests	3.66% <ø> (ø)
error-stack	90.73% <93.40%> (+0.48%)	⬆️
unit-tests	1.49% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
packages/libs/error-stack/src/hook/context.rs	78.89% <ø> (ø)
packages/libs/error-stack/src/hook/mod.rs	100.00% <ø> (ø)
packages/libs/error-stack/src/lib.rs	38.46% <ø> (ø)
packages/libs/error-stack/src/report.rs	85.22% <ø> (ø)
packages/libs/error-stack/src/fmt/override.rs	65.00% <65.00%> (ø)
packages/libs/error-stack/src/fmt/color.rs	90.00% <90.00%> (ø)
packages/libs/error-stack/src/fmt/location.rs	94.44% <90.90%> (+8.73%)	⬆️
packages/libs/error-stack/src/fmt/charset.rs	94.44% <94.44%> (ø)
packages/libs/error-stack/src/fmt/mod.rs	96.49% <98.76%> (+1.36%)	⬆️
packages/libs/error-stack/src/fmt/config.rs	100.00% <100.00%> (ø)
... and 2 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[trunk-io]

❌ This pull request failed tests. It has been removed from queue. (details)

[indietyp]

/trunk merge

[trunk-io]

😎 Merged successfully (details).