dotnet / dotnet/command-line-api

[feature] Add the ability to dump all commands and parameters to a json file

Aperta
#401 4 commenti 3 reazioni 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
C#
Stelle
3.7k
Fork
428
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

This was requested of the .NET CLI https://github.com/dotnet/cli/issues/10673. I feel it is needed across enough CLI's to warrant consideration as a feature of System.CommandLine. Key part is marked.

"Regarding the CLI docs published here: https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet?tabs=netcore21

One thing that will help us get docs published easily for CLI reference is if we can _dump the whole list of commands, descriptions, option/mandatory status, parameters list, etc_. This way we can easily diff between releases to see what has changed. It will also allow us to automate the documentation!

It's very troublesome to update the CLI ref which is literally a copy/paste of output from running the commands by hand..."

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia esaminando l’area delle funzionalità di System.CommandLine e l’issue .NET CLI referenziata per chiarire i dati richiesti per il comando, la descrizione, l’opzione, lo stato di obbligatorietà e il parametro. Confronta il JSON generato con la documentazione CLI all’URL Microsoft collegato e definisci il completamento come un dump stabile che possa essere confrontato tra le release e utilizzato per l’automazione della documentazione.

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

Valutazione

Stack tecnologico
csharp
Ambito
cli
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.