mirror of
https://github.com/nushell/nushell
synced 2025-01-08 19:29:08 +00:00
c747ec75c9
# Description
When implementing a `Command`, one must also import all the types
present in the function signatures for `Command`. This makes it so that
we often import the same set of types in each command implementation
file. E.g., something like this:
```rust
use nu_protocol::ast::Call;
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{
record, Category, Example, IntoInterruptiblePipelineData, IntoPipelineData, PipelineData,
ShellError, Signature, Span, Type, Value,
};
```
This PR adds the `nu_engine::command_prelude` module which contains the
necessary and commonly used types to implement a `Command`:
```rust
// command_prelude.rs
pub use crate::CallExt;
pub use nu_protocol::{
ast::{Call, CellPath},
engine::{Command, EngineState, Stack},
record, Category, Example, IntoInterruptiblePipelineData, IntoPipelineData, IntoSpanned,
PipelineData, Record, ShellError, Signature, Span, Spanned, SyntaxShape, Type, Value,
};
```
This should reduce the boilerplate needed to implement a command and
also gives us a place to track the breadth of the `Command` API. I tried
to be conservative with what went into the prelude modules, since it
might be hard/annoying to remove items from the prelude in the future.
Let me know if something should be included or excluded.
97 lines
3.2 KiB
Rust
97 lines
3.2 KiB
Rust
use nu_engine::{
|
|
command_prelude::*, find_in_dirs_env, get_dirs_var_from_call, get_eval_block_with_early_return,
|
|
redirect_env,
|
|
};
|
|
use std::path::PathBuf;
|
|
|
|
/// Source a file for environment variables.
|
|
#[derive(Clone)]
|
|
pub struct SourceEnv;
|
|
|
|
impl Command for SourceEnv {
|
|
fn name(&self) -> &str {
|
|
"source-env"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("source-env")
|
|
.input_output_types(vec![(Type::Any, Type::Any)])
|
|
.required(
|
|
"filename",
|
|
SyntaxShape::String, // type is string to avoid automatically canonicalizing the path
|
|
"The filepath to the script file to source the environment from.",
|
|
)
|
|
.category(Category::Core)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Source the environment from a source file into the current environment."
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
caller_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let source_filename: Spanned<String> = call.req(engine_state, caller_stack, 0)?;
|
|
|
|
// 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, caller_stack, "block_id")?;
|
|
|
|
// Set the currently evaluated directory (file-relative PWD)
|
|
let file_path = if let Some(path) = find_in_dirs_env(
|
|
&source_filename.item,
|
|
engine_state,
|
|
caller_stack,
|
|
get_dirs_var_from_call(call),
|
|
)? {
|
|
PathBuf::from(&path)
|
|
} else {
|
|
return Err(ShellError::FileNotFound {
|
|
file: source_filename.item,
|
|
span: source_filename.span,
|
|
});
|
|
};
|
|
|
|
if let Some(parent) = file_path.parent() {
|
|
let file_pwd = Value::string(parent.to_string_lossy(), call.head);
|
|
|
|
caller_stack.add_env_var("FILE_PWD".to_string(), file_pwd);
|
|
}
|
|
|
|
caller_stack.add_env_var(
|
|
"CURRENT_FILE".to_string(),
|
|
Value::string(file_path.to_string_lossy(), call.head),
|
|
);
|
|
|
|
// Evaluate the block
|
|
let block = engine_state.get_block(block_id as usize).clone();
|
|
let mut callee_stack = caller_stack
|
|
.gather_captures(engine_state, &block.captures)
|
|
.reset_pipes();
|
|
|
|
let eval_block_with_early_return = get_eval_block_with_early_return(engine_state);
|
|
|
|
let result = eval_block_with_early_return(engine_state, &mut callee_stack, &block, input);
|
|
|
|
// Merge the block's environment to the current stack
|
|
redirect_env(engine_state, caller_stack, &callee_stack);
|
|
|
|
// Remove the file-relative PWD
|
|
caller_stack.remove_env_var(engine_state, "FILE_PWD");
|
|
caller_stack.remove_env_var(engine_state, "CURRENT_FILE");
|
|
|
|
result
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Sources the environment from foo.nu in the current context",
|
|
example: r#"source-env foo.nu"#,
|
|
result: None,
|
|
}]
|
|
}
|
|
}
|