nushell/crates
Joaquín Triñanes cc805f3f01
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
2023-08-27 06:54:15 -05:00
..
nu_plugin_custom_values Spanned Value step 1: span all value cases (#10042) 2023-08-25 08:48:05 +12:00
nu_plugin_example Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu_plugin_formats Spanned Value step 1: span all value cases (#10042) 2023-08-25 08:48:05 +12:00
nu_plugin_gstat Spanned Value step 1: span all value cases (#10042) 2023-08-25 08:48:05 +12:00
nu_plugin_inc bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu_plugin_python remove vectorize_over_list from python plugin (#9905) 2023-08-03 16:46:48 +02:00
nu_plugin_query Spanned Value step 1: span all value cases (#10042) 2023-08-25 08:48:05 +12:00
nu-cli Use built-in is_terminal instead of is_terminal::is_terminal (#9550) 2023-08-25 10:54:44 +02:00
nu-cmd-base Spanned Value step 1: span all value cases (#10042) 2023-08-25 08:48:05 +12:00
nu-cmd-dataframe Allow for .parq file ending as alternative to .parquet (#10112) 2023-08-24 15:57:33 -05:00
nu-cmd-extra Spanned Value step 1: span all value cases (#10042) 2023-08-25 08:48:05 +12:00
nu-cmd-lang Allow parse-time evaluation of calls, pipelines and subexpressions (#9499) 2023-08-26 16:41:29 +03:00
nu-color-config Create Record type (#10103) 2023-08-25 07:50:29 +12:00
nu-command Allow parse-time evaluation of calls, pipelines and subexpressions (#9499) 2023-08-26 16:41:29 +03:00
nu-engine Allow parse-time evaluation of calls, pipelines and subexpressions (#9499) 2023-08-26 16:41:29 +03:00
nu-explore add support for Vim motions in explore (#9966) 2023-08-26 07:48:37 -05:00
nu-glob bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-json bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-parser Allow parse-time evaluation of calls, pipelines and subexpressions (#9499) 2023-08-26 16:41:29 +03:00
nu-path bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-plugin bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-pretty-hex bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-protocol Screen reader-friendly errors (#10122) 2023-08-27 06:54:15 -05:00
nu-std bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-system Use built-in is_terminal instead of is_terminal::is_terminal (#9550) 2023-08-25 10:54:44 +02:00
nu-table Spanned Value step 1: span all value cases (#10042) 2023-08-25 08:48:05 +12:00
nu-term-grid bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-test-support bump nushell to dev version 0.84.1 (#10101) 2023-08-23 15:23:27 -05:00
nu-utils Screen reader-friendly errors (#10122) 2023-08-27 06:54:15 -05:00
README.md Remove old nushell/merge engine-q 2022-02-07 14:54:06 -05:00

Nushell core libraries and plugins

These sub-crates form both the foundation for Nu and a set of plugins which extend Nu with additional functionality.

Foundational libraries are split into two kinds of crates:

  • Core crates - those crates that work together to build the Nushell language engine
  • Support crates - a set of crates that support the engine with additional features like JSON support, ANSI support, and more.

Plugins are likewise also split into two types:

  • Core plugins - plugins that provide part of the default experience of Nu, including access to the system properties, processes, and web-connectivity features.
  • Extra plugins - these plugins run a wide range of different capabilities like working with different file types, charting, viewing binary data, and more.