Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/galassie/fs-spectre
👻💻 Spectre.Console with F# style.
https://github.com/galassie/fs-spectre
cli console-application dotnet fsharp fsharp-console
Last synced: about 22 hours ago
JSON representation
👻💻 Spectre.Console with F# style.
- Host: GitHub
- URL: https://github.com/galassie/fs-spectre
- Owner: galassie
- License: mit
- Created: 2023-01-26T10:26:53.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-04T20:09:01.000Z (2 months ago)
- Last Synced: 2024-11-08T00:56:07.782Z (8 days ago)
- Topics: cli, console-application, dotnet, fsharp, fsharp-console
- Language: F#
- Homepage:
- Size: 202 KB
- Stars: 76
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FsSpectre
[](https://ci.appveyor.com/project/galassie/fs-spectre)
[Spectre.Console](https://spectreconsole.net/) with F# style.
FsSpectre is a small library that extends Spectre.Console and allow to write beautiful console applications in a declarative and more F#-friendly way.
It leverages [Computation Expressions](https://learn.microsoft.com/en-us/dotnet/fsharp/language-reference/computation-expressions) to create the widgets in a declarative style.
## Add package
If you want to add this package to your project, execute the following command:
``` shell
dotnet add package FsSpectre
```
## Build on your machine
If you want to build this library on your machine, execute the following commands:
``` shell
git clone [email protected]:galassie/fs-spectre.git
cd fs-spectre
dotnet build
```
## Examples
### Table
With C# + Spectre.Console:
```csharp
var table = new Table();
table.AddColumn("Foo");
table.AddColumn(new TableColumn("Bar").Centered());
table.AddRow("Baz", "[green]Qux[/]");
table.AddRow(new Markup("[blue]Corgi[/]"), new Panel("Waldo"));
AnsiConsole.Write(table);
```
With F# + FsSpectre:
```fsharp
table {
column_text ""
column (tableColumn { header_text "Feature"; centerd })
row_text [| "Baz"; "[green]Qux[/]" |]
row [| markup { text "[blue]Corgi[/]" }; panel { content_text "Waldo" } |]
} |> AnsiConsole.Write
```
### Bar Chart
With C# + Spectre.Console:
```csharp
AnsiConsole.Write(new BarChart()
.Width(60)
.Label("[green bold underline]Number of fruits[/]")
.CenterLabel()
.AddItem("Apple", 12, Color.Yellow)
.AddItem("Orange", 54, Color.Green)
.AddItem("Banana", 33, Color.Red));
```
With F# + FsSpectre:
```fsharp
barChart {
width 60
label "[green bold underline]Number of fruits[/]"
centered_label
item ("Apple", 12, Color.Yellow)
item ("Oranges", 54, Color.Green)
item ("Bananas", 33, Color.Red)
} |> AnsiConsole.Write
```
### Live Display
With C# + Spectre.Console:
```csharp
var table = new Table().Centered();
AnsiConsole.Live(table)
.Start(ctx =>
{
table.AddColumn("Foo");
ctx.Refresh();
Thread.Sleep(1000);
table.AddColumn("Bar");
ctx.Refresh();
Thread.Sleep(1000);
});
```
With F# + FsSpectre:
```fsharp
let liveDisplayTable = table { centered }
liveDisplay {
target liveDisplayTable
start (fun ctx ->
liveDisplayTable.AddColumn("Foo") |> ignore
ctx.Refresh()
Thread.Sleep(1000)
liveDisplayTable.AddColumn("Bar") |> ignore
ctx.Refresh()
Thread.Sleep(1000))
}
```
and for the Async version:
```fsharp
let liveDisplayAsyncTable = table { title_text "Async Table" }
liveDisplayAsync {
target liveDisplayAsyncTable
start (fun ctx -> task {
liveDisplayAsyncTable.AddColumn("Foo") |> ignore
ctx.Refresh()
do! Task.Delay(1000)
liveDisplayAsyncTable.AddColumn("Bar") |> ignore
ctx.Refresh()
do! Task.Delay(1000)
})
}
```
### Progress
With C# + Spectre.Console:
```csharp
AnsiConsole.Progress()
.Start(ctx =>
{
var task1 = ctx.AddTask("[green]Reticulating splines[/]");
var task2 = ctx.AddTask("[green]Folding space[/]");
while(!ctx.IsFinished)
{
Thread.Sleep(250);
task1.Increment(1.5);
task2.Increment(0.5);
}
});
```
With F# + FsSpectre:
```fsharp
progress {
start (fun ctx ->
let task1 = ctx.AddTask("[green]Reticulating splines[/]")
let task2 = ctx.AddTask("[green]Folding space[/]")
while not ctx.IsFinished do
Thread.Sleep(250)
task1.Increment(1.5)
task2.Increment(0.5))
}
```
and for the Async version:
```fsharp
progressAsync {
start (fun ctx -> task{
let task1 = ctx.AddTask("[green]Reticulating splines[/]")
let task2 = ctx.AddTask("[green]Folding space[/]")
while not ctx.IsFinished do
do! Task.Delay(250)
task1.Increment(1.5)
task2.Increment(0.5)
})
}
```
### Status
With C# + Spectre.Console:
```csharp
AnsiConsole.Status()
.Spinner(Spinner.Known.Arrow)
.SpinnerStyle(Style.Parse("blue"))
.Start("Thinking...", ctx =>
{
AnsiConsole.MarkupLine("Doing some work...");
Thread.Sleep(1000);
ctx.Status("Thinking some more");
ctx.Spinner(Spinner.Known.Star);
ctx.SpinnerStyle(Style.Parse("green"));
AnsiConsole.MarkupLine("Doing some more work...");
Thread.Sleep(2000);
});
```
With F# + FsSpectre:
```fsharp
status {
spinner Spinner.Known.Arrow
spinner_style (Style.Parse("blue"))
status "Thinking..."
start (fun ctx ->
AnsiConsole.MarkupLine("Doing some work...")
Thread.Sleep(1000)
ctx.Status <- "Thinking some more"
ctx.Spinner <- Spinner.Known.Star
ctx.SpinnerStyle <- Style.Parse("green")
AnsiConsole.MarkupLine("Doing some more work...")
Thread.Sleep(2000))
}
```
and for the Async version:
```fsharp
statusAsync {
spinner Spinner.Known.Arrow
spinner_style (Style.Parse("blue"))
status "Thinking..."
start (fun ctx -> task {
AnsiConsole.MarkupLine("Doing some work...")
do! Task.Delay(1000)
ctx.Status <- "Thinking some more"
ctx.Spinner <- Spinner.Known.Star
ctx.SpinnerStyle <- Style.Parse("green")
AnsiConsole.MarkupLine("Doing some more work...")
do! Task.Delay(2000)
})
}
```
## Showcase
To see an example, execute the `Showcase.fsx` with the following command (you need to build the library first):
``` shell
dotnet fsi Showcase.fsx
```
## Alternatives
If you don't like this style of using Spectre.Console with Computation Expressions, check out these amazing projects:
- [SpectreCoff](https://github.com/EluciusFTW/SpectreCoff)
## Contributing
Code contributions are more than welcome! 😻
Please commit any pull requests against the `main` branch.
If you find any issue, please [report it](https://github.com/galassie/fs-spectre/issues)!
## License
This project is licensed under [The MIT License (MIT)](https://raw.githubusercontent.com/galassie/fs-spectre/master/LICENSE.md).
Author: [Enrico Galassi](https://twitter.com/enricogalassi88)