nushell/crates/nu-command/src/platform/ansi
Antoine Stevan 427db0d101
FEATURE: better ansi -e error (#8709)
Should close #8704.

# Description
this PR
- makes the error thrown by things like `ansi -e {invalid: "invalid"}`
more explicit
- makes the `ansi -e` example more explicit about valid / invalid keys

# User-Facing Changes
the error
```bash
> ansi -e {invalid: "invalid"}
Error: nu:🐚:incompatible_parameters

  × Incompatible parameters.
   ╭─[entry #1:1:1]
 1 │ ansi -e {invalid: "invalid"}
   ·         ──────────┬─────────
   ·                   ╰── unknown ANSI format key: expected one of ['fg', 'bg', 'attr'], found 'invalid'
   ╰────
```

the new `ansi -e` example
```bash
  Use structured escape codes
  > let bold_blue_on_red = {  # `fg`, `bg`, `attr` are the acceptable keys, all other keys are considered invalid and will throw errors.
        fg: '#0000ff'
        bg: '#ff0000'
        attr: b
    }
    $"(ansi -e $bold_blue_on_red)Hello Nu World(ansi reset)"
  Hello Nu World
```

# Tests + Formatting
- 🟢 `toolkit fmt`
- 🟢 `toolkit clippy`
-  `toolkit test`
-  `toolkit test stdlib`

# After Submitting
```
$nothing
```
2023-04-05 23:14:39 +02:00
..
ansi_.rs FEATURE: better ansi -e error (#8709) 2023-04-05 23:14:39 +02:00
gradient.rs Box ShellError in Value::Error (#8375) 2023-03-12 09:57:27 +01:00
link.rs Box ShellError in Value::Error (#8375) 2023-03-12 09:57:27 +01:00
mod.rs Ansi link (#7751) 2023-01-15 17:23:37 +02:00
strip.rs Box ShellError in Value::Error (#8375) 2023-03-12 09:57:27 +01:00