Move ansi link from extra to default feature, close #10792 (#10801)

<!--
if this PR closes one or more issues, you can automatically link the PR
with
them by using one of the [*linking
keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword),
e.g.
- this PR should close #xxxx
- fixes #xxxx

you can also mention related issues, PRs or discussions!
-->

# Description
<!--
Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.

Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.
-->

Move `ansi link` from extra to default feature, close #10792

# 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.
-->
This commit is contained in:
Justin Ma
2023-10-22 00:04:37 +08:00
committed by GitHub
parent 878f0cf6e1
commit db3f3eaf5a
6 changed files with 5 additions and 4 deletions

View File

@ -220,6 +220,7 @@ pub fn add_shell_command_context(mut engine_state: EngineState) -> EngineState {
// Platform
bind_command! {
Ansi,
AnsiLink,
AnsiStrip,
Clear,
Du,

View File

@ -0,0 +1,163 @@
use nu_engine::CallExt;
use nu_protocol::{
ast::{Call, CellPath},
engine::Command,
engine::EngineState,
engine::Stack,
Category, Example, PipelineData, ShellError, Signature, Span, Spanned, SyntaxShape, Type,
Value,
};
#[derive(Clone)]
pub struct SubCommand;
impl Command for SubCommand {
fn name(&self) -> &str {
"ansi link"
}
fn signature(&self) -> Signature {
Signature::build("ansi link")
.input_output_types(vec![
(Type::String, Type::String),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::String)),
),
(Type::Table(vec![]), Type::Table(vec![])),
(Type::Record(vec![]), Type::Record(vec![])),
])
.named(
"text",
SyntaxShape::String,
"Link text. Uses uri as text if absent. In case of
tables, records and lists applies this text to all elements",
Some('t'),
)
.rest(
"cell path",
SyntaxShape::CellPath,
"for a data structure input, add links to all strings at the given cell paths",
)
.allow_variants_without_examples(true)
.category(Category::Platform)
}
fn usage(&self) -> &str {
"Add a link (using OSC 8 escape sequence) to the given string."
}
fn run(
&self,
engine_state: &EngineState,
stack: &mut Stack,
call: &Call,
input: PipelineData,
) -> Result<PipelineData, ShellError> {
operate(engine_state, stack, call, input)
}
fn examples(&self) -> Vec<Example> {
vec![
Example {
description: "Create a link to open some file",
example: "'file:///file.txt' | ansi link --text 'Open Me!'",
result: Some(Value::string(
"\u{1b}]8;;file:///file.txt\u{1b}\\Open Me!\u{1b}]8;;\u{1b}\\",
Span::unknown(),
)),
},
Example {
description: "Create a link without text",
example: "'https://www.nushell.sh/' | ansi link",
result: Some(Value::string(
"\u{1b}]8;;https://www.nushell.sh/\u{1b}\\https://www.nushell.sh/\u{1b}]8;;\u{1b}\\",
Span::unknown(),
)),
},
Example {
description: "Format a table column into links",
example: "[[url text]; [https://example.com Text]] | ansi link url",
result: None,
},
]
}
}
fn operate(
engine_state: &EngineState,
stack: &mut Stack,
call: &Call,
input: PipelineData,
) -> Result<PipelineData, ShellError> {
let text: Option<Spanned<String>> = call.get_flag(engine_state, stack, "text")?;
let text = text.map(|e| e.item);
let column_paths: Vec<CellPath> = call.rest(engine_state, stack, 0)?;
let command_span = call.head;
if column_paths.is_empty() {
input.map(
move |v| process_value(&v, text.as_deref()),
engine_state.ctrlc.clone(),
)
} else {
input.map(
move |v| process_each_path(v, &column_paths, text.as_deref(), command_span),
engine_state.ctrlc.clone(),
)
}
}
fn process_each_path(
mut value: Value,
column_paths: &[CellPath],
text: Option<&str>,
command_span: Span,
) -> Value {
for path in column_paths {
let ret = value.update_cell_path(&path.members, Box::new(|v| process_value(v, text)));
if let Err(error) = ret {
return Value::error(error, command_span);
}
}
value
}
fn process_value(value: &Value, text: Option<&str>) -> Value {
let span = value.span();
match value {
Value::String { val, .. } => {
let text = text.unwrap_or(val.as_str());
let result = add_osc_link(text, val.as_str());
Value::string(result, span)
}
other => {
let got = format!("value is {}, not string", other.get_type());
Value::error(
ShellError::TypeMismatch {
err_message: got,
span: other.span(),
},
other.span(),
)
}
}
}
fn add_osc_link(text: &str, link: &str) -> String {
format!("\u{1b}]8;;{link}\u{1b}\\{text}\u{1b}]8;;\u{1b}\\")
}
#[cfg(test)]
mod tests {
use super::SubCommand;
#[test]
fn examples_work_as_expected() {
use crate::test_examples;
test_examples(SubCommand {})
}
}

View File

@ -1,5 +1,7 @@
mod ansi_;
mod link;
mod strip;
pub use ansi_::AnsiCommand as Ansi;
pub use link::SubCommand as AnsiLink;
pub use strip::SubCommand as AnsiStrip;

View File

@ -7,7 +7,7 @@ mod kill;
mod sleep;
mod term_size;
pub use ansi::{Ansi, AnsiStrip};
pub use ansi::{Ansi, AnsiLink, AnsiStrip};
pub use clear::Clear;
pub use dir_info::{DirBuilder, DirInfo, FileInfo};
pub use du::Du;