mirror of
https://github.com/nushell/nushell.git
synced 2025-04-28 23:28:20 +02:00
6cdfee3573
# Description As part of the refactor to split spans off of Value, this moves to using helper functions to create values, and using `.span()` instead of matching span out of Value directly. Hoping to get a few more helping hands to finish this, as there are a lot of commands to update :) # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `cargo run -- -c "use std testing; testing run-tests --path crates/nu-std"` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. --> --------- Co-authored-by: Darren Schroeder <343840+fdncred@users.noreply.github.com> Co-authored-by: WindSoilder <windsoilder@outlook.com>
63 lines
1.8 KiB
Rust
63 lines
1.8 KiB
Rust
use nu_engine::get_full_help;
|
|
use nu_protocol::{
|
|
ast::Call,
|
|
engine::{Command, EngineState, Stack},
|
|
Category, IntoPipelineData, PipelineData, ShellError, Signature, Type, Value,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct PathCommand;
|
|
|
|
impl Command for PathCommand {
|
|
fn name(&self) -> &str {
|
|
"path"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("path")
|
|
.input_output_types(vec![(Type::Nothing, Type::String)])
|
|
.category(Category::Path)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Explore and manipulate paths."
|
|
}
|
|
|
|
fn extra_usage(&self) -> &str {
|
|
r#"You must use one of the following subcommands. Using this command as-is will only produce this help message.
|
|
|
|
There are three ways to represent a path:
|
|
|
|
* As a path literal, e.g., '/home/viking/spam.txt'
|
|
* As a structured path: a table with 'parent', 'stem', and 'extension' (and
|
|
* 'prefix' on Windows) columns. This format is produced by the 'path parse'
|
|
subcommand.
|
|
* As a list of path parts, e.g., '[ / home viking spam.txt ]'. Splitting into
|
|
parts is done by the `path split` command.
|
|
|
|
All subcommands accept all three variants as an input. Furthermore, the 'path
|
|
join' subcommand can be used to join the structured path or path parts back into
|
|
the path literal."#
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
Ok(Value::string(
|
|
get_full_help(
|
|
&PathCommand.signature(),
|
|
&PathCommand.examples(),
|
|
engine_state,
|
|
stack,
|
|
self.is_parser_keyword(),
|
|
),
|
|
call.head,
|
|
)
|
|
.into_pipeline_data())
|
|
}
|
|
}
|