nushell/crates/nu-command/src
Stefan Holderbach 62575c9a4f
Document and critically review ShellError variants - Ep. 3 (#8340)
Continuation of #8229 and #8326

# Description

The `ShellError` enum at the moment is kind of messy. 

Many variants are basic tuple structs where you always have to reference
the implementation with its macro invocation to know which field serves
which purpose.
Furthermore we have both variants that are kind of redundant or either
overly broad to be useful for the user to match on or overly specific
with few uses.

So I set out to start fixing the lacking documentation and naming to
make it feasible to critically review the individual usages and fix
those.
Furthermore we can decide to join or split up variants that don't seem
to be fit for purpose.

# Call to action

**Everyone:** Feel free to add review comments if you spot inconsistent
use of `ShellError` variants.

# User-Facing Changes

(None now, end goal more explicit and consistent error messages)

# Tests + Formatting

(No additional tests needed so far)

# Commits (so far)

- Remove `ShellError::FeatureNotEnabled`
- Name fields on `SE::ExternalNotSupported`
- Name field on `SE::InvalidProbability`
- Name fields on `SE::NushellFailed` variants
- Remove unused `SE::NushellFailedSpannedHelp`
- Name field on `SE::VariableNotFoundAtRuntime`
- Name fields on `SE::EnvVarNotFoundAtRuntime`
- Name fields on `SE::ModuleNotFoundAtRuntime`
- Remove usused `ModuleOrOverlayNotFoundAtRuntime`
- Name fields on `SE::OverlayNotFoundAtRuntime`
- Name field on `SE::NotFound`
2023-03-06 18:33:09 +01:00
..
bits Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
bytes Document and critically review ShellError variants - Ep. 2 (#8326) 2023-03-06 11:31:07 +01:00
charting Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
conversions Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
database Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
dataframe Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
date Document and critically review ShellError variants - Ep. 2 (#8326) 2023-03-06 11:31:07 +01:00
debug Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
deprecated Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
env Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
experimental Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
filesystem Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
filters Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
formats Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
generators Document and critically review ShellError variants - Ep. 2 (#8326) 2023-03-06 11:31:07 +01:00
hash Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
math Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
misc Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
network Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
path Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
platform Document and critically review ShellError variants - Ep. 2 (#8326) 2023-03-06 11:31:07 +01:00
random Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
shells Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
strings Document and critically review ShellError variants - Ep. 2 (#8326) 2023-03-06 11:31:07 +01:00
system Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
viewers Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
default_context.rs Remove the 'env' command, as we have the variable (#8185) 2023-03-01 21:20:00 +13:00
example_test.rs cratification: Example support (#8231) 2023-02-27 13:58:56 -08:00
input_handler.rs Standardise the use of ShellError::UnsupportedInput and ShellError::TypeMismatch and add spans to every instance of the former (#7217) 2022-12-23 01:48:53 -05:00
lib.rs Cratification: Break out nu_cmd_lang into a separate crate (#8181) 2023-02-24 09:54:42 -06:00
progress_bar.rs cp progress bar implementation (#8012) 2023-02-22 11:57:38 -08:00
sort_utils.rs Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00