patriksvensson / dotnet-example Goto Github PK

Right now, running dotnet example in CI will always use the default build configuration (i.e. Debug). This is not great if you have CI jobs for both Debug and Release, since running examples in the Release job will cause the entire project to be rebuilt for Debug (after just building it for Release), and then run it in an unexpected configuration.

A -c option for specifying configuration could probably be the solution.

My project (https://github.com/migueldeicaza/gui.cs) has an example app called UI Catalog. The main UI Catalog app uses reflection to enumerate and display all of the examples; they all derive from the class Scenario:

The Scenarios are all in the ./Scenarios dir; each as an individual .cs file. The filename (e.g. Generic.cs DOES NOT need to match the name of the Scenario (the real name is metadata on the Sceanario class).

UI Catalog accepts the name of a Scenario on the command line; if provided it will directly launch that Scenario.

I'd like to enable dotnet example <Scenario>.

I do not want to force each Scenario to have a .csproj file or to be in a distinct dir.

I do not want to have to modify the existing Scenarios.

I do not want to have Scenario writers have to modify anything but their .cs file (e.g. adding each Scenario to .examples is no bueno).

I'm happy to contribute to this project to enhance it to support what I'm trying to do.

What would be your suggestion on the best way to do this?

My initial thought was to enhance .examples such that this will work:

# Sample .examples file for UICatalog Scenarios
./UICatalog --list

dotnet example --list would then build UICatalog/UICatalog.csproj and run it with --list. It would capture stdout to capture the resulting list of examples ("Name", "Description" pairs).

dotnet example <Scenario> would build UICatalog/UICatalog.csproj and run it with <Scenario>.

What do you think?

Repro:

$ git clone [email protected]:alexrp/system-terminal.git
$ cd system-terminal
$ dotnet example

Windows output:

$ dotnet example

┌──────────────┬─────────────┐
│ Example      │ Description │
├──────────────┼─────────────┤
│ attributes   │             │
│ cancellation │             │
│ cursor       │             │
│ extensions   │             │
│ hosting      │             │
│ processes    │             │
│ raw          │             │
│ resize       │             │
│ screens      │             │
│ scrolling    │             │
│ signals      │             │
│ width        │             │
└──────────────┴─────────────┘

Type dotnet example --help for help

Linux output:

$ dotnet example

╭──────────────┬─────────────╮
│ Example      │ Description │
├──────────────┼─────────────┤
│ processes    │             │
│ cursor       │             │
│ extensions   │             │
│ screens      │             │
│ scrolling    │             │
│ width        │             │
│ attributes   │             │
│ resize       │             │
│ hosting      │             │
│ cancellation │             │
│ signals      │             │
│ raw          │             │
╰──────────────┴─────────────╯

Type dotnet example --help for help

for F# examples might be useful to have invidividual .fsx scripts as they are more compact than full fsproj, would it be possible to support it? for example

#r "nuget: FSharp.Data"
open FSharp.Data

type SomeJson = JsonProvider<"""{ "Hello" : "json"}""">
let myJsonSample = SomeJson.LoadSample()

In my projects, samples are built as part of the overall solution, so a lot of time is wasted running no-op dotnet build commands for each example in CI. It would be nice to have a --no-build option for scenarios like this.