mirror of
https://github.com/nushell/nushell.git
synced 2024-11-23 17:03:45 +01:00
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. |
||
|---|---|---|
| .. | ||
| assignment | ||
| date | ||
| hash_ | ||
| math | ||
| move_ | ||
| network | ||
| path | ||
| platform | ||
| query | ||
| random | ||
| skip | ||
| str_ | ||
| take | ||
| url | ||
| alias.rs | ||
| all.rs | ||
| any.rs | ||
| append.rs | ||
| break_.rs | ||
| cal.rs | ||
| cd.rs | ||
| compact.rs | ||
| continue_.rs | ||
| cp.rs | ||
| def.rs | ||
| default.rs | ||
| do_.rs | ||
| drop.rs | ||
| each.rs | ||
| echo.rs | ||
| empty.rs | ||
| enter.rs | ||
| error_make.rs | ||
| every.rs | ||
| exec.rs | ||
| export_def.rs | ||
| find.rs | ||
| first.rs | ||
| flatten.rs | ||
| for_.rs | ||
| format.rs | ||
| g.rs | ||
| get.rs | ||
| glob.rs | ||
| group_by.rs | ||
| headers.rs | ||
| help.rs | ||
| histogram.rs | ||
| insert.rs | ||
| into_filesize.rs | ||
| into_int.rs | ||
| last.rs | ||
| length.rs | ||
| let_.rs | ||
| lines.rs | ||
| loop_.rs | ||
| ls.rs | ||
| merge.rs | ||
| mkdir.rs | ||
| mod.rs | ||
| mut_.rs | ||
| n.rs | ||
| nu_check.rs | ||
| open.rs | ||
| p.rs | ||
| parse.rs | ||
| prepend.rs | ||
| print.rs | ||
| range.rs | ||
| redirection.rs | ||
| reduce.rs | ||
| reject.rs | ||
| rename.rs | ||
| return_.rs | ||
| reverse.rs | ||
| rm.rs | ||
| roll.rs | ||
| rotate.rs | ||
| run_external.rs | ||
| save.rs | ||
| select.rs | ||
| semicolon.rs | ||
| seq_char.rs | ||
| seq.rs | ||
| shells.rs | ||
| sort_by.rs | ||
| sort.rs | ||
| source_env.rs | ||
| split_by.rs | ||
| split_column.rs | ||
| split_row.rs | ||
| table.rs | ||
| to_text.rs | ||
| touch.rs | ||
| transpose.rs | ||
| try_.rs | ||
| uniq_by.rs | ||
| uniq.rs | ||
| update.rs | ||
| upsert.rs | ||
| use_.rs | ||
| where_.rs | ||
| which.rs | ||
| while_.rs | ||
| with_env.rs | ||
| wrap.rs | ||
| zip.rs | ||