2022-10-29 23:29:46 +02:00
|
|
|
use nu_protocol::ast::CellPath;
|
|
|
|
use nu_protocol::{PipelineData, ShellError, Span, Value};
|
2022-12-15 18:39:24 +01:00
|
|
|
use std::sync::atomic::AtomicBool;
|
2022-10-29 23:29:46 +02:00
|
|
|
use std::sync::Arc;
|
|
|
|
|
|
|
|
pub trait CmdArgument {
|
|
|
|
fn take_cell_paths(&mut self) -> Option<Vec<CellPath>>;
|
|
|
|
}
|
|
|
|
|
2022-11-01 12:40:11 +01:00
|
|
|
/// Arguments with only cell_path.
|
|
|
|
///
|
|
|
|
/// If commands is going to use `operate` function, and it only required optional cell_paths
|
|
|
|
/// Using this to simplify code.
|
|
|
|
pub struct CellPathOnlyArgs {
|
|
|
|
cell_paths: Option<Vec<CellPath>>,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl CmdArgument for CellPathOnlyArgs {
|
|
|
|
fn take_cell_paths(&mut self) -> Option<Vec<CellPath>> {
|
|
|
|
self.cell_paths.take()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl From<Vec<CellPath>> for CellPathOnlyArgs {
|
|
|
|
fn from(cell_paths: Vec<CellPath>) -> Self {
|
|
|
|
Self {
|
2022-11-04 16:27:23 +01:00
|
|
|
cell_paths: (!cell_paths.is_empty()).then_some(cell_paths),
|
2022-11-01 12:40:11 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-10-29 23:29:46 +02:00
|
|
|
/// A simple wrapper for `PipelineData::map` method.
|
|
|
|
///
|
|
|
|
/// In detail, for each elements, invoking relative `cmd` with `arg`.
|
|
|
|
///
|
2022-11-10 06:49:11 +01:00
|
|
|
/// If `arg` tell us that its cell path is not None, only map over data under these columns.
|
2022-10-29 23:29:46 +02:00
|
|
|
/// Else it will apply each column inside a table.
|
|
|
|
///
|
|
|
|
/// The validation of input element should be handle by `cmd` itself.
|
|
|
|
pub fn operate<C, A>(
|
|
|
|
cmd: C,
|
|
|
|
mut arg: A,
|
|
|
|
input: PipelineData,
|
|
|
|
span: Span,
|
|
|
|
ctrlc: Option<Arc<AtomicBool>>,
|
|
|
|
) -> Result<PipelineData, ShellError>
|
|
|
|
where
|
|
|
|
A: CmdArgument + Send + Sync + 'static,
|
|
|
|
C: Fn(&Value, &A, Span) -> Value + Send + Sync + 'static + Clone + Copy,
|
|
|
|
{
|
|
|
|
match arg.take_cell_paths() {
|
Standardise the use of ShellError::UnsupportedInput and ShellError::TypeMismatch and add spans to every instance of the former (#7217)
# Description
* I was dismayed to discover recently that UnsupportedInput and
TypeMismatch are used *extremely* inconsistently across the codebase.
UnsupportedInput is sometimes used for input type-checks (as per the
name!!), but *also* used for argument type-checks. TypeMismatch is also
used for both.
I thus devised the following standard: input type-checking *only* uses
UnsupportedInput, and argument type-checking *only* uses TypeMismatch.
Moreover, to differentiate them, UnsupportedInput now has *two* error
arrows (spans), one pointing at the command and the other at the input
origin, while TypeMismatch only has the one (because the command should
always be nearby)
* In order to apply that standard, a very large number of
UnsupportedInput uses were changed so that the input's span could be
retrieved and delivered to it.
* Additionally, I noticed many places where **errors are not propagated
correctly**: there are lots of `match` sites which take a Value::Error,
then throw it away and replace it with a new Value::Error with
less/misleading information (such as reporting the error as an
"incorrect type"). I believe that the earliest errors are the most
important, and should always be propagated where possible.
* Also, to standardise one broad subset of UnsupportedInput error
messages, who all used slightly different wordings of "expected
`<type>`, got `<type>`", I created OnlySupportsThisInputType as a
variant of it.
* Finally, a bunch of error sites that had "repeated spans" - i.e. where
an error expected two spans, but `call.head` was given for both - were
fixed to use different spans.
# Example
BEFORE
```
〉20b | str starts-with 'a'
Error: nu::shell::unsupported_input (link)
× Unsupported input
╭─[entry #31:1:1]
1 │ 20b | str starts-with 'a'
· ┬
· ╰── Input's type is filesize. This command only works with strings.
╰────
〉'a' | math cos
Error: nu::shell::unsupported_input (link)
× Unsupported input
╭─[entry #33:1:1]
1 │ 'a' | math cos
· ─┬─
· ╰── Only numerical values are supported, input type: String
╰────
〉0x[12] | encode utf8
Error: nu::shell::unsupported_input (link)
× Unsupported input
╭─[entry #38:1:1]
1 │ 0x[12] | encode utf8
· ───┬──
· ╰── non-string input
╰────
```
AFTER
```
〉20b | str starts-with 'a'
Error: nu::shell::pipeline_mismatch (link)
× Pipeline mismatch.
╭─[entry #1:1:1]
1 │ 20b | str starts-with 'a'
· ┬ ───────┬───────
· │ ╰── only string input data is supported
· ╰── input type: filesize
╰────
〉'a' | math cos
Error: nu::shell::pipeline_mismatch (link)
× Pipeline mismatch.
╭─[entry #2:1:1]
1 │ 'a' | math cos
· ─┬─ ────┬───
· │ ╰── only numeric input data is supported
· ╰── input type: string
╰────
〉0x[12] | encode utf8
Error: nu::shell::pipeline_mismatch (link)
× Pipeline mismatch.
╭─[entry #3:1:1]
1 │ 0x[12] | encode utf8
· ───┬── ───┬──
· │ ╰── only string input data is supported
· ╰── input type: binary
╰────
```
# User-Facing Changes
Various error messages suddenly make more sense (i.e. have two arrows
instead of one).
# 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 -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass
# After Submitting
If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2022-12-23 07:48:53 +01:00
|
|
|
None => input.map(
|
|
|
|
move |v| {
|
|
|
|
match v {
|
|
|
|
// Propagate errors inside the input
|
|
|
|
Value::Error { .. } => v,
|
|
|
|
_ => cmd(&v, &arg, span),
|
|
|
|
}
|
|
|
|
},
|
|
|
|
ctrlc,
|
|
|
|
),
|
2022-10-29 23:29:46 +02:00
|
|
|
Some(column_paths) => {
|
|
|
|
let arg = Arc::new(arg);
|
|
|
|
input.map(
|
|
|
|
move |mut v| {
|
|
|
|
for path in &column_paths {
|
|
|
|
let opt = arg.clone();
|
|
|
|
let r = v.update_cell_path(
|
|
|
|
&path.members,
|
Standardise the use of ShellError::UnsupportedInput and ShellError::TypeMismatch and add spans to every instance of the former (#7217)
# Description
* I was dismayed to discover recently that UnsupportedInput and
TypeMismatch are used *extremely* inconsistently across the codebase.
UnsupportedInput is sometimes used for input type-checks (as per the
name!!), but *also* used for argument type-checks. TypeMismatch is also
used for both.
I thus devised the following standard: input type-checking *only* uses
UnsupportedInput, and argument type-checking *only* uses TypeMismatch.
Moreover, to differentiate them, UnsupportedInput now has *two* error
arrows (spans), one pointing at the command and the other at the input
origin, while TypeMismatch only has the one (because the command should
always be nearby)
* In order to apply that standard, a very large number of
UnsupportedInput uses were changed so that the input's span could be
retrieved and delivered to it.
* Additionally, I noticed many places where **errors are not propagated
correctly**: there are lots of `match` sites which take a Value::Error,
then throw it away and replace it with a new Value::Error with
less/misleading information (such as reporting the error as an
"incorrect type"). I believe that the earliest errors are the most
important, and should always be propagated where possible.
* Also, to standardise one broad subset of UnsupportedInput error
messages, who all used slightly different wordings of "expected
`<type>`, got `<type>`", I created OnlySupportsThisInputType as a
variant of it.
* Finally, a bunch of error sites that had "repeated spans" - i.e. where
an error expected two spans, but `call.head` was given for both - were
fixed to use different spans.
# Example
BEFORE
```
〉20b | str starts-with 'a'
Error: nu::shell::unsupported_input (link)
× Unsupported input
╭─[entry #31:1:1]
1 │ 20b | str starts-with 'a'
· ┬
· ╰── Input's type is filesize. This command only works with strings.
╰────
〉'a' | math cos
Error: nu::shell::unsupported_input (link)
× Unsupported input
╭─[entry #33:1:1]
1 │ 'a' | math cos
· ─┬─
· ╰── Only numerical values are supported, input type: String
╰────
〉0x[12] | encode utf8
Error: nu::shell::unsupported_input (link)
× Unsupported input
╭─[entry #38:1:1]
1 │ 0x[12] | encode utf8
· ───┬──
· ╰── non-string input
╰────
```
AFTER
```
〉20b | str starts-with 'a'
Error: nu::shell::pipeline_mismatch (link)
× Pipeline mismatch.
╭─[entry #1:1:1]
1 │ 20b | str starts-with 'a'
· ┬ ───────┬───────
· │ ╰── only string input data is supported
· ╰── input type: filesize
╰────
〉'a' | math cos
Error: nu::shell::pipeline_mismatch (link)
× Pipeline mismatch.
╭─[entry #2:1:1]
1 │ 'a' | math cos
· ─┬─ ────┬───
· │ ╰── only numeric input data is supported
· ╰── input type: string
╰────
〉0x[12] | encode utf8
Error: nu::shell::pipeline_mismatch (link)
× Pipeline mismatch.
╭─[entry #3:1:1]
1 │ 0x[12] | encode utf8
· ───┬── ───┬──
· │ ╰── only string input data is supported
· ╰── input type: binary
╰────
```
# User-Facing Changes
Various error messages suddenly make more sense (i.e. have two arrows
instead of one).
# 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 -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass
# After Submitting
If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2022-12-23 07:48:53 +01:00
|
|
|
Box::new(move |old| {
|
|
|
|
match old {
|
|
|
|
// Propagate errors inside the input
|
|
|
|
Value::Error { .. } => old.clone(),
|
|
|
|
_ => cmd(old, &opt, span),
|
|
|
|
}
|
|
|
|
}),
|
2022-10-29 23:29:46 +02:00
|
|
|
);
|
|
|
|
if let Err(error) = r {
|
2023-03-12 09:57:27 +01:00
|
|
|
return Value::Error {
|
|
|
|
error: Box::new(error),
|
|
|
|
};
|
2022-10-29 23:29:46 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
v
|
|
|
|
},
|
|
|
|
ctrlc,
|
|
|
|
)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|