AutoSpectre by Jeppe Roi Kristensen
Nuget / site data
Details
Info
Name: AutoSpectre
A quick and dirty tool to generate a form through with a source generator that can collect data
Author: Jeppe Roi Kristensen
NuGet: https://www.nuget.org/packages/AutoSpectre.SourceGeneration
https://www.nuget.org/packages/AutoSpectre
You can find more details at https://github.com/jeppevammenkristensen/auto-spectre
Source : https://github.com/jeppevammenkristensen/auto-spectre
Original Readme
Auto Spectre
Source generator project to generate classes that can be used in a console to prompt for values using Spectre.Console
Short Guide
Decorate a class with the AutoSpectreForm attribute and then decorate the properties (must be settable) with a TextPrompt or SelectPrompt attribute.
NOTE The AskAttribute has been marked as obsolete and split into TextPromptAttribute and SelectPromptAttribute to avoid having a lot of properties only relevant for one or another type of prompt.
Example input
[AutoSpectreForm(Culture = "da-DK")]
public class Example
{
[TextPrompt(Title = "Add item")] public int[] IntItems { get; set; } = Array.Empty<int>();
[TextPrompt(Title = "Enter first name", DefaultValueStyle = "bold",
DefaultValueSource = nameof(FirstNameDefaultValue))]
public string? FirstName { get; set; }
public readonly string? FirstNameDefaultValue = "John Doe";
[TextPrompt(PromptStyle = "green bold")]
public bool LeftHanded { get; set; }
[TextPrompt(Title = "Choose your [red]value[/]")]
public SomeEnum Other { get; set; }
[TextPrompt(Secret = true, Mask = '*')]
public string? Password { get; set; }
[TextPrompt(ChoicesSource = nameof(NameChoices), ChoicesStyle = "red on yellow",
ChoicesInvalidText = "Must be one of the names")]
public string Name { get; set; } = null!;
public static readonly string[] NameChoices = new[] {"Kurt", "Krist", "David", "Pat"};
[TextPrompt] public OtherAutoSpectreFormClass ChildForm { get; set; } = new();
[TextPrompt]
public IReadOnlyList<OtherAutoSpectreFormClass> Investors { get; set; } = new List<OtherAutoSpectreFormClass>();
[TaskStep(UseStatus = true, StatusText = "This will take a while", SpinnerType = SpinnerKnownTypes.Christmas,
SpinnerStyle = "green on yellow")]
public void DoSomething(IAnsiConsole console)
{
console.Write(new FigletText("A figlet text is needed"));
}
[SelectPrompt(WrapAround = true, PageSize = 3,
MoreChoicesText = "Press down to see more choices", HighlightStyle = "purple")]
//[SelectPrompt(Source = nameof(ItemSource))]
public string Item { get; set; } = string.Empty;
public List<string> ItemSource { get; } = new() {"Alpha", "Bravo", "Charlie"};
[SelectPrompt(InstructionsText = "Check the special items you want to select")]
//[SelectPrompt(Converter = nameof(SpecialProjectionConverter))]
public List<int> SpecialProjection { get; set; } = new();
public string SpecialProjectionConverter(int source) => $"Number {source}";
public List<int> SpecialProjectionSource { get; set; } = new() {1, 2, 3, 4};
[TextPrompt]
// [TextPrompt(Validator = nameof(EnterYearValidator))]
public int EnterYear { get; set; }
public string? EnterYearValidator(int year)
{
return year <= DateTime.Now.Year ? null : "Year cannot be larger than current year";
}
[TextPrompt] public HashSet<string> Names { get; set; } = new(StringComparer.OrdinalIgnoreCase);
public string? NamesValidator(List<string> items, string newItem)
{
if (newItem == "Foobar")
return "Cannot be Foobar";
if (items.Contains(newItem))
return $"{newItem} has already been added";
return null;
}
[TextPrompt] public bool AddExistingName { get; set; }
[TextPrompt(Condition = nameof(AddExistingName))]
public string? ExistingName { get; set; }
[TextPrompt(Condition = nameof(AddExistingName), NegateCondition = true)]
public string? NewName { get; set; }
}
Behind the scenes this will generate an interface factory and implentation using Spectre.Console to prompt for the values.
Example output
/// <summary>
/// Helps create and fill <see cref = "Example"/> with values
/// </summary>
public interface IExampleSpectreFactory
{
Example Get(Example destination = null);
}
/// <summary>
/// Helps create and fill <see cref = "Example"/> with values
/// </summary>
public class ExampleSpectreFactory : IExampleSpectreFactory
{
public Example Get(Example destination = null)
{
IOtherAutoSpectreFormClassSpectreFactory OtherAutoSpectreFormClassSpectreFactory = new OtherAutoSpectreFormClassSpectreFactory();
destination ??= new Autospectre.Examples.Examples.GithubSample.Example();
var culture = new CultureInfo("da-DK");
// Prompt for values for destination.IntItems
{
List<int> items = new List<int>();
bool continuePrompting = true;
do
{
var item = AnsiConsole.Prompt(new TextPrompt<int>("Add item").WithCulture(culture));
items.Add(item);
continuePrompting = AnsiConsole.Confirm("Add more items?");
}
while (continuePrompting);
int[] result = items.ToArray();
destination.IntItems = result;
}
destination.FirstName = AnsiConsole.Prompt(new TextPrompt<string?>("Enter first name").AllowEmpty().WithCulture(culture).DefaultValue(destination.FirstNameDefaultValue).DefaultValueStyle("bold"));
destination.LeftHanded = AnsiConsole.Confirm("Enter [green]LeftHanded[/]");
destination.Other = AnsiConsole.Prompt(new SelectionPrompt<SomeEnum>().Title("Choose your [red]value[/]").PageSize(10).AddChoices(Enum.GetValues<SomeEnum>()));
destination.Password = AnsiConsole.Prompt(new TextPrompt<string?>("Enter [green]Password[/]").AllowEmpty().WithCulture(culture).Secret('*'));
destination.Name = AnsiConsole.Prompt(new TextPrompt<string>("Enter [green]Name[/]").WithCulture(culture).AddChoices(Example.NameChoices()).ChoicesStyle("red on yellow").InvalidChoiceMessage("Must be one of the names"));
{
AnsiConsole.MarkupLine("Enter [green]ChildForm[/]");
var item = new Autospectre.Examples.Examples.GithubSample.OtherAutoSpectreFormClass();
OtherAutoSpectreFormClassSpectreFactory.Get(item);
destination.ChildForm = item;
}
// Prompt for values for destination.Investors
{
List<OtherAutoSpectreFormClass> items = new List<OtherAutoSpectreFormClass>();
bool continuePrompting = true;
do
{
{
AnsiConsole.MarkupLine("Enter [green]Investors[/]");
var newItem = new Autospectre.Examples.Examples.GithubSample.OtherAutoSpectreFormClass();
OtherAutoSpectreFormClassSpectreFactory.Get(newItem);
items.Add(newItem);
}
continuePrompting = AnsiConsole.Confirm("Add more items?");
}
while (continuePrompting);
System.Collections.Generic.IReadOnlyList<Autospectre.Examples.Examples.GithubSample.OtherAutoSpectreFormClass> result = items;
destination.Investors = result;
}
AnsiConsole.Status().SpinnerStyle("green on yellow").Spinner(Spinner.Known.Christmas).Start("This will take a while", ctx =>
{
destination.DoSomething(AnsiConsole.Console);
});
destination.Item = AnsiConsole.Prompt(new SelectionPrompt<string>().Title("Enter [green]Item[/]").PageSize(3).WrapAround(true).MoreChoicesText("Press down to see more choices").HighlightStyle("purple").AddChoices(destination.ItemSource.ToArray()));
destination.SpecialProjection = AnsiConsole.Prompt(new MultiSelectionPrompt<int>().Title("Enter [green]SpecialProjection[/]").UseConverter(destination.SpecialProjectionConverter).PageSize(10).InstructionsText("Check the special items you want to select").AddChoices(destination.SpecialProjectionSource.ToArray()));
destination.EnterYear = AnsiConsole.Prompt(new TextPrompt<int>("Enter [green]EnterYear[/]").WithCulture(culture).Validate(ctx =>
{
var result = destination.EnterYearValidator(ctx);
return result == null ? ValidationResult.Success() : ValidationResult.Error(result);
}));
// Prompt for values for destination.Names
{
List<string> items = new List<string>();
bool continuePrompting = true;
do
{
bool valid = false;
while (!valid)
{
var item = AnsiConsole.Prompt(new TextPrompt<string>("Enter [green]Names[/]").WithCulture(culture));
var validationResult = destination.NamesValidator(items, item);
if (validationResult is { } error)
{
AnsiConsole.MarkupLine($"[red]{error}[/]");
valid = false;
}
else
{
valid = true;
items.Add(item);
}
}
continuePrompting = AnsiConsole.Confirm("Add more items?");
}
while (continuePrompting);
System.Collections.Generic.HashSet<string> result = new System.Collections.Generic.HashSet<string>(items);
destination.Names = result;
}
destination.AddExistingName = AnsiConsole.Confirm("Enter [green]AddExistingName[/]");
if (destination.AddExistingName == true)
{
destination.ExistingName = AnsiConsole.Prompt(new TextPrompt<string?>("Enter [green]ExistingName[/]").AllowEmpty().WithCulture(culture));
}
if (destination.AddExistingName == false)
{
destination.NewName = AnsiConsole.Prompt(new TextPrompt<string?>("Enter [green]NewName[/]").AllowEmpty().WithCulture(culture));
}
return destination;
}
}
How to call
IExampleSpectreFactory formFactory = new ExampleSpectreFactory();
// The form object is initialized in the Get method
var form = formFactory.Get();
// We pass a pre initialized form object to the get method
var preinitializedForm = new Example();
preinitializedForm = formFactory.Get(preinitializedForm);
// An alternative can be to use the generated extension method
// this will initalize the factory and call the get Method
var form = new Example().SpectrePrompt();
// If you want to dump the values to the console you can use the Dump extension method
form.SpectreDump();
The form attribute
The class that you wan't populated, should be decorated with the AutoSpectreForm attribute. If it has at least one valid property or method decorated with an attribute the SpectreFactory is generated.
Culture
You can control the overall culture used by setting the culture property. This will be used for TextPrompts. If it's isn't set the CurrentUICulture will be used.
DisableDump
If you do want to generate the SpectreDump method, you can disable it using the DisableDump property.
Inheritance
This class can inherit from other classes that has the properties or methods decorated with attributes. It is not required that the baseclass has the AutoSpectreForm. The steps on the base class will be generated last
public class BaseClass
{
[TextPrompt]
public string BaseProperty { get;set;}
}
[AutoSpectreForm]
public class DerivedClass : BaseClass
{
[TextPrompt]
public string DerivedProperty { get;set;}
}
Constructor
Since version 0.5.0 the class is allowed to not have an empty constructor. But in that case the Get/GetAsync method will change to be for a passed in instance. Requirering you to new up the class before calling the Get method.
If you have multiple constructors, you can decorate the constructor intended for initalization by using the UsedConstructorattribute
public void Get(Example destination)
Compared to below where destination can be preinitialized or null (in which case the result will be newed up in the call)
public Example Get(Example destination = null)
The property attributes
These properties are applied to properties. The properties must be settable and public. The two attributes share the following Properties
- Title (can be used to overrule the default title)
- Condition (points to a property or method that returns bool to determine if the given property should be prompted for)
- NegateCondition negates the condition.
A short note on sources
Some of the properties of the attributes are source properties. It can vary if they can point to fields, properties or methods. But a general rule is that the sources must be public and available on the AutoSpectreForm decorated class.
TextPromptAttribute
This will in the end present some kind of input prompt to the user, that tries to prompt the use for the value of a given type. Per default it will try to convert a string to the given value. However if the type is bool it will produce a ConfirmationPrompt (y/n). If the type is an enum it will generate a selection prompt (but unlike using the SelectPrompt, you do not have to provide a source).
If the type is another class that has been decorated with the AutoSpectreForm attribute it will use that forms SpectreFactory to prompt for the values.
Default value
Note that the logic behind default value has changed. Earlier the default value was determined by the value set to a property like below:
public string FirstName { get; set; } = "John Doe";
The new approach from version 0.7.0 is that it can be set by using the DefaultValueSource. The source can be a method, property or field. And can be instance or static and must be public
The style can be controlled by setting the DefaultValueStyle
Default value is only currently used for single items (not enumerables)
IEnumerable types
In the case of a TextPromptAttribute and an IEnumerable of T value. The rules above will be applied to a single type, and after collecting input the user will be prompted if the want's to continue.
Other functionality
The textprompt allows you to
- add validation, see more below
- add a password prompt by using the
Secretand/orMaskproperty - control styles with the
DefaultValueStylefor the DefaultValue andPromptStylefor the prompt itself. See styles. - support Choices (autocomplete) with the
SelectPromptAttribute
The select prompt will adjust based on whether or not the property type is single or enumerable. If it's single select prompt will be used and other a multiselect prompt.
It's required that you define a source. Either by pointing the Source property to the name of the property or method that returns the sources to use or by convention (see source convention)
Here you can use the converter to control how the values are presented to the user.
Other interesting attribute properties are:
- PageSize (defaults to 10)
- WrapAround. If set to true we can cycle through the elements. If you reach the end you will go to the first element and vice versa
- MoreChoicesText. If set this will be displayed when you reach the end of the page size
- InstructionsText (only for multiselect). This is custom text to guide them to select mulitiple items
- HighlightStyle
The method attribute
If you wan't to do something that doesn't fit prompting. Between some of the steps you can use the TaskStepAttribute to do that.
The filosophy for this method is that you can do 'custom' things.
- You can choose display whatever you may want to the user (for instance figlet text)
- You can do a lookup to a database or an api.
- You can do some processing of the data you currently collected
- If the current supplied property step attributes does not fit your needs you do some custom prompting to set a property values. NOTE If you use the Status bar, prompting is not allowed, so it would be important that UseStatus is set to false in that case.
Requirements for the method
It can return either void or Task. If the return type is Task this will affect how the SpectreFactory is generated. As the Get call will be async instead and be named GetAsync.
It allows you to have IAnsiConsole as a parameter, and that will be injected into the method when it's called. This should make it easier to do testing if that is desired.
Title
Unlike the property based step attributes we will not generate a default title if the Title is not set. If you input an IAnsiConsole it might be overkill to also add a Title. But there is nothing hindering you from doing so.
Status bar
You can control whether or not you want a status bar(spinner) to run when the method is called. This is done by setting the UseStatus property to true and adding text to the StatusText property. Both are required. The choice was that it was more intuitive that the status will be displayed by having two properties instead of StatusText being optional. You can control the spinner type and style by using the SpinnerType and SpinnerStyle properties.
The spinner type is set by using the SpinnerKnownTypes this has been generated from the KnownTypes. Custom spinner types are not possible. Alternatively you can generate the status inside the method, and thereby allowing you all the flexibility you want.
Collections strategy
When requesting input for a collection we will often work with a List of T and converted it to the type of the property. Most cases should be covered. But here is a short list of some of the "conversions" behind the scenes.
- Array will result in a ToList()
- HashSet will be initalized with new HashSet of T
- Immutable collection types will append ToImmutable{Type}()
- Interfaces like
IList of TICollection of TIEnumerable of TIReadOnlyCollection of TIReadOnlyList of Thave their values directly set asList of Tinherit directly from them
Example
Code
[AutoSpectreForm]
public class CollectionSample
{
[SelectPrompt(Source = nameof(Items), Title = "Select multiple items")]
public IReadOnlyList<string> Multiselect { get; set; }
[SelectPrompt(Source = nameof(Items))]
public string[] ArrayMultiSelect { get; set; } = Array.Empty<string>();
[SelectPrompt(Source = nameof(Items))]
public ImmutableArray<string> ArrayMultiSelectMultiple { get; set; }
[SelectPrompt(Source = nameof(Numbers))]
public List<int> ListNumbers { get; set; } = new List<int>();
public int[] Numbers { get; } = new[] {1, 2, 3};
public List<string> Items { get; } = new List<string>() { "Alpha", "Bravo", "Charlie" };
}
Generated
public interface ICollectionSampleSpectreFactory
{
CollectionSample Get(CollectionSample destination = null);
}
public class CollectionSampleSpectreFactory : ICollectionSampleSpectreFactory
{
public CollectionSample Get(CollectionSample destination = null)
{
destination ??= new Test.CollectionSample();
destination.Multiselect = AnsiConsole.Prompt(new MultiSelectionPrompt<string>().Title("Select multiple items").PageSize(10).AddChoices(destination.Items.ToArray()));
destination.ArrayMultiSelect = AnsiConsole.Prompt(new MultiSelectionPrompt<string>().Title("Enter [green]ArrayMultiSelect[/]").PageSize(10).AddChoices(destination.Items.ToArray())).ToArray();
destination.ArrayMultiSelectMultiple = AnsiConsole.Prompt(new MultiSelectionPrompt<string>().Title("Enter [green]ArrayMultiSelectMultiple[/]").PageSize(10).AddChoices(destination.Items.ToArray())).ToImmutableArray();
destination.ListNumbers = AnsiConsole.Prompt(new MultiSelectionPrompt<int>().Title("Enter [green]ListNumbers[/]").PageSize(10).AddChoices(destination.Numbers.ToArray()));
return destination;
}
}
Converter
You can add a converter method that will transform a given class to a string. This can be used when the attribute is SelectPrompt to give a string representation of a class. Currently the converter must be a method on the class with the [AutoSpectreForm] attribute on and it must be at least public or internal. The method should take the given type as input parameter and return a string.
Example
Code
public record Person(string FirstName, string LastName);
[AutoSpectreForm]
public class ConverterForms
{
[SelectPrompt(Title = "Select person", Source = nameof(GetPersons), Converter = nameof(PersonToString))]
public Person? Person { get; set; }
[SelectPrompt(Title = "Select persons", Source = nameof(GetPersons), Converter = nameof(PersonToString))]
public List<Person> Persons { get; set; } = new List<Person>();
public string PersonToString(Person person) => $"{person.FirstName} {person.LastName}";
public IEnumerable<Person> GetPersons()
{
yield return new Person("John", "Doe");
yield return new Person("Jane", "Doe");
yield return new Person("John", "Smith");
yield return new Person("Jane", "Smith");
}
}
Generated
public class ConverterFormsSpectreFactory : IConverterFormsSpectreFactory
{
public ConverterForms Get(ConverterForms destination = null)
{
destination ??= new ConsoleApp1.ConverterForms();
destination.Person = AnsiConsole.Prompt(new SelectionPrompt<ConsoleApp1.Person?>().Title("Select person").UseConverter(destination.PersonToString).PageSize(10).AddChoices(destination.GetPersons().ToArray()));
destination.Persons = AnsiConsole.Prompt(new MultiSelectionPrompt<ConsoleApp1.Person>().Title("Select persons").UseConverter(destination.PersonToString).PageSize(10).AddChoices(destination.GetPersons().ToArray()));
return destination;
}
}
Validation
You can define validation by using the Validator property on the TextPromptAttribute or by following the {PropertyName}Validator convention.
The method being pointed to should return a nullable string. If validation is succesfull null should be returned, otherwise the validation error text message should be returned.
Based on the return type there are two types of parameters needed
- Single property. It's expected that the method has one parameter that is the same as the property
- Enumerable property. It's expected that the first parameter is an IEnumerable of the property type and the second parameter is the type
The method pointed to must be public, but can be instance and static.
Example
[TextPrompt(Validator = nameof(ValidateAge))]
public int Age { get; set; }
[TextPrompt()]
public int[] Ages { get; set; } = Array.Empty<int>();
public string? AgesValidator(List<int> items, int item)
{
if (ValidateAge(item) is { } error)
return error;
if (items?.Contains(item) == true)
{
return $"{item} allready added";
}
return null;
}
public string? ValidateAge(int age)
{
return age >= 18 ? null : "Age must be at least 18";
}
Generated
destination.Age = AnsiConsole.Prompt(new TextPrompt<int>("Enter [green]Age[/]").Validate(
ctx =>
{
var result = destination.ValidateAge(ctx);
return result == null ? ValidationResult.Success() : ValidationResult.Error(result);
}));
// Prompt for values for destination.Ages
{
List<int> items = new List<int>();
bool continuePrompting = true;
do
{
bool valid = false;
while (!valid)
{
var item = AnsiConsole.Prompt(new TextPrompt<int>("Enter [green]Ages[/]"));
var validationResult = destination.AgesValidator(items, item);
if (validationResult is { } error)
{
AnsiConsole.MarkupLine($"[red]{error}[/]");
valid = false;
}
else
{
valid = true;
items.Add(item);
}
}
continuePrompting = AnsiConsole.Confirm("Add more items?");
}
while (continuePrompting);
int[] result = items.ToArray();
destination.Ages = result;
}
Choices
You can define choices for a property by using the ChoicesSource property or by following the {PropertyName}Choices convention. The source can be a property, method (no parameters) or field that returns the singular type of the property.
The choices are autocomplete and will be displayed in the prompt. The style of how they are displayed can be controlled through the ChoicesStyle prpoerty. When the user types something that is not in the choices, an invalid text will be displayed (this can be overloaded with ChoicesInvalidText).
Example
[TextPrompt(
ChoicesSource = nameof(NameChoices),
ChoicesStyle = "red on yellow",ChoicesInvalidText = "Must be one of the names")]
public string Name { get; set; } = null!;
public static readonly string[] NameChoices = new[] {"Kurt", "Krist", "David", "Pat"};
Generated
destination.Name = AnsiConsole.Prompt(
new TextPrompt<string>("Enter [green]Name[/]")
.WithCulture(culture)
.AddChoices(Example.NameChoices)
.ChoicesStyle("red on yellow")
.InvalidChoiceMessage("Must be one of the names"));
Type initialization
If you have a property type that is another form. For instance
[AutoSpectreForm]
public class MainForm
{
[TextPrompt]
public OtherForm ChildForm { get; set; }
}
[AutoSpectreForm]
public class OtherForm
{
public OtherForm(string title)
{
}
...
}
If the constructor of the other type is not empty (no parameters), you will get an error. This can however be amended by using the TypeInitalizer and point it to a method that return the type you want to initalize. The method pointing to should be public or internal and should return the given type and not have any parameters.
...
[TextPrompt(TypeInitializer = nameof(InitializeChildForm))]
public OtherForm ChildForm { get;set; }
public OtherForm InitializeChildForm() => new("Some title");
...
Like in other scenarios this can also be achieved by convention. This is done by naming the method Init{TypeName} and have the correct signature.
## Styles
There are different properties to control the style. We won't go into detail here but we take a string as input and try to evaluate the style. If it can't be parsed an error will be outputted in the build log(since it's a source generator it will often first appear after a build).
Styles can be, in very rough terms, [colors](https://spectreconsole.net/appendix/colors) or [styles](https://spectreconsole.net/appendix/styles) and used in different combinations. Try them out, you will be "told" if it's not allowed by the AutoSpectre SourceGenerator. :)
* Red
* Green slowblink
* Red on white (red foreground on white background)
* italic blue on yellow
## Conditions
Using the `Condition` you can instruct whether prompting should occur for a given property. The condition should point to either a public bool property or a public method with no parameters returning bool. You can negate this by using the `NegateCondition` property.
### Example
```csharp
[AutoSpectreForm]
public class ConditionSampleForm
{
[TextPrompt]
public bool AskFriendlyCondition { get; set; }
[TextPrompt(Title ="Please sir what is your name?")]
public string AskFriendly { get; set; }
[TextPrompt(Title = "What is your #!^$ name", Condition = nameof(AskFriendlyCondition), NegateCondition = true)]
public string AskHostile { get; set; }
}
Generated
destination.AskFriendlyCondition = AnsiConsole.Confirm("Enter [green]AskFriendlyCondition[/]");
if (destination.AskFriendlyCondition == true)
{
destination.AskFriendly = AnsiConsole.Prompt(new TextPrompt<string>("Please sir what is your name?"));
}
if (destination.AskFriendlyCondition == false)
{
destination.AskHostile = AnsiConsole.Prompt(new TextPrompt<string>("What is your #!^$ name"));
}
Conventions
The following conventions come into play
Source
You can leave out the Source in the SelectPromptAttribute if you have a property or method that is named {NameOfProperty}Source and have the correct structure ( No input parameters and returns an enumerable of the type of the given property)
Example
[SelectPrompt]
public string Name { get; set; }
public IEnumerable<string> NameSource()
{
yield return "John Doe";
yield return "Jane Doe";
yield return "John Smith";
}
Converter
You can also leave out the Converter in the AskAttribute if you have a method with the name {NameOfProperty}Converter and the correct structure (One parameter of the same type as the property and returning a string)
Example
[SelectPrompt(AskType = AskType.Selection)]
public FullName Name { get; set; }
public string NameConverter(FullName name) => $"{name.FirstName} {name.LastName}";
Validation
It's possible to leave out the Validator in the TextPromptAttribute if you have a method with the name {NameOfProperty}Validator and the correct structure (see the part about Validation)
Example
[TextPrompt]
public int Age {get;set;}
public string? AgeValidator(int age)
{
return age >= 18 ? null : "Age must be at least 18";
}
Condition
It's possible to leave out the Condition in a prompt attribute if you have a method with no parameters returning bool or a property returning bool that matches {NameOfProperty}Condition. If you want to negate this you will still need to provide the NegateCondition manually.
[TextPrompt]
public string FirstName { get; set; }
public bool FirstNameCondition => true;
[TextPrompt(NegateCondition = true)]
public string NegatePrompt { get; set; }
public bool NegatePromptCondition => false;
About
Generating prompt to input values for a console application.
How to use
Example ( source csproj, source files )
- CSharp Project
- Program.cs
- ReadPerson.cs
This is the CSharp Project that references AutoSpectre
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="AutoSpectre" Version="0.8.1" />
<PackageReference Include="AutoSpectre.SourceGeneration" Version="0.8.1" />
</ItemGroup>
<PropertyGroup>
<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
<CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GX</CompilerGeneratedFilesOutputPath>
</PropertyGroup>
</Project>
This is the use of AutoSpectre in Program.cs
using ReadData;
Console.WriteLine("Hello, World!");
IReadPersonSpectreFactory factory = new ReadPersonSpectreFactory();
var person = factory.Get();
//Console.WriteLine($"Hello, {person.FirstName} {person.LastName}!");
person.SpectreDump();
This is the use of AutoSpectre in ReadPerson.cs
using AutoSpectre;
namespace ReadData;
[AutoSpectreForm()]
public class ReadPerson
{
[TextPrompt(Title = "Enter first name", DefaultValueStyle = "bold",
DefaultValueSource = nameof(FirstNameDefaultValue))]
public string? FirstName { get; set; }
public readonly string? FirstNameDefaultValue = "Andrei";
[TextPrompt(PromptStyle = "green bold")]
public string? LastName { get; set; }
public readonly string? LastNameDefaultValue = "Ignat";
}
Generated Files
Those are taken from $(BaseIntermediateOutputPath)\GX
- ReadData.ReadPersonAutoSpectreFactory.g.cs
using Spectre.Console;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Collections.Immutable;
using System.Globalization;
using AutoSpectre.Extensions;
using Spectre.Console.Rendering;
namespace ReadData
{
/// <summary>
/// Helps create and fill <see cref = "ReadPerson"/> with values
/// </summary>
public interface IReadPersonSpectreFactory
{
ReadPerson Get(ReadPerson destination = null);
}
/// <summary>
/// Helps create and fill <see cref = "ReadPerson"/> with values
/// </summary>
public class ReadPersonSpectreFactory : IReadPersonSpectreFactory
{
public ReadPerson Get(ReadPerson destination = null)
{
destination ??= new ReadData.ReadPerson();
var culture = CultureInfo.CurrentUICulture;
destination.FirstName = AnsiConsole.Prompt(new TextPrompt<string?>("Enter first name").AllowEmpty().WithCulture(culture).DefaultValue(destination.FirstNameDefaultValue).DefaultValueStyle("bold"));
destination.LastName = AnsiConsole.Prompt(new TextPrompt<string?>("Enter [green]LastName[/]").AllowEmpty().WithCulture(culture).DefaultValue(destination.LastNameDefaultValue).PromptStyle("green bold"));
return destination;
}
}
public static class ReadPersonSpectreFactoryExtensions
{
public static ReadPerson SpectrePrompt(this ReadPerson source)
{
ReadPersonSpectreFactory factory = new();
return factory.Get(source);
}
/// <summary>
/// Returns data as a IRenderable
/// Experimental. Might break
/// </summary>
/// <returns></returns>
public static IRenderable GenerateTable(this ReadPerson source)
{
var table = new Table();
table.AddColumn(new TableColumn("Name"));
table.AddColumn(new TableColumn("Value"));
table.AddRow(new Markup("FirstName"), new Markup(source.FirstName?.ToString()));
table.AddRow(new Markup("LastName"), new Markup(source.LastName?.ToString()));
return table;
}
/// <summary>
/// Renders the table
/// Experimental. Might break
/// </summary>
/// <returns></returns>
public static void SpectreDump(this ReadPerson source)
{
AnsiConsole.Write(source.GenerateTable());
}
}
}
Usefull
Download Example (.NET C# )
Share AutoSpectre
https://ignatandrei.github.io/RSCG_Examples/v2/docs/AutoSpectre