0chain / 0chain/zboxcli

[FEATURE] improve CLI command name and parameters with consistent naming

Offen
#113 0 Kommentare 0 Reaktionen 1 zugewiesene Person Beansprucht von @K-Kumar-01 Auf GitHub ansehen
enhancement post-mainnet
Vorherrschende Sprache
Go
Sterne
28
Forks
23
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

for now, there are some naming rules on cli command name
- lower-case: ` list-all`, `add-collab`
- lowercase: `listallocations`, `addcurator`,`encryptionpublickey`
- prefix: `alloc-cancel`,`alloc-fini`
- without prefix: `get`
- fullname: `list-all`
- shortname: `ls-blobbers`

And there are some naming rules on cli command parameters
- lower-case : `rx_pay`,`free_storage`,`read_price`, `write_price`
- lowercase: `remotepath`
- fullname: `allocation`
- shorname: `collabid`,`mcct`

It is better to rename all of them with consistent naming rule.

eg `lower-case with prefix and short name`, only root file system commands should be named without prefix.

for examples:
- `mkdir`, `copy`, `upload`, `download`,`delete`...etc
- `alloc-new`, `alloc-get`, `alloc-update`

see detail on https://0chain.slack.com/archives/C01U94VF56Y/p1632609085125300

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Das Issue betrifft die Umbenennung von CLI-Befehlen und Parametern für Konsistenz. Beginnen Sie mit der Untersuchung der bestehenden Befehlsdefinitionen im Codebase, wahrscheinlich in Dateien wie cmd/ oder main.go. Verstehen Sie die aktuellen Namensmuster und die vorgeschlagenen Regeln aus dem Slack-Link. Prüfen Sie, ob Tests aktualisiert werden müssen. 'Done' bedeutet, dass alle Befehle und ihre Parameter einer einzigen, konsistenten Namenskonvention folgen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
cli, go, shell
Bereich
cli, developer-experience
Issue-Typ
Refactoring
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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