extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-01-11 08:48:23 +01:00
Code Issues Packages Projects Releases Wiki Activity
9172b22985
nushell/crates/nu-cli
History
Stefan Holderbach 9172b22985
Rework help generation internals (#13531) 
Reworking some of the sprawling code we use to generate the `help cmd`
or `cmd --help` output.

This touches mainly the rendering and not the gathering of the necessary
data (see open bugs under
[label:help-system](https://github.com/nushell/nushell/issues?q=sort%3Aupdated-desc+is%3Aopen+label%3Ahelp-system))

Fixes #9076 
Fixes the syntax shape output on flags to be consistent.

## Example
```nushell
def test [
  positional: int,
  documented: float, # this has documentation
  default = 50,
  optional?,
  --a = "bla",
  --bla (-b) = "bla", # named with default
] {}
```

### before

![grafik](https://github.com/user-attachments/assets/1867984f-1289-4ad0-bdf5-c49ec56dfddb)


### after


![grafik](https://github.com/user-attachments/assets/8fca526f-d878-4d52-b970-fc41c7e8859c)
2024-08-05 22:44:24 +02:00
..
src Rework help generation internals (#13531) 2024-08-05 22:44:24 +02:00
tests Keep forward slash when autocomplete on Windows (#13321) 2024-07-30 08:28:41 -05:00
Cargo.toml Bump version to 0.96.2 (#13485) 2024-07-29 17:20:55 -07:00
LICENSE Fix rest of license year ranges (#8727) 2023-04-04 09:03:29 +12:00
README.md Add top-level crate documentation/READMEs (#12907) 2024-07-14 10:10:41 +02:00

README.md

This crate implements the core functionality of the interactive Nushell REPL and interfaces with reedline. Currently implements the syntax highlighting and completions logic. Furthermore includes a few commands that are specific to reedline

Internal Nushell crate

This crate implements components of Nushell and is not designed to support plugin authors or other users directly.