mirror of
https://github.com/nushell/nushell.git
synced 2025-04-23 04:38:21 +02:00
5b01685fc3
# Description This updates all the positional arguments (except with `--features=dataframe` or `--features=extra`) to start with an uppercase letter and end with a period. Part of #5066, specifically [this comment](/nushell/nushell/issues/5066#issuecomment-1421528910) Some arguments had example data removed from them because it also appears in the examples. There are other inconsistencies in positional arguments I noticed while making the tests pass which I will bring up in #5066. # User-Facing Changes Positional arguments are now consistent # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` # After Submitting Automatic documentation updates
71 lines
2.2 KiB
Rust
71 lines
2.2 KiB
Rust
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 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 is_parser_keyword(&self) -> bool {
|
|
true
|
|
}
|
|
|
|
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")),
|
|
},
|
|
]
|
|
}
|
|
}
|