carapace-sh / carapace-spec Goto Github PK

Add Action.Unless modifier with conditions.

$(<COMMAND>) is executed in a sh shell and should be skipped on windows.
Add $win(<COMMAND>) or similar for that provides a variant working on windows using powershell.

related #14

create yaml schema: https://developers.redhat.com/blog/2020/11/25/how-to-configure-yaml-schema-to-make-editing-files-easier#

https://github.com/invopop/jsonschema

load user defined macros from $(UserConfigDir)/carapace/macros

name: refs
description: git refs
default:
  branches: false
  tags: false
completion:
  - "$(${C_ARG_BRANCHES:-false} && git branch | cut -c 3-)"
  - "$(${C_ARG_TAGS:-false} && git tag)"

related #17
related #carapace-sh/carapace-bin#1082

Rename macros using CamelCase for consistency.

Support macros for values returned from $().
Exclude execute macros like $() from this for security reasons.

e.g. $files().chdir(/tmp).multiparts(/)

use reflection to not enforce rsteube/carapace-pflag

Request

Support exposed macros

Proposed solution

• macro core macro.
• _.macro (or _macro as it is now) internal macro of command interpreting the spec.
• command.macro external macro (<command> _carapace macro <macro>).
• TODO user defined macros (~/.config/carapace/macros/custom.yaml)
• TODO system macros (/usr/share/carapace/macros/system.yaml)

Anything else?

related #218

Request

Lots of frameworks and languages have json support out-of-the box but yaml would introduce an additional dependency.

Proposed solution

Provide secondary support for json (import/conversions).

Anything else?

No response

Request

Maybe support default values for optarg flags. At least for scraping it might be useful.

Proposed solution

flags:
  -o, --optarg[defaultValue]?: optarg flag

Anything else?

No response

Request

Provide special substitution to $C_FLAGS by expanding it to all currently set flags.
Use shlex.Join for formatting.

Proposed solution

No response

Anything else?

related #270
related #272

see carapace-sh/carapace#611 (comment)

e.g. clap

clap -> spec -> go code (see #75 )

executed too late?

Parse spec and generato a go based completer similar to carascrape

return ActionMessage for any error

related carapace-sh/carapace#611 (comment)

Is there a way to pass positional arguments to a command? something like ['$(cmd1 $C_ARG0 $C_ARG1 $C_ARG2)']

So that I can use an external command to do the dynamic completion.

Request

support ActionMultiParts.

Proposed solution

string array macro with delimiter as first element

$multiparts([:, $_os.Users, $_os.Groups])

Anything else?

No response

Request

support FlagSet.interspersed

Proposed solution

No response

Anything else?

No response

Request

Add hiddenFlags for flags that are hidded but can still be completed.
Also to prevent parse errors when using them.

Proposed solution

No response

Anything else?

No response

Request

Maybe support nargs for flags. Completion would be an issue though.

Proposed solution

flags:
  -n, --nargs{2}=: flag with 2 arguments
completion:
  flag:
    nargs{0}: ["1", "one"]
    nargs{1}: ["2", "two"]

Anything else?

related #176

support carapace-sh/carapace#599

Add support for other shells

Test:

• bash
• elvish
• fish
• nu
• osh
• pwsh
• xonsh
• zsh

related #272

Remove the _ prefix from core macros and use it for custom defined macros.

Add plugins bool (intended for root command) to enable implicit embedding of [spec.name]-plugin completion (e.g. cargo-fmt, git-extras).

name: example
plugins: true

Request

Consider renaming name to use and description to short.
Initially this felt more intuitive but since name now supports the full usage it might be a good idea to align the terms to cobra command.
Both could be supported for a while for transition.

Proposed solution

No response

Anything else?

No response

Request

Add run documentation including aliases.

Proposed solution

No response

Anything else?

No response

pwsh -c "Invoke-Command {param($p1); echo a b $p1} -ArgumentList 11,22"

related PowerShell/PowerShell#13832

There is some company trying to monetise completions for teams (thus they have more resources etc.), and their tool uses spec files for completions (MIT licensed I think) written in typescript:

https://fig.io/docs/getting-started

Potentially, making use of these may ease the burden on you to keep spec files up-to-date, but would require a translator from their files to your yaml ones. By the way thanks a ton for this, it really makes it easier for end-users to tweak completions!!!

Request

Pass all positional arguments to shell macro so that they can be accessed with $@, $1 ...

Proposed solution

esh ❯ bash -c "echo one" -- two three
one
carapace-spec on  master [!] via 🐹 v1.22.0                                                                                             
esh ❯ bash -c "echo one $1" -- two three
one two
carapace-spec on  master [!] via 🐹 v1.22.0                                                                                             
esh ❯ bash -c "echo one $@" -- two three
one two three

Anything else?

Optionally passing flags possible as well? (raw mode)

related #270