forked from extern/nushell
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.
69 lines
2.1 KiB
Rust
69 lines
2.1 KiB
Rust
use nu_engine::{command_prelude::*, get_eval_block_with_early_return};
|
|
use nu_protocol::engine::CommandType;
|
|
|
|
/// Source a file for environment variables.
|
|
#[derive(Clone)]
|
|
pub struct Source;
|
|
|
|
impl Command for Source {
|
|
fn name(&self) -> &str {
|
|
"source"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("source")
|
|
.input_output_types(vec![(Type::Any, Type::Any)])
|
|
.required(
|
|
"filename",
|
|
SyntaxShape::Filepath,
|
|
"The filepath to the script file to source.",
|
|
)
|
|
.category(Category::Core)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Runs a script file in the current context."
|
|
}
|
|
|
|
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> {
|
|
// Note: this hidden positional is the block_id that corresponded to the 0th position
|
|
// it is put here by the parser
|
|
let block_id: i64 = call.req_parser_info(engine_state, stack, "block_id")?;
|
|
let block = engine_state.get_block(block_id as usize).clone();
|
|
|
|
let eval_block_with_early_return = get_eval_block_with_early_return(engine_state);
|
|
|
|
eval_block_with_early_return(engine_state, stack, &block, input)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Runs foo.nu in the current context",
|
|
example: r#"source foo.nu"#,
|
|
result: None,
|
|
},
|
|
Example {
|
|
description: "Runs foo.nu in current context and call the command defined, suppose foo.nu has content: `def say-hi [] { echo 'Hi!' }`",
|
|
example: r#"source ./foo.nu; say-hi"#,
|
|
result: None,
|
|
},
|
|
]
|
|
}
|
|
}
|