mirror of
https://github.com/nushell/nushell.git
synced 2025-05-07 00:12:58 +00:00
This is the first PR towards migrating to a new `$env.PWD` API that returns potentially un-canonicalized paths. Refer to PR #12515 for motivations. ## New API: `EngineState::cwd()` The goal of the new API is to cover both parse-time and runtime use case, and avoid unintentional misuse. It takes an `Option<Stack>` as argument, which if supplied, will search for `$env.PWD` on the stack in additional to the engine state. I think with this design, there's less confusion over parse-time and runtime environments. If you have access to a stack, just supply it; otherwise supply `None`. ## Deprecation of other PWD-related APIs Other APIs are re-implemented using `EngineState::cwd()` and properly documented. They're marked deprecated, but their behavior is unchanged. Unused APIs are deleted, and code that accesses `$env.PWD` directly without using an API is rewritten. Deprecated APIs: * `EngineState::current_work_dir()` * `StateWorkingSet::get_cwd()` * `env::current_dir()` * `env::current_dir_str()` * `env::current_dir_const()` * `env::current_dir_str_const()` Other changes: * `EngineState::get_cwd()` (deleted) * `StateWorkingSet::list_env()` (deleted) * `repl::do_run_cmd()` (rewritten with `env::current_dir_str()`) ## `cd` and `pwd` now use logical paths by default This pulls the changes from PR #12515. It's currently somewhat broken because using non-canonicalized paths exposed a bug in our path normalization logic (Issue #12602). Once that is fixed, this should work. ## Future plans This PR needs some tests. Which test helpers should I use, and where should I put those tests? I noticed that unquoted paths are expanded within `eval_filepath()` and `eval_directory()` before they even reach the `cd` command. This means every paths is expanded twice. Is this intended? Once this PR lands, the plan is to review all usages of the deprecated APIs and migrate them to `EngineState::cwd()`. In the meantime, these usages are annotated with `#[allow(deprecated)]` to avoid breaking CI. --------- Co-authored-by: Jakub Žádník <kubouch@gmail.com>
108 lines
2.9 KiB
Rust
108 lines
2.9 KiB
Rust
#[allow(deprecated)]
|
|
use nu_engine::{command_prelude::*, current_dir};
|
|
|
|
use uu_mkdir::mkdir;
|
|
#[cfg(not(windows))]
|
|
use uucore::mode;
|
|
|
|
use super::util::get_rest_for_glob_pattern;
|
|
|
|
#[derive(Clone)]
|
|
pub struct UMkdir;
|
|
|
|
const IS_RECURSIVE: bool = true;
|
|
const DEFAULT_MODE: u32 = 0o777;
|
|
|
|
#[cfg(not(windows))]
|
|
fn get_mode() -> u32 {
|
|
!mode::get_umask() & DEFAULT_MODE
|
|
}
|
|
|
|
#[cfg(windows)]
|
|
fn get_mode() -> u32 {
|
|
DEFAULT_MODE
|
|
}
|
|
|
|
impl Command for UMkdir {
|
|
fn name(&self) -> &str {
|
|
"mkdir"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Create directories, with intermediary directories if required using uutils/coreutils mkdir."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["directory", "folder", "create", "make_dirs", "coreutils"]
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("mkdir")
|
|
.input_output_types(vec![(Type::Nothing, Type::Nothing)])
|
|
.rest(
|
|
"rest",
|
|
SyntaxShape::OneOf(vec![SyntaxShape::GlobPattern, SyntaxShape::Directory]),
|
|
"The name(s) of the path(s) to create.",
|
|
)
|
|
.switch(
|
|
"verbose",
|
|
"print a message for each created directory.",
|
|
Some('v'),
|
|
)
|
|
.category(Category::FileSystem)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
#[allow(deprecated)]
|
|
let cwd = current_dir(engine_state, stack)?;
|
|
let mut directories = get_rest_for_glob_pattern(engine_state, stack, call, 0)?
|
|
.into_iter()
|
|
.map(|dir| nu_path::expand_path_with(dir.item.as_ref(), &cwd, dir.item.is_expand()))
|
|
.peekable();
|
|
|
|
let is_verbose = call.has_flag(engine_state, stack, "verbose")?;
|
|
|
|
if directories.peek().is_none() {
|
|
return Err(ShellError::MissingParameter {
|
|
param_name: "requires directory paths".to_string(),
|
|
span: call.head,
|
|
});
|
|
}
|
|
|
|
for dir in directories {
|
|
if let Err(error) = mkdir(&dir, IS_RECURSIVE, get_mode(), is_verbose) {
|
|
return Err(ShellError::GenericError {
|
|
error: format!("{}", error),
|
|
msg: format!("{}", error),
|
|
span: None,
|
|
help: None,
|
|
inner: vec![],
|
|
});
|
|
}
|
|
}
|
|
|
|
Ok(PipelineData::empty())
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Make a directory named foo",
|
|
example: "mkdir foo",
|
|
result: None,
|
|
},
|
|
Example {
|
|
description: "Make multiple directories and show the paths created",
|
|
example: "mkdir -v foo/bar foo2",
|
|
result: None,
|
|
},
|
|
]
|
|
}
|
|
}
|