Screen reader-friendly errors (#10122)

- Hopefully closes #10120  

# Description

This PR adds a new config item, `error_style`. It will render errors in
a screen reader friendly mode when set to `"simple"`. This is done using
`miette`'s own `NarratableReportHandler`, which seamlessly replaces the
default one when needed.

Before:
```
Error: nu:🐚:external_command

  × External command failed
   ╭─[entry #2:1:1]
 1 │ doesnt exist
   · ───┬──
   ·    ╰── executable was not found
   ╰────
  help: No such file or directory (os error 2)
```

After:
```
Error: External command failed
    Diagnostic severity: error
Begin snippet for entry #4 starting at line 1, column 1

snippet line 1: doesnt exist
    label at line 1, columns 1 to 6: executable was not found
diagnostic help: No such file or directory (os error 2)
diagnostic code: nu:🐚:external_command

```

## Things to be determined

- ~Review naming. `errors.style` is not _that_ consistent with the rest
of the code. Menus use a `style` record, but table rendering mode is set
via `mode`.~ As it's a single config, we're using `error_style` for now.
- Should this kind of setting be toggable with one single parameter?
`accessibility.no_decorations` or similar, which would adjust the style
of both errors and tables accordingly.

# User-Facing Changes

No changes by default, errors will be rendered differently if
`error_style` is set to `simple`.

# Tests + Formatting
<!--
Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to
check that you're using the standard code style
- `cargo test --workspace` to check that all tests pass (on Windows make
sure to [enable developer
mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging))
- `cargo run -- -c "use std testing; testing run-tests --path
crates/nu-std"` to run the tests for the standard library

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```
-->

# After Submitting

There's a PR updating the docs over here
https://github.com/nushell/nushell.github.io/pull/1026
This commit is contained in:
Joaquín Triñanes
2023-08-27 13:54:15 +02:00
committed by GitHub
parent 5ac5b90aed
commit cc805f3f01
4 changed files with 93 additions and 11 deletions

View File

@ -1,5 +1,8 @@
use crate::engine::{EngineState, StateWorkingSet};
use miette::{LabeledSpan, MietteHandlerOpts, ReportHandler, RgbColors, Severity, SourceCode};
use miette::{
LabeledSpan, MietteHandlerOpts, NarratableReportHandler, ReportHandler, RgbColors, Severity,
SourceCode,
};
use thiserror::Error;
/// This error exists so that we can defer SourceCode handling. It simply
@ -41,16 +44,27 @@ pub fn report_error_new(
impl std::fmt::Debug for CliError<'_> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let ansi_support = self.1.get_config().use_ansi_coloring;
let config = self.1.get_config();
let miette_handler = MietteHandlerOpts::new()
// For better support of terminal themes use the ANSI coloring
.rgb_colors(RgbColors::Never)
// If ansi support is disabled in the config disable the eye-candy
.color(ansi_support)
.unicode(ansi_support)
.terminal_links(ansi_support)
.build();
let ansi_support = &config.use_ansi_coloring;
let ansi_support = *ansi_support;
let error_style = &config.error_style.as_str();
let errors_style = *error_style;
let miette_handler: Box<dyn ReportHandler> = match errors_style {
"plain" => Box::new(NarratableReportHandler::new()),
_ => Box::new(
MietteHandlerOpts::new()
// For better support of terminal themes use the ANSI coloring
.rgb_colors(RgbColors::Never)
// If ansi support is disabled in the config disable the eye-candy
.color(ansi_support)
.unicode(ansi_support)
.terminal_links(ansi_support)
.build(),
),
};
// Ignore error to prevent format! panics. This can happen if span points at some
// inaccessible location, for example by calling `report_error()` with wrong working set.

View File

@ -26,7 +26,7 @@ pub struct ParsedMenu {
pub source: Value,
}
/// Definition of a parsed menu from the config object
/// Definition of a parsed hook from the config object
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct Hooks {
pub pre_prompt: Option<Value>,
@ -113,6 +113,7 @@ pub struct Config {
pub cursor_shape_emacs: NuCursorShape,
pub datetime_normal_format: Option<String>,
pub datetime_table_format: Option<String>,
pub error_style: String,
}
impl Default for Config {
@ -175,6 +176,8 @@ impl Default for Config {
menus: Vec::new(),
keybindings: Vec::new(),
error_style: "fancy".into(),
}
}
}
@ -1322,6 +1325,14 @@ impl Value {
);
}
}
"error_style" => {
if let Ok(style) = value.as_string() {
config.error_style = style;
} else {
invalid!(Some(span), "should be a string");
vals[index] = Value::string(config.error_style.clone(), span);
}
}
// Catch all
x => {
invalid_key!(