adobe / adobe/aio-cli-plugin-runtime

Aliases do not produce the same help docs

Offen
#271 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
bug
Vorherrschende Sprache
JavaScript
Sterne
21
Forks
33
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

I am not sure if it is recent Oclif changes, or our own extensive command/topic aliasing but using `rt` in place of `runtime` produces much less context in --help

```
aio runtime action --help
Manage your actions

USAGE
$ aio runtime action [--cert] [--key] [--apiversion] [--apihost] [-u] [-i] [--debug ] [-v] [--version] [--help]

FLAGS
-i, --insecure bypass certificate check
-u, --auth whisk auth
-v, --verbose Verbose output
--apihost whisk API host
--apiversion whisk API version
--cert client cert
--debug= Debug level output
--help Show help
--key client key
--version Show version

DESCRIPTION
Manage your actions

ALIASES
$ aio rt action

COMMANDS
runtime action create Creates an Action
runtime action delete Deletes an Action
runtime action get Retrieves an Action
runtime action invoke Invokes an Action
runtime action list Lists all the Actions
runtime action update Updates an Action
```

Versus the same thing with the rt alias

```
aio rt action --help
Manage your actions

USAGE
$ aio rt action [--cert] [--key] [--apiversion] [--apihost] [-u] [-i] [--debug ] [-v] [--version] [--help]

FLAGS
-i, --insecure bypass certificate check
-u, --auth whisk auth
-v, --verbose Verbose output
--apihost whisk API host
--apiversion whisk API version
--cert client cert
--debug= Debug level output
--help Show help
--key client key
--version Show version

DESCRIPTION
Manage your actions

ALIASES
$ aio rt action

```

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Reproduziere den Unterschied zwischen `aio runtime action --help` und `aio rt action --help`, und untersuche anschließend die von den runtime- und `rt`-Befehlen verwendeten Oclif-Einstiegspunkte für das Command-/Topic-Aliasing. Erledigt ist die Aufgabe, wenn die Hilfe für den Alias denselben Befehlskontext und dieselbe Dokumentation wie der kanonische Befehl enthält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
cli
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.