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.
105 lines
3.3 KiB
Rust
105 lines
3.3 KiB
Rust
use nu_engine::{env::current_dir, eval_block};
|
|
use nu_parser::parse;
|
|
use nu_protocol::{
|
|
debugger::WithoutDebug,
|
|
engine::{Stack, StateWorkingSet, VirtualPath},
|
|
report_error, PipelineData,
|
|
};
|
|
use std::path::PathBuf;
|
|
|
|
// Virtual std directory unlikely to appear in user's file system
|
|
const NU_STDLIB_VIRTUAL_DIR: &str = "NU_STDLIB_VIRTUAL_DIR";
|
|
|
|
pub fn load_standard_library(
|
|
engine_state: &mut nu_protocol::engine::EngineState,
|
|
) -> Result<(), miette::ErrReport> {
|
|
let (block, delta) = {
|
|
// Using full virtual path to avoid potential conflicts with user having 'std' directory
|
|
// in their working directory.
|
|
let std_dir = PathBuf::from(NU_STDLIB_VIRTUAL_DIR).join("std");
|
|
|
|
let mut std_files = vec![
|
|
("mod.nu", include_str!("../std/mod.nu")),
|
|
("dirs.nu", include_str!("../std/dirs.nu")),
|
|
("dt.nu", include_str!("../std/dt.nu")),
|
|
("help.nu", include_str!("../std/help.nu")),
|
|
("iter.nu", include_str!("../std/iter.nu")),
|
|
("log.nu", include_str!("../std/log.nu")),
|
|
("assert.nu", include_str!("../std/assert.nu")),
|
|
("xml.nu", include_str!("../std/xml.nu")),
|
|
("input.nu", include_str!("../std/input.nu")),
|
|
("math.nu", include_str!("../std/math.nu")),
|
|
("formats.nu", include_str!("../std/formats.nu")),
|
|
];
|
|
|
|
let mut working_set = StateWorkingSet::new(engine_state);
|
|
let mut std_virt_paths = vec![];
|
|
|
|
for (name, content) in std_files.drain(..) {
|
|
let name = std_dir.join(name);
|
|
|
|
let file_id =
|
|
working_set.add_file(name.to_string_lossy().to_string(), content.as_bytes());
|
|
let virtual_file_id = working_set.add_virtual_path(
|
|
name.to_string_lossy().to_string(),
|
|
VirtualPath::File(file_id),
|
|
);
|
|
std_virt_paths.push(virtual_file_id);
|
|
}
|
|
|
|
let std_dir = std_dir.to_string_lossy().to_string();
|
|
let source = format!(
|
|
r#"
|
|
# Define the `std` module
|
|
module {std_dir}
|
|
|
|
# Prelude
|
|
use std dirs [
|
|
enter
|
|
shells
|
|
g
|
|
n
|
|
p
|
|
dexit
|
|
]
|
|
use std pwd
|
|
"#
|
|
);
|
|
|
|
let _ = working_set.add_virtual_path(std_dir, VirtualPath::Dir(std_virt_paths));
|
|
|
|
// Change the currently parsed directory
|
|
let prev_currently_parsed_cwd = working_set.currently_parsed_cwd.clone();
|
|
working_set.currently_parsed_cwd = Some(PathBuf::from(NU_STDLIB_VIRTUAL_DIR));
|
|
|
|
let block = parse(
|
|
&mut working_set,
|
|
Some("loading stdlib"),
|
|
source.as_bytes(),
|
|
false,
|
|
);
|
|
|
|
if let Some(err) = working_set.parse_errors.first() {
|
|
report_error(&working_set, err);
|
|
}
|
|
|
|
// Restore the currently parsed directory back
|
|
working_set.currently_parsed_cwd = prev_currently_parsed_cwd;
|
|
|
|
(block, working_set.render())
|
|
};
|
|
|
|
engine_state.merge_delta(delta)?;
|
|
|
|
// We need to evaluate the module in order to run the `export-env` blocks.
|
|
let mut stack = Stack::new();
|
|
let pipeline_data = PipelineData::Empty;
|
|
|
|
eval_block::<WithoutDebug>(engine_state, &mut stack, &block, pipeline_data)?;
|
|
|
|
let cwd = current_dir(engine_state, &stack)?;
|
|
engine_state.merge_env(&mut stack, cwd)?;
|
|
|
|
Ok(())
|
|
}
|