Merge pull request #508 from bilal-fazlani/doc-snippets

update doc snippets after modernization

Author: drewburlingame

docs/ArgumentValidation/data-annotations-validation.md

@@ -61,7 +61,7 @@ public class Verbosity : IArgumentModel, IValidatableObject
     }
 }
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Validation/Data_Annotations_Validation.cs#L14-L52' title='Snippet source file'>snippet source</a> | <a href='#snippet-data_annotations_validation' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Validation/Data_Annotations_Validation.cs#L13-L51' title='Snippet source file'>snippet source</a> | <a href='#snippet-data_annotations_validation' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 DataAnnotations can be defined on the method parameters and model properties. Notice 

docs/ArgumentValidation/fluent-validation.md

@@ -92,7 +92,7 @@ public class VerbosityValidator : AbstractValidator<Verbosity>
     }
 }
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Validation/Fluent_Validation.cs#L16-L85' title='Snippet source file'>snippet source</a> | <a href='#snippet-fluent_validation' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Validation/Fluent_Validation.cs#L13-L82' title='Snippet source file'>snippet source</a> | <a href='#snippet-fluent_validation' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 <!-- snippet: fluent_validation_create_invalid -->
@@ -127,16 +127,16 @@ public static AppRunner AppRunner =>
         .UseNameCasing(Case.LowerCase)
         .UseFluentValidation(validatorFactory: model =>
         {
-            switch (model)
+            return model switch
             {
-                case Host: return new HostValidator();
-                case Table: return new TableValidator();
-                case Verbosity: return new VerbosityValidator();
-                default: return null;
-            }
+                Host => new HostValidator(),
+                Table => new TableValidator(),
+                Verbosity => new VerbosityValidator(),
+                _ => null
+            };
         });
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Validation/Fluent_Validation.cs#L91-L105' title='Snippet source file'>snippet source</a> | <a href='#snippet-fluent_validation_factory' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Validation/Fluent_Validation.cs#L88-L102' title='Snippet source file'>snippet source</a> | <a href='#snippet-fluent_validation_factory' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 ## vs. DataAnnotations

docs/ArgumentValues/argument-separator.md

@@ -38,7 +38,7 @@ public void EndOfOptions(IConsole console, CommandContext ctx, string? arg1)
     console.WriteLine($"remaining: {string.Join(',', ctx.ParseResult!.RemainingOperands)}");
 }
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Values/Argument_Separator.cs#L21-L34' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_separator_end_of_options' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Values/Argument_Separator.cs#L19-L32' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_separator_end_of_options' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 This command expects a single operand, but if the operand value looks like an option, the parser will throw an exception
@@ -142,7 +142,7 @@ public void PassThru(IConsole console, CommandContext ctx, string? arg1)
     console.WriteLine($"remaining: {string.Join(',', ctx.ParseResult!.RemainingOperands)}");
 }
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Values/Argument_Separator.cs#L36-L50' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_separator_pass_thru' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Values/Argument_Separator.cs#L34-L48' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_separator_pass_thru' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Help will append ` [[--] <arg>...]` to the usage example when `ArgumentSeparatorStrategy.PassThru` is used.

docs/ArgumentValues/piped-arguments.md

@@ -34,7 +34,7 @@ public void List(IConsole console,
     foreach (var user in userSvc.GetUsers())
         console.Out.WriteLine(idsOnly ? user.Id : user);
 }
-
+    
 public void Disable(IConsole console, IEnumerable<string> ids)
 {
     foreach (string id in ids)

docs/Arguments/argument-arity.md

@@ -53,9 +53,9 @@ CommandDotNet will check if the minimum or maximum arity has been exceeded and r
 <a id='snippet-arguments_arity'></a>
 ```cs
 public void DefaultCommand(Model model,
-        bool requiredBool, Uri requiredRefType, 
-        bool? nullableBool, Uri? nullableRefType,
-        bool optionalBool = false, Uri optionalRefType = null)
+    bool requiredBool, Uri requiredRefType, 
+    bool? nullableBool, Uri? nullableRefType,
+    bool optionalBool = false, Uri optionalRefType = null)
 {}
 
 public class Model : IArgumentModel
@@ -66,7 +66,7 @@ public class Model : IArgumentModel
     [Operand] public Uri DefaultRefType { get; set; } = new ("http://apple.com");
 }
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Arguments_Arity.cs#L18-L32' title='Snippet source file'>snippet source</a> | <a href='#snippet-arguments_arity' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Arguments_Arity.cs#L17-L31' title='Snippet source file'>snippet source</a> | <a href='#snippet-arguments_arity' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 <!-- snippet: arguments_arity_help -->
@@ -134,7 +134,7 @@ public void DefaultCommand(
         [Option] bool[]? nullableBool, [Option] Uri[]? nullableRefType,
         [Option] bool[] optionalBool = null, [Option] Uri[] optionalRefType = null)
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Arguments_Arity.cs#L94-L99' title='Snippet source file'>snippet source</a> | <a href='#snippet-arguments_arity_collection' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Arguments_Arity.cs#L93-L98' title='Snippet source file'>snippet source</a> | <a href='#snippet-arguments_arity_collection' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 <!-- snippet: arguments_arity_collection_help -->
@@ -188,7 +188,7 @@ public static IArgumentArity ExactlyOne => new ArgumentArity(1, 1);
 public static IArgumentArity ZeroOrMore => new ArgumentArity(0, Unlimited);
 public static IArgumentArity OneOrMore => new ArgumentArity(1, Unlimited);
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet/ArgumentArity.cs#L37-L43' title='Snippet source file'>snippet source</a> | <a href='#snippet-known-arities' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet/ArgumentArity.cs#L39-L45' title='Snippet source file'>snippet source</a> | <a href='#snippet-known-arities' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 The static method `ArgumentArity.Default(IArgument argument)` will return one of these static values based on the type
@@ -228,7 +228,7 @@ public static bool AllowsNone(this IArgumentArity arity) => arity.Minimum == 0;
 /// </summary>
 public static bool AllowsUnlimited(this IArgumentArity arity) => arity.Maximum == ArgumentArity.Unlimited;
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet/ArgumentArityExtensions.cs#L5-L35' title='Snippet source file'>snippet source</a> | <a href='#snippet-arity-extensions' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet/ArgumentArityExtensions.cs#L8-L38' title='Snippet source file'>snippet source</a> | <a href='#snippet-arity-extensions' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 

docs/Arguments/argument-models.md

@@ -13,7 +13,7 @@ public void Notify(string message, List<string> recipients,
     // send notification
 }
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Argument_Models.cs#L17-L23' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_models_notify_without_model' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Argument_Models.cs#L16-L22' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_models_notify_without_model' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 <!-- snippet: argument_models_notify_without_model_help -->
@@ -71,7 +71,7 @@ public class NotificationArgs : IArgumentModel
     public List<string> Recipients { get; set; } = null!;
 }
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Argument_Models.cs#L28-L45' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_models_notify_with_model' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Argument_Models.cs#L27-L44' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_models_notify_with_model' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 <!-- snippet: argument_models_dry_run_and_verbosity -->
@@ -82,7 +82,7 @@ public class DryRunOptions : IArgumentModel
     [Option("dryrun")]
     public bool IsDryRun { get; set; } = false;
 }
-
+    
 public class VerbosityOptions : IArgumentModel, IValidatableObject
 {
     [Option('v')]
@@ -99,7 +99,7 @@ public class VerbosityOptions : IArgumentModel, IValidatableObject
     }
 }
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Argument_Models.cs#L168-L190' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_models_dry_run_and_verbosity' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Argument_Models.cs#L165-L187' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_models_dry_run_and_verbosity' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 <!-- snippet: argument_models_notify_with_model_help -->
@@ -157,7 +157,7 @@ public class NotificationArgs : IArgumentModel
     public VerbosityOptions VerbosityOptions { get; set; } = null!;
 }
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Argument_Models.cs#L50-L68' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_models_notify_with_model_composed' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Argument_Models.cs#L49-L67' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_models_notify_with_model_composed' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
@@ -189,7 +189,7 @@ public class NotificationArgs : IArgumentModel
     [Operand]
     public List<string> Recipients { get; set; } = null!;
 }
-
+    
 public class DryRunOptions : IArgumentModel
 {
     [Option("dryrun", AssignToExecutableSubcommands = true)]
@@ -205,7 +205,7 @@ public class VerbosityOptions : IArgumentModel
     public bool Quite { get; set; }
 }
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Argument_Models.cs#L73-L112' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_models_notify_with_interceptor' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Argument_Models.cs#L72-L109' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_models_notify_with_interceptor' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 <!-- snippet: argument_models_notify_with_interceptor_help -->
@@ -270,7 +270,7 @@ public class NotifyModel : IArgumentModel
     public VerbosityOptions VerbosityOptions { get; set; }
 }
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Argument_Models.cs#L149-L156' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_models_notify_with_invalid_nested_operands_model' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Argument_Models.cs#L146-L153' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_models_notify_with_invalid_nested_operands_model' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 And the error received because NotificationArgs contains operands
@@ -298,7 +298,7 @@ public class NotifyModel : IArgumentModel
     public VerbosityOptions VerbosityOptions { get; set; }
 }
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Argument_Models.cs#L122-L130' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_models_notify_with_nested_operands_model' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Argument_Models.cs#L119-L127' title='Snippet source file'>snippet source</a> | <a href='#snippet-argument_models_notify_with_nested_operands_model' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 ### Recommendation 

docs/Arguments/argument-types.md

@@ -83,8 +83,7 @@ public class EnumTypeDescriptor :
     IArgumentTypeDescriptor,
     IAllowedValuesTypeDescriptor
 {
-    public bool CanSupport(Type type) => 
-        type.IsEnum;
+    public bool CanSupport(Type type) => type.IsEnum;
 
     public string GetDisplayName(IArgument argument) => 
         argument.TypeInfo.UnderlyingType.Name;
@@ -96,7 +95,7 @@ public class EnumTypeDescriptor :
         Enum.GetNames(argument.TypeInfo.UnderlyingType);
 }
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet/TypeDescriptors/EnumTypeDescriptor.cs#L6-L23' title='Snippet source file'>snippet source</a> | <a href='#snippet-type_descriptors_enum' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet/TypeDescriptors/EnumTypeDescriptor.cs#L8-L24' title='Snippet source file'>snippet source</a> | <a href='#snippet-type_descriptors_enum' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Use [DelegatedTypeDescriptor](https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet/TypeDescriptors/DelegatedTypeDescriptor.cs) just to override the display text or factory method for the type.
@@ -106,7 +105,7 @@ Use [DelegatedTypeDescriptor](https://github.com/bilal-fazlani/commanddotnet/blo
 ```cs
 new DelegatedTypeDescriptor<string>(Resources.A.Type_Text, v => v),
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet/TypeDescriptors/ArgumentTypeDescriptors.cs#L21-L23' title='Snippet source file'>snippet source</a> | <a href='#snippet-type_descriptors_string' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet/TypeDescriptors/ArgumentTypeDescriptors.cs#L23-L25' title='Snippet source file'>snippet source</a> | <a href='#snippet-type_descriptors_string' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 See [StringCtorTypeDescriptor](https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet/TypeDescriptors/StringCtorTypeDescriptor.cs) and [ComponentModelTypeDescriptor](https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet/TypeDescriptors/ComponentModelTypeDescriptor.cs) for examples to create your own.
@@ -116,24 +115,19 @@ See [StringCtorTypeDescriptor](https://github.com/bilal-fazlani/commanddotnet/bl
 ```cs
 public class ComponentModelTypeDescriptor : IArgumentTypeDescriptor
 {
-    public bool CanSupport(Type type)
-    {
-        var typeConverter = TypeDescriptor.GetConverter(type);
-        return typeConverter.CanConvertFrom(typeof(string));
-    }
+    public bool CanSupport(Type type) => 
+        TypeDescriptor.GetConverter(type).CanConvertFrom(typeof(string));
 
-    public string GetDisplayName(IArgument argument)
-    {
-        return argument.TypeInfo.UnderlyingType.Name;
-    }
+    public string GetDisplayName(IArgument argument) => 
+        argument.TypeInfo.UnderlyingType.Name;
 
-    public object? ParseString(IArgument argument, string value)
+    public object ParseString(IArgument argument, string value)
     {
         var typeConverter = argument.Arity.AllowsMany()
             ? TypeDescriptor.GetConverter(argument.TypeInfo.UnderlyingType)
             : TypeDescriptor.GetConverter(argument.TypeInfo.Type);
         return typeConverter.ConvertFrom(value)!;
     }
 ```
-<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet/TypeDescriptors/ComponentModelTypeDescriptor.cs#L6-L27' title='Snippet source file'>snippet source</a> | <a href='#snippet-type_descriptors_type_convertor' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet/TypeDescriptors/ComponentModelTypeDescriptor.cs#L8-L24' title='Snippet source file'>snippet source</a> | <a href='#snippet-type_descriptors_type_convertor' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->

docs/Arguments/arguments.md

@@ -61,12 +61,12 @@ The OptionAttribute has the following properties:
 <a id='snippet-arguments_attributes'></a>
 ```cs
 public void LaunchRocket(
-    [Operand("planet", Description = "Name of the planet you wish the rocket to go")]
-    string planetName,
-    [Option('t', "turbo", Description = "Do you want to go fast?")]
-    bool turbo,
-    [Option('a', Description = "Abort the launch before takeoff", BooleanMode = BooleanMode.Explicit)]
-    bool abort)
+        [Operand("planet", Description = "Name of the planet you wish the rocket to go")]
+        string planetName,
+        [Option('t', "turbo", Description = "Do you want to go fast?")]
+        bool turbo,
+        [Option('a', Description = "Abort the launch before takeoff", BooleanMode = BooleanMode.Explicit)]
+        bool abort)
 ```
 <sup><a href='https://github.com/bilal-fazlani/commanddotnet/blob/master/CommandDotNet.DocExamples/Arguments/Arguments/Arguments_Attributes.cs#L13-L21' title='Snippet source file'>snippet source</a> | <a href='#snippet-arguments_attributes' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->