dd7b7311b3
# Description * I was dismayed to discover recently that UnsupportedInput and TypeMismatch are used *extremely* inconsistently across the codebase. UnsupportedInput is sometimes used for input type-checks (as per the name!!), but *also* used for argument type-checks. TypeMismatch is also used for both. I thus devised the following standard: input type-checking *only* uses UnsupportedInput, and argument type-checking *only* uses TypeMismatch. Moreover, to differentiate them, UnsupportedInput now has *two* error arrows (spans), one pointing at the command and the other at the input origin, while TypeMismatch only has the one (because the command should always be nearby) * In order to apply that standard, a very large number of UnsupportedInput uses were changed so that the input's span could be retrieved and delivered to it. * Additionally, I noticed many places where **errors are not propagated correctly**: there are lots of `match` sites which take a Value::Error, then throw it away and replace it with a new Value::Error with less/misleading information (such as reporting the error as an "incorrect type"). I believe that the earliest errors are the most important, and should always be propagated where possible. * Also, to standardise one broad subset of UnsupportedInput error messages, who all used slightly different wordings of "expected `<type>`, got `<type>`", I created OnlySupportsThisInputType as a variant of it. * Finally, a bunch of error sites that had "repeated spans" - i.e. where an error expected two spans, but `call.head` was given for both - were fixed to use different spans. # Example BEFORE ``` 〉20b | str starts-with 'a' Error: nu:🐚:unsupported_input (link) × Unsupported input ╭─[entry #31:1:1] 1 │ 20b | str starts-with 'a' · ┬ · ╰── Input's type is filesize. This command only works with strings. ╰──── 〉'a' | math cos Error: nu:🐚:unsupported_input (link) × Unsupported input ╭─[entry #33:1:1] 1 │ 'a' | math cos · ─┬─ · ╰── Only numerical values are supported, input type: String ╰──── 〉0x[12] | encode utf8 Error: nu:🐚:unsupported_input (link) × Unsupported input ╭─[entry #38:1:1] 1 │ 0x[12] | encode utf8 · ───┬── · ╰── non-string input ╰──── ``` AFTER ``` 〉20b | str starts-with 'a' Error: nu:🐚:pipeline_mismatch (link) × Pipeline mismatch. ╭─[entry #1:1:1] 1 │ 20b | str starts-with 'a' · ┬ ───────┬─────── · │ ╰── only string input data is supported · ╰── input type: filesize ╰──── 〉'a' | math cos Error: nu:🐚:pipeline_mismatch (link) × Pipeline mismatch. ╭─[entry #2:1:1] 1 │ 'a' | math cos · ─┬─ ────┬─── · │ ╰── only numeric input data is supported · ╰── input type: string ╰──── 〉0x[12] | encode utf8 Error: nu:🐚:pipeline_mismatch (link) × Pipeline mismatch. ╭─[entry #3:1:1] 1 │ 0x[12] | encode utf8 · ───┬── ───┬── · │ ╰── only string input data is supported · ╰── input type: binary ╰──── ``` # User-Facing Changes Various error messages suddenly make more sense (i.e. have two arrows instead of one). # 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.
111 lines
3.1 KiB
Rust
111 lines
3.1 KiB
Rust
use indexmap::map::IndexMap;
|
|
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{
|
|
Category, Example, IntoPipelineData, PipelineData, ShellError, Signature, Span, Type, Value,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct FromIni;
|
|
|
|
impl Command for FromIni {
|
|
fn name(&self) -> &str {
|
|
"from ini"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("from ini")
|
|
.input_output_types(vec![(Type::String, Type::Record(vec![]))])
|
|
.category(Category::Formats)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Parse text as .ini and create record"
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
example: "'[foo]
|
|
a=1
|
|
b=2' | from ini",
|
|
description: "Converts ini formatted string to record",
|
|
result: Some(Value::Record {
|
|
cols: vec!["foo".to_string()],
|
|
vals: vec![Value::Record {
|
|
cols: vec!["a".to_string(), "b".to_string()],
|
|
vals: vec![
|
|
Value::string("1", Span::test_data()),
|
|
Value::string("2", Span::test_data()),
|
|
],
|
|
span: Span::test_data(),
|
|
}],
|
|
span: Span::test_data(),
|
|
}),
|
|
}]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<nu_protocol::PipelineData, ShellError> {
|
|
let head = call.head;
|
|
from_ini(input, head)
|
|
}
|
|
}
|
|
|
|
pub fn from_ini_string_to_value(
|
|
s: String,
|
|
span: Span,
|
|
val_span: Span,
|
|
) -> Result<Value, ShellError> {
|
|
let v: Result<IndexMap<String, IndexMap<String, String>>, serde_ini::de::Error> =
|
|
serde_ini::from_str(&s);
|
|
match v {
|
|
Ok(index_map) => {
|
|
let (cols, vals) = index_map
|
|
.into_iter()
|
|
.fold((vec![], vec![]), |mut acc, (k, v)| {
|
|
let (cols, vals) = v.into_iter().fold((vec![], vec![]), |mut acc, (k, v)| {
|
|
acc.0.push(k);
|
|
acc.1.push(Value::String { val: v, span });
|
|
acc
|
|
});
|
|
acc.0.push(k);
|
|
acc.1.push(Value::Record { cols, vals, span });
|
|
acc
|
|
});
|
|
Ok(Value::Record { cols, vals, span })
|
|
}
|
|
Err(err) => Err(ShellError::UnsupportedInput(
|
|
format!("Could not load ini: {}", err),
|
|
"value originates from here".into(),
|
|
span,
|
|
val_span,
|
|
)),
|
|
}
|
|
}
|
|
|
|
fn from_ini(input: PipelineData, head: Span) -> Result<PipelineData, ShellError> {
|
|
let (concat_string, span, metadata) = input.collect_string_strict(head)?;
|
|
|
|
match from_ini_string_to_value(concat_string, head, span) {
|
|
Ok(x) => Ok(x.into_pipeline_data_with_metadata(metadata)),
|
|
Err(other) => Err(other),
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(FromIni {})
|
|
}
|
|
}
|