mirror of
https://github.com/nushell/nushell.git
synced 2025-06-09 19:46:56 +02:00
cc9f41e553
# Description
Kind of a vague title, but this PR does two main things:
1. Rather than overriding functions like `Command::is_parser_keyword`,
this PR instead changes commands to override `Command::command_type`.
The `CommandType` returned by `Command::command_type` is then used to
automatically determine whether `Command::is_parser_keyword` and the
other `is_{type}` functions should return true. These changes allow us
to remove the `CommandType::Other` case and should also guarantee than
only one of the `is_{type}` functions on `Command` will return true.
2. Uses the new, reworked `Command::command_type` function in the `scope
commands` and `which` commands.
# User-Facing Changes
- Breaking change for `scope commands`: multiple columns (`is_builtin`,
`is_keyword`, `is_plugin`, etc.) have been merged into the `type`
column.
- Breaking change: the `which` command can now report `plugin` or
`keyword` instead of `built-in` in the `type` column. It may also now
report `external` instead of `custom` in the `type` column for known
`extern`s.
68 lines
2.1 KiB
Rust
68 lines
2.1 KiB
Rust
use nu_engine::command_prelude::*;
|
|
use nu_protocol::engine::CommandType;
|
|
|
|
#[derive(Clone)]
|
|
pub struct Module;
|
|
|
|
impl Command for Module {
|
|
fn name(&self) -> &str {
|
|
"module"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Define a custom module."
|
|
}
|
|
|
|
fn signature(&self) -> nu_protocol::Signature {
|
|
Signature::build("module")
|
|
.input_output_types(vec![(Type::Nothing, Type::Nothing)])
|
|
.allow_variants_without_examples(true)
|
|
.required("module", SyntaxShape::String, "Module name or module path.")
|
|
.optional(
|
|
"block",
|
|
SyntaxShape::Block,
|
|
"Body of the module if 'module' parameter is not a module path.",
|
|
)
|
|
.category(Category::Core)
|
|
}
|
|
|
|
fn extra_usage(&self) -> &str {
|
|
r#"This command is a parser keyword. For details, check:
|
|
https://www.nushell.sh/book/thinking_in_nu.html"#
|
|
}
|
|
|
|
fn command_type(&self) -> CommandType {
|
|
CommandType::Keyword
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
_call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
Ok(PipelineData::empty())
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Define a custom command in a module and call it",
|
|
example: r#"module spam { export def foo [] { "foo" } }; use spam foo; foo"#,
|
|
result: Some(Value::test_string("foo")),
|
|
},
|
|
Example {
|
|
description: "Define an environment variable in a module",
|
|
example: r#"module foo { export-env { $env.FOO = "BAZ" } }; use foo; $env.FOO"#,
|
|
result: Some(Value::test_string("BAZ")),
|
|
},
|
|
Example {
|
|
description: "Define a custom command that participates in the environment in a module and call it",
|
|
example: r#"module foo { export def --env bar [] { $env.FOO_BAR = "BAZ" } }; use foo bar; bar; $env.FOO_BAR"#,
|
|
result: Some(Value::test_string("BAZ")),
|
|
},
|
|
]
|
|
}
|
|
}
|