Allow marking options with "deprecated" help or visibility

Abierto
#656 8 comentarios 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
swift
Área
cli

Línea de trabajo

Comienza en el punto de entrada @Option y sigue cómo se gestionan la visibilidad en la ayuda y los diagnósticos de la línea de comandos. Se considera terminado cuando la forma propuesta .deprecated(...) oculta la opción y emite una advertencia en stderr que dirige a los usuarios a la opción de reemplazo.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
Swift
Estrellas
3.8k
Forks
436
Merge medio
4 d 11 h
PR fusionados (30 d)
2

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de apple/swift-argument-parser

Todos los issues de apple/swift-argument-parser

Issues similares

Más issues de Swift

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.