99076af18b
# Description _(Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes.)_ I opened this PR to unify the run command method. It's mainly to improve consistency across the tree. # 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.
116 lines
3.3 KiB
Rust
116 lines
3.3 KiB
Rust
use crate::formats::to::delimited::to_delimited_data;
|
|
use nu_engine::CallExt;
|
|
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{
|
|
Category, Config, Example, PipelineData, ShellError, Signature, Span, Spanned, SyntaxShape,
|
|
Type, Value,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct ToCsv;
|
|
|
|
impl Command for ToCsv {
|
|
fn name(&self) -> &str {
|
|
"to csv"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("to csv")
|
|
.input_output_types(vec![
|
|
(Type::Record(vec![]), Type::String),
|
|
(Type::Table(vec![]), Type::String),
|
|
])
|
|
.named(
|
|
"separator",
|
|
SyntaxShape::String,
|
|
"a character to separate columns, defaults to ','",
|
|
Some('s'),
|
|
)
|
|
.switch(
|
|
"noheaders",
|
|
"do not output the columns names as the first row",
|
|
Some('n'),
|
|
)
|
|
.category(Category::Formats)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Outputs an CSV string representing the contents of this table",
|
|
example: "[[foo bar]; [1 2]] | to csv",
|
|
result: Some(Value::test_string("foo,bar\n1,2\n")),
|
|
},
|
|
Example {
|
|
description: "Outputs an CSV string representing the contents of this table",
|
|
example: "[[foo bar]; [1 2]] | to csv -s ';' ",
|
|
result: Some(Value::test_string("foo;bar\n1;2\n")),
|
|
},
|
|
Example {
|
|
description: "Outputs an CSV string representing the contents of this record",
|
|
example: "{a: 1 b: 2} | to csv",
|
|
result: Some(Value::test_string("a,b\n1,2\n")),
|
|
},
|
|
]
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Convert table into .csv text "
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
let noheaders = call.has_flag("noheaders");
|
|
let separator: Option<Spanned<String>> = call.get_flag(engine_state, stack, "separator")?;
|
|
let config = engine_state.get_config();
|
|
to_csv(input, noheaders, separator, head, config)
|
|
}
|
|
}
|
|
|
|
fn to_csv(
|
|
input: PipelineData,
|
|
noheaders: bool,
|
|
separator: Option<Spanned<String>>,
|
|
head: Span,
|
|
config: &Config,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let sep = match separator {
|
|
Some(Spanned { item: s, span, .. }) => {
|
|
if s == r"\t" {
|
|
'\t'
|
|
} else {
|
|
let vec_s: Vec<char> = s.chars().collect();
|
|
if vec_s.len() != 1 {
|
|
return Err(ShellError::TypeMismatch(
|
|
"Expected a single separator char from --separator".to_string(),
|
|
span,
|
|
));
|
|
};
|
|
vec_s[0]
|
|
}
|
|
}
|
|
_ => ',',
|
|
};
|
|
|
|
to_delimited_data(noheaders, sep, "CSV", input, head, config)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(ToCsv {})
|
|
}
|
|
}
|