dotnet / dotnet/command-line-api
[feature] Add the ability to dump all commands and parameters to a json file
- Vorherrschende Sprache
- C#
- Sterne
- 3.7k
- Forks
- 428
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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..."
Beitragsleitfaden
Rechercherichtung
Beginnen Sie mit der Prüfung des Feature-Bereichs von System.CommandLine und des referenzierten .NET CLI-Issues, um die erforderlichen Daten zu Befehl, Beschreibung, Option, Verbindlichkeitsstatus und Parameter zu klären. Vergleichen Sie das generierte JSON mit der CLI-Dokumentation unter der verlinkten Microsoft-URL und definieren Sie die Vervollständigung als stabilen Dump, der zwischen Releases verglichen und für die Dokumentationsautomatisierung verwendet werden kann.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- csharp
- Bereich
- cli
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100