mirror of
https://github.com/nushell/nushell.git
synced 2025-04-29 15:44:28 +02:00
# 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:🐚: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:🐚: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:🐚: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:🐚: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:🐚: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:🐚: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.
118 lines
3.9 KiB
Rust
118 lines
3.9 KiB
Rust
use nu_engine::{current_dir, CallExt};
|
|
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{
|
|
Category, Example, PipelineData, ShellError, Signature, SyntaxShape, Type, Value,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct LoadEnv;
|
|
|
|
impl Command for LoadEnv {
|
|
fn name(&self) -> &str {
|
|
"load-env"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Loads an environment update from a record."
|
|
}
|
|
|
|
fn signature(&self) -> nu_protocol::Signature {
|
|
Signature::build("load-env")
|
|
.input_output_types(vec![(Type::Record(vec![]), Type::Nothing)])
|
|
.allow_variants_without_examples(true)
|
|
.optional(
|
|
"update",
|
|
SyntaxShape::Record,
|
|
"the record to use for updates",
|
|
)
|
|
.category(Category::FileSystem)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<nu_protocol::PipelineData, nu_protocol::ShellError> {
|
|
let arg: Option<(Vec<String>, Vec<Value>)> = call.opt(engine_state, stack, 0)?;
|
|
let span = call.head;
|
|
|
|
match arg {
|
|
Some((cols, vals)) => {
|
|
for (env_var, rhs) in cols.into_iter().zip(vals) {
|
|
if env_var == "FILE_PWD" {
|
|
return Err(ShellError::AutomaticEnvVarSetManually(env_var, call.head));
|
|
}
|
|
|
|
if env_var == "PWD" {
|
|
let cwd = current_dir(engine_state, stack)?;
|
|
let rhs = rhs.as_string()?;
|
|
let rhs = nu_path::expand_path_with(rhs, cwd);
|
|
stack.add_env_var(env_var, Value::string(rhs.to_string_lossy(), call.head));
|
|
} else {
|
|
stack.add_env_var(env_var, rhs);
|
|
}
|
|
}
|
|
Ok(PipelineData::empty())
|
|
}
|
|
None => match input {
|
|
PipelineData::Value(Value::Record { cols, vals, .. }, ..) => {
|
|
for (env_var, rhs) in cols.into_iter().zip(vals) {
|
|
if env_var == "FILE_PWD" {
|
|
return Err(ShellError::AutomaticEnvVarSetManually(env_var, call.head));
|
|
}
|
|
|
|
if env_var == "PWD" {
|
|
let cwd = current_dir(engine_state, stack)?;
|
|
let rhs = rhs.as_string()?;
|
|
let rhs = nu_path::expand_path_with(rhs, cwd);
|
|
stack.add_env_var(
|
|
env_var,
|
|
Value::string(rhs.to_string_lossy(), call.head),
|
|
);
|
|
} else {
|
|
stack.add_env_var(env_var, rhs);
|
|
}
|
|
}
|
|
Ok(PipelineData::empty())
|
|
}
|
|
_ => Err(ShellError::UnsupportedInput(
|
|
"'load-env' expects a single record".into(),
|
|
"value originated from here".into(),
|
|
span,
|
|
input.span().unwrap_or(span),
|
|
)),
|
|
},
|
|
}
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Load variables from an input stream",
|
|
example: r#"{NAME: ABE, AGE: UNKNOWN} | load-env; $env.NAME"#,
|
|
result: Some(Value::test_string("ABE")),
|
|
},
|
|
Example {
|
|
description: "Load variables from an argument",
|
|
example: r#"load-env {NAME: ABE, AGE: UNKNOWN}; $env.NAME"#,
|
|
result: Some(Value::test_string("ABE")),
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::LoadEnv;
|
|
|
|
#[test]
|
|
fn examples_work_as_expected() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(LoadEnv {})
|
|
}
|
|
}
|