mirror of
https://github.com/nushell/nushell.git
synced 2025-03-26 07:19:55 +01:00
4c787af26d
# Description Now that we've landed the debug commands we were working on, let's relocate them to an easier place to find all of them. That's what this PR does. The only actual code change was changing the `timeit` command to a `Category::Debug` command. The rest is just moving things around and hooking them up. # User-Facing 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 -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.
102 lines
3.0 KiB
Rust
102 lines
3.0 KiB
Rust
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{Category, Example, PipelineData, ShellError, Signature, Span, Type, Value};
|
|
|
|
#[derive(Clone)]
|
|
pub struct Debug;
|
|
|
|
impl Command for Debug {
|
|
fn name(&self) -> &str {
|
|
"debug"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Debug print the value(s) piped in."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("debug")
|
|
.input_output_types(vec![
|
|
(
|
|
Type::List(Box::new(Type::Any)),
|
|
Type::List(Box::new(Type::String)),
|
|
),
|
|
(Type::Table(vec![]), Type::List(Box::new(Type::String))),
|
|
(Type::Any, Type::String),
|
|
])
|
|
.category(Category::Debug)
|
|
.switch("raw", "Prints the raw value representation", Some('r'))
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
let config = engine_state.get_config().clone();
|
|
let raw = call.has_flag("raw");
|
|
|
|
// Should PipelineData::Empty result in an error here?
|
|
|
|
input.map(
|
|
move |x| {
|
|
if raw {
|
|
Value::String {
|
|
val: x.debug_value(),
|
|
span: head,
|
|
}
|
|
} else {
|
|
Value::String {
|
|
val: x.debug_string(", ", &config),
|
|
span: head,
|
|
}
|
|
}
|
|
},
|
|
engine_state.ctrlc.clone(),
|
|
)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Debug print a string",
|
|
example: "'hello' | debug",
|
|
result: Some(Value::test_string("hello")),
|
|
},
|
|
Example {
|
|
description: "Debug print a list",
|
|
example: "['hello'] | debug",
|
|
result: Some(Value::List {
|
|
vals: vec![Value::test_string("hello")],
|
|
span: Span::test_data(),
|
|
}),
|
|
},
|
|
Example {
|
|
description: "Debug print a table",
|
|
example: "[[version patch]; [0.1.0 false] [0.1.1 true] [0.2.0 false]] | debug",
|
|
result: Some(Value::List {
|
|
vals: vec![
|
|
Value::test_string("{version: 0.1.0, patch: false}"),
|
|
Value::test_string("{version: 0.1.1, patch: true}"),
|
|
Value::test_string("{version: 0.2.0, patch: false}"),
|
|
],
|
|
span: Span::test_data(),
|
|
}),
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
#[test]
|
|
fn test_examples() {
|
|
use super::Debug;
|
|
use crate::test_examples;
|
|
test_examples(Debug {})
|
|
}
|
|
}
|