0chain / 0chain/zboxcli

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

Aperta
#113 0 commenti 0 reazioni 1 assegnatario Rivendicata da @K-Kumar-01 Vedi su GitHub
enhancement post-mainnet
Lingua principale
Go
Stelle
28
Fork
23
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Il problema riguarda la ridenominazione dei comandi e dei parametri CLI per coerenza. Inizia esaminando le definizioni dei comandi esistenti nella codebase, probabilmente in file come cmd/ o main.go. Comprendi i modelli di denominazione attuali e le regole proposte dal link Slack. Controlla se ci sono test che potrebbero richiedere aggiornamenti. 'Done' significa che tutti i comandi e i loro parametri seguono una singola convenzione di denominazione coerente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
cli, go, shell
Ambito
cli, developer-experience
Tipo di issue
Refactoring
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.