RGBCube/nu_scripts
1
Fork 0
mirror of https://github.com/RGBCube/nu_scripts synced 2025-08-01 06:37:46 +00:00
Code Issues Activity

Improve auto-gen README.md (#1093)

Browse source 
* Fix typo
* Add code fences
* Use `nushell` instead of `nu` code block language, so it renders
correctly on GitHub
* Use correct headline levels (only one instead of three top headlines)
* Add paragraph spacing where applicable
* Add trailing newline
This commit is contained in:
Jan Klass 2025-04-20 17:02:47 +02:00 • committed by GitHub
parent d48b4a0b2b
commit 98973a271f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 28 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

46
needs-update/custom-completions/auto-generate/README.md
View file

@ -1,56 +1,61 @@
# auto-generate completions # auto-generate completions
- basic helpers to parse --help information from cli commands and export nu completions source - basic helpers to parse `--help` information from cli commands and export nu completions source
- basic helpers tp parse .fish complete files and export nu completions source - basic helpers to parse `.fish` complete files and export nu completions source
# parse-fish ## parse-fish
### current
## current
- only parses out simple complete's with no complete's boolean arguments like -f - only parses out simple complete's with no complete's boolean arguments like -f
- does not map fish autocomplete helpers to nu-complete helps (a nu library of autocomplete utils would be neat) - does not map fish autocomplete helpers to nu-complete helps (a nu library of autocomplete utils would be neat)
## usage ### usage
be in a directory with one or more .fish completion scripts be in a directory with one or more `.fish` completion scripts
A good one is A good one is
`git clone https://github.com/fish-shell/fish-shell` ```nushell
`cd fish-shell/share/completions` git clone https://github.com/fish-shell/fish-shell
cd fish-shell/share/completions
```
To build all .fish files in the current directory `build-completions-from-pwd` To build all `.fish` files in the current directory `build-completions-from-pwd`
```nu ```nushell
build-completions-from-pwd build-completions-from-pwd
ls *.nu ls *.nu
``` ```
To build a single .fish file and choose the output file To build a single `.fish` file and choose the output file
```nu
```nushell
build-completion cargo.fish cargo.nu build-completion cargo.fish cargo.nu
``` ```
# parse-help
## current limitations ## parse-help
- Only flags are parsed, arguments are not parsed and ...args is injected at the end to catch all ### current limitations
- Only flags are parsed, arguments are not parsed and `...args` is injected at the end to catch all
- Some examples of `--flags` in descriptions can throw off the regex and get included in the parsed flags - Some examples of `--flags` in descriptions can throw off the regex and get included in the parsed flags
- `<format>` (types) to flags are parsed, but not added to the nu shell completion type hints - `<format>` (types) to flags are parsed, but not added to the nu shell completion type hints
## usage ### usage
generate and save source to a file generate and save source to a file
```nu ```nushell
source parse-help.nu source parse-help.nu
cargo --help | parse-help | make-completion cargo | save cargo.nu cargo --help | parse-help | make-completion cargo | save cargo.nu
``` ```
## example ### example
This can be saved to a file and sourced. Example of output This can be saved to a file and sourced. Example of output
```nu ```nushell
extern "cargo" [ extern "cargo" [
--version(-V) #Print version info and exit --version(-V) #Print version info and exit
--list #List installed commands --list #List installed commands
@ -84,7 +89,8 @@ extern "nu" [
``` ```
Which outputs like so on tab completion for `cargo --` Which outputs like so on tab completion for `cargo --`
```
```nushell
❯ | cargo -- ❯ | cargo --
--color Coloring: auto, always, never --color Coloring: auto, always, never
--config Override a configuration value (unstable) --config Override a configuration value (unstable)