nushell/crates/nu-cli/src
WindSoilder 5d98a727ca
Deprecate --flag: bool in custom command (#11365)
# Description
While #11057 is merged, it's hard to tell the difference between
`--flag: bool` and `--flag`, and it makes user hard to read custom
commands' signature, and hard to use them correctly.

After discussion, I think we can deprecate `--flag: bool` usage, and
encourage using `--flag` instead.

# User-Facing Changes
The following code will raise warning message, but don't stop from
running.
```nushell
❯ def florb [--dry-run: bool, --another-flag] { "aaa" };  florb
Error:   × Deprecated: --flag: bool
   ╭─[entry #7:1:1]
 1 │ def florb [--dry-run: bool, --another-flag] { "aaa" };  florb
   ·                       ──┬─
   ·                         ╰── `--flag: bool` is deprecated. Please use `--flag` instead, more info: https://www.nushell.sh/book/custom_commands.html
   ╰────

aaa
```

cc @kubouch 

# Tests + Formatting
Done

# After Submitting
- [ ] Add more information under
https://www.nushell.sh/book/custom_commands.html to indicate `--dry-run:
bool` is not allowed,
- [ ] remove `: bool` from custom commands between 0.89 and 0.90

---------

Co-authored-by: Antoine Stevan <44101798+amtoine@users.noreply.github.com>
2023-12-21 10:07:08 +01:00
..
commands Move history into their own module (#11308) 2023-12-15 13:17:12 +01:00
completions improve completions of use and overlay use (#11330) 2023-12-19 17:14:34 +08:00
menus Improve case insensitivity consistency (#10884) 2023-11-08 23:58:54 +01:00
config_files.rs Fix config creation during printing (#9353) 2023-06-04 22:04:28 +03:00
eval_cmds.rs Deprecate --flag: bool in custom command (#11365) 2023-12-21 10:07:08 +01:00
eval_file.rs Convert remainder of ShellError variants to named fields (#11276) 2023-12-09 18:46:21 -06:00
lib.rs cratification: move the bytes command to nu-cmd-extra (#9509) 2023-06-23 12:23:08 -07:00
nu_highlight.rs Move Value to helpers, separate span call (#10121) 2023-09-03 07:27:29 -07:00
print.rs allow print to take data as input again (#9823) 2023-07-27 21:40:25 +02:00
prompt_update.rs Only run $env.PROMPT_COMMAND once per prompt (copy of #10986) (#11366) 2023-12-18 09:33:04 -06:00
prompt.rs fix shell integration markers (#11352) 2023-12-16 20:12:34 -06:00
reedline_config.rs Convert more ShellError variants to named fields (#11222) 2023-12-04 10:19:32 +01:00
repl.rs Only run $env.PROMPT_COMMAND once per prompt (copy of #10986) (#11366) 2023-12-18 09:33:04 -06:00
syntax_highlight.rs Remove Expr::MatchPattern (#11367) 2023-12-20 18:52:28 +01:00
util.rs Deprecate --flag: bool in custom command (#11365) 2023-12-21 10:07:08 +01:00
validation.rs Remove old alias implementation (#8797) 2023-04-07 21:09:38 +03:00