Allow marking options with "deprecated" help or visibility

Aperta
  • Qualcosa non va?
#656 8 commenti 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 3 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
swift
Ambito
cli

Direzione di ricerca

Inizia dal punto di ingresso @Option e traccia come vengono gestite la visibilità nell’help e le diagnosi della riga di comando. Il lavoro è completo quando la forma proposta .deprecated(...) nasconde l’opzione ed emette un avviso su stderr indirizzando gli utenti all’opzione sostitutiva.

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

Descrizione

enhancement

Let's say my CLI tool has an old option that's no longer valid:

@Option
public var sendToCzechslovakia = false

Since Czechoslovakia doesn't exist anymore, I've replace it with sendToEuropeanUnion, and I want to inform folks still using it to change their command-line incantations. Wouldn't it be nice if I could write:

@Option(help: .deprecated("Use --send-to-european-union instead"))
public var sendToCzechslovakia = false

And have it automatically be hidden and emit some sort of diagnostic message to stderr?

⚠️ --send-to-czechoslovakia is deprecated: use --send-to-european-union instead
Lingua principale
Swift
Stelle
3.8k
Fork
436
Merge medio
4g 11h
PR unite (30g)
2

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di apple/swift-argument-parser

Tutte le issue di apple/swift-argument-parser

Issue simili

Altre issue su Swift

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.