mirror of
https://github.com/nushell/nushell.git
synced 2025-05-16 04:34:34 +00:00
a5c604c283
# Description Working on uniformizing the ending messages regarding methods usage() and extra_usage(). This is related to the issue https://github.com/nushell/nushell/issues/5066 after discussing it with @jntrnr # User-Facing Changes None. # 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 -A clippy::needless_collect` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass # 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.
50 lines
1.2 KiB
Rust
50 lines
1.2 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 View;
|
|
|
|
impl Command for View {
|
|
fn name(&self) -> &str {
|
|
"view"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("view")
|
|
.category(Category::Debug)
|
|
.input_output_types(vec![(Type::Nothing, Type::String)])
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Various commands for viewing debug information."
|
|
}
|
|
|
|
fn extra_usage(&self) -> &str {
|
|
"You must use one of the following subcommands. Using this command as-is will only produce this help message."
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
Ok(Value::String {
|
|
val: get_full_help(
|
|
&View.signature(),
|
|
&View.examples(),
|
|
engine_state,
|
|
stack,
|
|
self.is_parser_keyword(),
|
|
),
|
|
span: call.head,
|
|
}
|
|
.into_pipeline_data())
|
|
}
|
|
}
|