mirror of
https://github.com/nushell/nushell.git
synced 2025-05-08 00:42:57 +00:00
# Description follow up to #8529 cleaned up version of #8892 - the original syntax is okay ```nu def okay [rec: record] {} ``` - you can now add type annotations for fields if you know them before hand ```nu def okay [rec: record<name: string>] {} ``` - you can specify multiple fields ```nu def okay [person: record<name: string age: int>] {} # an optional comma is allowed def okay [person: record<name: string, age: int>] {} ``` - if annotations are specified, any use of the command will be type checked against the specified type ```nu def unwrap [result: record<ok: bool, value: any>] {} unwrap {ok: 2, value: "value"} # errors with Error: nu::parser::type_mismatch × Type mismatch. ╭─[entry #4:1:1] 1 │ unwrap {ok: 2, value: "value"} · ───────┬───── · ╰── expected record<ok: bool, value: any>, found record<ok: int, value: string> ╰──── ``` > here the error is in the `ok` field, since `any` is coerced into any type > as a result `unwrap {ok: true, value: "value"}` is okay - the key must be a string, either quoted or unquoted ```nu def err [rec: record<{}: list>] {} # errors with Error: × `record` type annotations key not string ╭─[entry #7:1:1] 1 │ def unwrap [result: record<{}: bool, value: any>] {} · ─┬ · ╰── must be a string ╰──── ``` - a key doesn't have to have a type in which case it is assumed to be `any` ```nu def okay [person: record<name age>] {} def okay [person: record<name: string age>] {} ``` - however, if you put a colon, you have to specify a type ```nu def err [person: record<name: >] {} # errors with Error: nu::parser::parse_mismatch × Parse mismatch during operation. ╭─[entry #12:1:1] 1 │ def unwrap [res: record<name: >] { $res } · ┬ · ╰── expected type after colon ╰──── ``` # User-Facing Changes **[BREAKING CHANGES]** - this change adds a field to `SyntaxShape::Record` so any plugins that used it will have to update and include the field. though if you are unsure of the type the record expects, `SyntaxShape::Record(vec![])` will suffice
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(vec![]),
|
|
"the record to use for updates",
|
|
)
|
|
.category(Category::FileSystem)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, 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) {
|
|
let env_var_ = env_var.as_str();
|
|
if ["FILE_PWD", "CURRENT_FILE", "PWD"].contains(&env_var_) {
|
|
return Err(ShellError::AutomaticEnvVarSetManually {
|
|
envvar_name: env_var,
|
|
span: call.head,
|
|
});
|
|
}
|
|
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) {
|
|
let env_var_ = env_var.as_str();
|
|
if ["FILE_PWD", "CURRENT_FILE"].contains(&env_var_) {
|
|
return Err(ShellError::AutomaticEnvVarSetManually {
|
|
envvar_name: env_var,
|
|
span: 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 {})
|
|
}
|
|
}
|