mirror of
https://github.com/nushell/nushell
synced 2024-12-29 06:23:11 +00: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>
66 lines
1.7 KiB
Rust
66 lines
1.7 KiB
Rust
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{Category, Example, PipelineData, ShellError, Signature, Type, Value};
|
|
use reedline::Highlighter;
|
|
|
|
#[derive(Clone)]
|
|
pub struct NuHighlight;
|
|
|
|
impl Command for NuHighlight {
|
|
fn name(&self) -> &str {
|
|
"nu-highlight"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("nu-highlight")
|
|
.category(Category::Strings)
|
|
.input_output_types(vec![(Type::String, Type::String)])
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Syntax highlight the input string."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["syntax", "color", "convert"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
|
|
let ctrlc = engine_state.ctrlc.clone();
|
|
let engine_state = std::sync::Arc::new(engine_state.clone());
|
|
let config = engine_state.get_config().clone();
|
|
|
|
let highlighter = crate::NuHighlighter {
|
|
engine_state,
|
|
config,
|
|
};
|
|
|
|
input.map(
|
|
move |x| match x.as_string() {
|
|
Ok(line) => {
|
|
let highlights = highlighter.highlight(&line, line.len());
|
|
|
|
Value::string(highlights.render_simple(), head)
|
|
}
|
|
Err(err) => Value::error(err, head),
|
|
},
|
|
ctrlc,
|
|
)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Describe the type of a string",
|
|
example: "'let x = 3' | nu-highlight",
|
|
result: None,
|
|
}]
|
|
}
|
|
}
|