Spectre.Console.Extensions

Spectre.console.extensions

Ziel dieses Projekts ist es, Specree.Console -Plugins mit einigen Nischenfunktionen zu erweitern.

• Fortschritt mit IProgress -Adapter.
• Fortschritte bei der automatischen Berichterstattung für HttpClient .
• Tabelle mit DataTable .

Paket	Version	Beschreibung
Spectre.Console.Extensions.Progress		IProgress -Adapter und HTTPClient -Berichterstattung.
Spectre.Console.Extensions.Table		DataTable- und Datensatzunterstützung.

Spectre.console.extensions.progress

Erweiterungen für AnsiConsole.Progress

IProgress -Adapter

Verwenden Sie Spectre Spinner mit Standard IProgress -Schnittstelle.

Motivation : Anschlussmethoden, die IProgress akzeptieren, so dass die Berichterstattung deklarativ, vertraut und bequem ist.

 private static async Task RunSimpleExampleAsync ( )
{
    await BuildProgress ( ) . StartAsync (
        GenerateProgressTasks ,
        ( reporter ) => RunSpinnerWithIProgress ( reporter , TimeSpan . FromMilliseconds ( 500 ) ) ,
        ( reporter ) => RunSpinnerWithIProgress ( reporter , TimeSpan . FromSeconds ( 1 ) ) ) ;

    // Collection of tasks to execute,
    // every task corresponds to following delegates sequentially.
    static IEnumerable < ProgressTask > GenerateProgressTasks ( ProgressContext ctx )
    {
        yield return ctx . AddTask ( "Task1" ) ;
        yield return ctx . AddTask ( "Task2" ) ;
    }

    static async Task RunSpinnerWithIProgress (
        IProgress < double > reporter ,
        TimeSpan delay )
    {
        var capacity = 100 ;
        var step = 10 ;
        while ( capacity > 0 )
        {
            reporter . Report ( step ) ;
            capacity -= step ;
            await Task . Delay ( delay ) ;
        }
    }
}

Berichterstattung für httpclient

Führen Sie den Fortschritt für ein gegebenes HttpClient und HttpRequestMessage aus. Das Ergebnis wird als System.IO.Stream bereitgestellt.

Motivation : Es ist eine häufige Aufgabe, etwas herunterzuladen und einen Spinner dafür zu haben. Grundsätzlich möchten Sie sich in diesem Fall nicht einmal mit der Berichterstattung kümmern.

 var message = new HttpRequestMessage ( HttpMethod . Get , url ) ;
var http = new HttpClient ( ) ;
var description = "Downloading cats images" ;
await BuildProgress ( ) . StartAsync ( http , message , taskDescription : description , DownloadCallback ) ;

static async Task DownloadCallback ( Stream stream ) => { } ;

await BuildProgress ( )
    . WithHttp ( http , request , description , DownloadCallback1 )
    . WithHttp ( http , request , description , DownloadCallback2 )
    . StartAsync ( ) ; 

Spectre.console.extensions.table

System.Data.DataTable .

 System . Data . DataTable dataTable = DataTableFactory ( ) ;
var table = dataTable . FromDataTable ( ) . Border ( TableBorder . Rounded ) ;
AnsiConsole . Render ( ) ; 

Todo

• Fügen Sie XML-Doc für bestehende öffentliche APIs hinzu.
• Fügen Sie Statiq -Dokumente hinzu
• Unit -Tests hinzufügen.
• Warnungen beheben; Berücksichtigen Sie zu TreatWarningSaSrors

Beispiele

Installieren Sie das Dotnet-Beispiel-Tool, um Spectre.Console in Aktion anzuzeigen.

 > dotnet tool restore

Jetzt können Sie die verfügbaren Beispiele in diesem Repository auflisten:

 > dotnet example

Und um ein Beispiel zu führen:

 > dotnet example iprogress

Weitere Informationen finden Sie unter:

 .
| -- Samples
|   | -- DataSet
|   | -- DataTable
|   | -- Directory.Build.props
|   | -- http-progress
|   | -- iprogress
|   ` -- iprogress-http-client-multiple-calls
... 

Lizenz

Copyright © Alexey Nikiforov.

Vorausgesetzt wie die MIT-Lizenz. Weitere Informationen finden Sie unter Lizenz.md.