3 types derived from Option
System.CommandLine (3)
Help\HelpOption.cs (1)
11public sealed class HelpOption : Option
Option{T}.cs (1)
10public class Option<T> : Option
VersionOption.cs (1)
14public sealed class VersionOption : Option
197 references to Option
aspire (24)
Commands\BaseCommand.cs (1)
265foreach (var option in Options)
Commands\GroupedHelpWriter.cs (3)
305internal static string FormatOptionLabel(Option option, bool includeValueName = false) 320private static bool IsBooleanOption(Option option) 325private static string GetOptionValueName(Option option)
Commands\OptionWithLegacy.cs (1)
52internal static void Add<T>(this IList<Option> options, OptionWithLegacy<T> optionWithLegacy)
Commands\ParseResultHelper.cs (5)
61params Option[] excludedOptions) 202Option[] excludedOptions) 217foreach (var option in excludedOptions) 406private static void CollectOptionNames(IList<Option> options, bool includeOnlyRecursive, Dictionary<string, string> knownOptions) 408foreach (var option in options)
Commands\ResourceCommand.cs (10)
281var options = new Dictionary<ResourceSnapshotCommandArgument, Option>(); 289var option = CreateCommandArgumentOption(argument, parseMode); 328var option = options[argument]; 381private static Option CreateCommandArgumentOption(ResourceSnapshotCommandArgument argument, CommandArgumentParseMode parseMode) 392Option option = (IsBooleanInput(argument), IsNumberInput(argument), parseAsString) switch 781private static IEnumerable<Option> GetVisibleCliOptions(System.CommandLine.Parsing.CommandResult commandResult) 785foreach (var option in commandResult.Command.Options) 796foreach (var option in parentCommandResult.Command.Options) 824private static void AddOptionNames(IEnumerable<Option> options, bool includeOnlyRecursive, HashSet<string> names) 826foreach (var option in options)
Commands\RootCommand.cs (2)
106private static readonly (Option Option, Func<ParseResult, string[]?> GetArgs)[] s_childProcessOptions = 270foreach (var option in Options)
Templating\CliTemplateFactory.cs (1)
294private static void AddOptionIfMissing(System.CommandLine.Command command, System.CommandLine.Option option)
Templating\DotNetTemplateFactory.cs (1)
399private static void AddOptionIfMissing(Command command, Option option)
Aspire.Cli.Tests (2)
Commands\NewCommandTests.cs (1)
97var channelOption = command.Options.Single(option => option.Name == "--channel");
Commands\UpdateCommandTests.cs (1)
57var channelOption = command.Options.Single(option => option.Name == "--channel");
crossgen2 (2)
src\runtime\src\coreclr\tools\Common\CommandLineHelpers.cs (2)
161foreach (Option option in command.Options) 237foreach (Option option in res.CommandResult.Command.Options)
dotnet (13)
CliSchema.cs (3)
138private static Dictionary<string, OptionDetails>? CreateOptionsDictionary(IList<Option> options) 145foreach (var option in options.OrderBy(o => o.Name, StringComparer.OrdinalIgnoreCase)) 186private static OptionDetails CreateOptionDetails(Option option) => new OptionDetails(
Commands\DotNetCommandFactory.cs (1)
57IEnumerable<Option> optionsToUseWhenParsingMSBuildFlags,
Commands\MSBuild\MSBuildForwardingApp.cs (1)
87/// <param name="msBuildArgs">MSBuild arguments to forward to the builder process, parsed by using <see cref="MSBuildArgs.AnalyzeMSBuildArguments"/> to apply a set of per-command <see cref="System.CommandLine.Option`1"/>s to a list of unparsed command line input tokens.</param>
Commands\Test\MTP\MicrosoftTestingPlatformTestCommand.Help.cs (1)
128private (List<CommandLineOptionMessage> BuiltInOptions, List<CommandLineOptionMessage> NonBuiltInOptions) GetAllOptions(IList<Option> commandOptions)
Parser.cs (4)
118Option option = rootCommand.Options[i]; 428HashSet<Option> uniqueOptions = []; 429foreach (Option option in context.Command.Options) 459foreach (var option in command.Options)
ParserOptionActions.cs (3)
25internal abstract class InvocableOptionAction(Option option) : SynchronousCommandLineAction 30public Option Option { get; } = option; 95internal class PrintHelpAction(Option option, HelpBuilder builder) : InvocableOptionAction(option)
dotnet-aot (16)
src\sdk\src\Cli\dotnet\CliSchema.cs (3)
138private static Dictionary<string, OptionDetails>? CreateOptionsDictionary(IList<Option> options) 145foreach (var option in options.OrderBy(o => o.Name, StringComparer.OrdinalIgnoreCase)) 186private static OptionDetails CreateOptionDetails(Option option) => new OptionDetails(
src\sdk\src\Cli\dotnet\Commands\MSBuild\MSBuildForwardingApp.cs (1)
87/// <param name="msBuildArgs">MSBuild arguments to forward to the builder process, parsed by using <see cref="MSBuildArgs.AnalyzeMSBuildArguments"/> to apply a set of per-command <see cref="System.CommandLine.Option`1"/>s to a list of unparsed command line input tokens.</param>
src\sdk\src\Cli\dotnet\Commands\Run\AotRunCommand.cs (1)
388private static Option? GetUnsupportedOption(ParseResult parseResult, RunCommandDefinition definition)
src\sdk\src\Cli\dotnet\Commands\Test\AotTestCommand.cs (1)
65private static Option? GetUnsupportedOption(
src\sdk\src\Cli\dotnet\Commands\Test\MTP\MicrosoftTestingPlatformTestCommand.Help.cs (1)
128private (List<CommandLineOptionMessage> BuiltInOptions, List<CommandLineOptionMessage> NonBuiltInOptions) GetAllOptions(IList<Option> commandOptions)
src\sdk\src\Cli\dotnet\Parser.cs (5)
118Option option = rootCommand.Options[i]; 282private sealed class AotPrintHelpAction(Option option, HelpBuilder builder, params Command[] managedHelpCommands) 428HashSet<Option> uniqueOptions = []; 429foreach (Option option in context.Command.Options) 459foreach (var option in command.Options)
src\sdk\src\Cli\dotnet\ParserOptionActions.cs (3)
25internal abstract class InvocableOptionAction(Option option) : SynchronousCommandLineAction 30public Option Option { get; } = option; 95internal class PrintHelpAction(Option option, HelpBuilder builder) : InvocableOptionAction(option)
src\sdk\src\Cli\Microsoft.TemplateEngine.Cli\SymbolExtensions.cs (1)
11public static void EnsureHelpName(this Option cliOption)
dotnet-watch (2)
CommandLine\CommandLineOptions.cs (1)
83foreach (var buildOption in buildOptions)
CommandLine\DotnetWatchCommandDefinition.cs (1)
125public bool IsWatchOption(Option option)
ilc (2)
src\runtime\src\coreclr\tools\Common\CommandLineHelpers.cs (2)
161foreach (Option option in command.Options) 237foreach (Option option in res.CommandResult.Command.Options)
Microsoft.DotNet.Cli.CommandLine (5)
ForwardedOptionExtensions.cs (2)
19extension(Option option) 214public IEnumerable<string> OptionValuesToBeForwarded(IEnumerable<Option> options)
OptionBuilderExtensions.cs (1)
14extension<T>(T option) where T : Option
ResultNavigationExtensions.cs (2)
76public static bool HasOption(this ParseResult parseResult, Option option) => parseResult.GetResult(option) is OptionResult or && !or.Implicit; 89public static bool HasOption(this SymbolResult symbolResult, Option option) => symbolResult.GetResult(option) is OptionResult or && !or.Implicit;
Microsoft.DotNet.Cli.Definitions (35)
Commands\New\CommandDefinitionExtensions.cs (1)
50public static TDefinition AddOptions<TDefinition>(this TDefinition command, IEnumerable<Option> options)
Commands\New\InstantiateCommandDefinition.cs (1)
30foreach (var option in InstantiateOptions.AllOptions)
Commands\New\InstantiateOptions.cs (1)
17public IEnumerable<Option> AllOptions
Commands\New\LegacyFilterOptions.cs (1)
17public IEnumerable<Option> AllOptions
Commands\New\LegacyOptions.cs (2)
17public IEnumerable<Option> AllOptions 26foreach (var option in FilterOptions.AllOptions)
Commands\Package\PackageListCommandDefinition.cs (13)
19public readonly Option OutdatedOption = new Option<bool>("--outdated") 25public readonly Option DeprecatedOption = new Option<bool>("--deprecated") 31public readonly Option VulnerableOption = new Option<bool>("--vulnerable") 37public readonly Option FrameworkOption = new Option<IEnumerable<string>>("--framework", "-f") 44public readonly Option TransitiveOption = new Option<bool>("--include-transitive") 50public readonly Option PrereleaseOption = new Option<bool>("--include-prerelease") 56public readonly Option HighestPatchOption = new Option<bool>("--highest-patch") 62public readonly Option HighestMinorOption = new Option<bool>("--highest-minor") 68public readonly Option ConfigOption = new Option<string>("--config", "--configfile") 74public readonly Option SourceOption = new Option<IEnumerable<string>>("--source", "-s") 83public readonly Option NoRestore = new Option<bool>("--no-restore") 89public readonly Option VerbosityOption = new Option<Utils.VerbosityOptions>("--verbosity", "-v") 100public readonly Option OutputVersionOption = new Option<int>("--output-version")
Commands\Tool\ToolLocationOptions.cs (1)
19public void AddTo(IList<Option> options)
Common\ImplicitRestoreOptions.cs (1)
105public void AddTo(IList<Option> options)
Common\NuGetRestoreOptions.cs (1)
44public void AddTo(IList<Option> options)
Common\TargetPlatformOptions.cs (3)
15public readonly Option RuntimeOption; 29public TargetPlatformOptions(Option runtimeOption) 41public void AddTo(IList<Option> options)
Help\HelpBuilder.cs (4)
191if (symbol is Option or Command) 207?? (symbol is Option option 247var defaultArguments = arguments.Where(x => !x.Hidden && (x is Argument { HasDefaultValue: true } || x is Option { HasDefaultValue: true })).ToArray(); 267case Option option:
Help\HelpBuilder.Default.cs (6)
27Option option => option.HasDefaultValue ? ToString(option.GetDefaultValue()) : "", 54Option option => GetUsageLabel(option.HelpName, option.ValueType, option.CompletionSources, option, option.Arity) ?? "", 95public static string GetOptionUsageLabel(Option symbol) 163foreach (Option option in ctx.Command.Options) 185foreach (var option in parentCommand.Options) 247if (symbol is Option { Required: true })
Microsoft.DotNet.Cli.Utils (2)
MSBuildArgs.cs (2)
103public static MSBuildArgs AnalyzeMSBuildArguments(IEnumerable<string> forwardedAndUserFacingArgs, params Option[] options) 106foreach (var option in options)
Microsoft.TemplateEngine.Cli (29)
ChoiceTemplateParameter.cs (1)
71protected override Option GetBaseOption(IReadOnlySet<string> aliases)
CliTemplateParameter.cs (6)
137/// Creates <see cref="Option"/> for template parameter. 140internal Option GetOption(IReadOnlySet<string> aliases) 142Option option = GetBaseOption(aliases); 206protected virtual Option GetBaseOption(IReadOnlySet<string> aliases) 209Option cliOption = Type switch 274protected void AddAliases(Option option, IReadOnlySet<string> aliases)
Commands\BaseCommand.cs (1)
135protected static void PrintDeprecationMessage<TDeprecatedCommand, TNewCommand>(ParseResult parseResult, Func<TNewCommand, Option>? additionalNewOptionSelector = null)
Commands\BaseFilterableArgs.cs (1)
50foreach (var option in filterableCommand.FilterOptions)
Commands\CommandLineUtils.cs (5)
69internal static string FormatArgumentUsage(Option option) => FormatArgumentUsage(new[] { option }); 72internal static string FormatArgumentUsage(IReadOnlyList<Option> options) 79var option = options[i]; 119bool IsMultiParented(Option option) => 122bool IsOptional(Option option) =>
Commands\create\InstantiateCommand.cs (1)
25internal IReadOnlyList<Option> PassByOptions =>
Commands\create\InstantiateCommand.Help.cs (2)
289List<Option> optionsToShow = new() 324foreach (Option cliOption in optionsToShow)
Commands\create\TemplateCommand.cs (1)
297foreach (Option option in command.Options)
Commands\create\TemplateOption.cs (2)
10private Option _option; 25internal Option Option => _option;
Commands\Example.cs (2)
96internal Example<T> WithOption(Func<T, Option> optionSelector, params string[] args) 98var option = optionSelector(currentCommand);
Commands\Extensions.cs (3)
15internal static string? GetValueForOptionOrNull(this ParseResult parseResult, Option option) 28internal static bool HasErrorFor(this ParseResult parseResult, Option option, [NotNullWhen(true)] out ParseError? error) 35static bool IsOptionResult(SymbolResult? symbolResult, Option option)
Commands\IFilterableCommand.cs (1)
10IEnumerable<Option> FilterOptions { get; }
Commands\list\BaseListCommand.cs (1)
23public IEnumerable<Option> FilterOptions => _definition.FilterOptions.AllOptions;
Commands\search\BaseSearchCommand.cs (1)
17public IEnumerable<Option> FilterOptions => Definition.FilterOptions.AllOptions;
SymbolExtensions.cs (1)
11public static void EnsureHelpName(this Option cliOption)
SelectTests (2)
Program.cs (2)
84foreach (var option in new Option[]
System.CommandLine (47)
Argument.cs (1)
13/// A symbol defining a value that can be passed on the command line to a <see cref="Command">command</see> or <see cref="Option">option</see>.
Command.cs (7)
29private ChildSymbolList<Option>? _options; 51foreach (var option in Options) 70/// This collection doesn't include options on parent commands where <see cref="Option.Recursive">Option.Recursive</see> is <see langword="true" />. Those options are valid under the current command but don't appear in this collection. 72public IList<Option> Options => _options ??= new (this); 223/// Adds an <see cref="Option"/> to the command. 226public void Add(Option option) => Options.Add(option); 316var option = parentCommand.Options[i];
Help\HelpBuilder.cs (2)
413if (symbol is Option or Command) 429?? (symbol is Option option
Help\HelpBuilder.Default.cs (9)
29Option option => ShouldShowDefaultValue(option) 49Option option => ShouldShowDefaultValue(option), 54public static bool ShouldShowDefaultValue(Option option) => 74Option option => GetUsageLabel(option.HelpName, option.ValueType, option.CompletionSources, option, option.Arity) ?? "", 99if (symbol is Option) 131public static string GetOptionUsageLabel(Option symbol) 161if (symbol is Option { Required: true }) 234foreach (Option option in ctx.Command.Options.OrderBy(o => o is HelpOption or VersionOption)) 257foreach (var option in parentCommand.Options)
Help\HelpBuilderExtensions.cs (1)
14case Option option:
Invocation\ParseErrorAction.cs (2)
121? targetSymbol.Children.Where(x => !x.Hidden && x is Option or Command) 133AliasSet? aliasSet = symbol is Option option ? option._aliases : ((Command)symbol)._aliases;
Option.cs (1)
21/// Initializes a new instance of the <see cref="Option"/> class.
Option{T}.cs (2)
8/// <inheritdoc cref="Option" /> 15/// Initializes a new instance of the <see cref="Option"/> class.
OptionValidation.cs (1)
10/// Provides extension methods for <see cref="Option" />.
ParseResult.cs (1)
199public OptionResult? GetResult(Option option) =>
Parsing\CommandResult.cs (1)
81var option = options[i];
Parsing\OptionResult.cs (2)
15Option option, 28public Option Option { get; }
Parsing\ParseOperation.cs (4)
212Option option = (Option)CurrentToken.Symbol!; 386if (kvp is { Key: Option { Action: { Terminating: false } action }, Value: OptionResult { Implicit: true } } && 450if (symbol is Option { Action: { } optionAction } option)
Parsing\StringExtensions.cs (10)
131if (PreviousTokenIsAnOptionExpectingAnArgument(out var option)) 140tokenList.Add(Option(arg, (Option)token.Symbol!)); 167tokenList.Add(Option(first, (Option)subtoken.Symbol!)); 185Token OptionArgument(string value, Option option) => new(value, TokenType.Argument, option, i); 189Token Option(string value, Option option) => new(value, TokenType.Option, option, i); 233if (i != alias.Length - 1 && ((Option)found.Symbol!).Greedy) 248bool PreviousTokenIsAnOptionExpectingAnArgument(out Option? option) 256if (token.Symbol is Option { Greedy: true } opt) 444Option option = parentCommand.Options[i]; 474static void AddOptionTokens(Dictionary<string, Token> tokens, Option option)
Parsing\SymbolResult.cs (1)
84public OptionResult? GetResult(Option option) => SymbolResultTree.GetResult(option);
Parsing\SymbolResultTree.cs (1)
40internal OptionResult? GetResult(Option option)
Parsing\TokenType.cs (1)
26/// <see cref="CommandLine.Option"/>
System.CommandLine.StaticCompletions (16)
DynamicSymbolExtensions.cs (1)
19extension(Option option)
HelpGenerationExtensions.cs (7)
37public static string[] Names(this Option option) 43public static (string primary, string[]? aliases) PrimaryNameAndAliases(this Option option) 76public static IEnumerable<Option> HierarchicalOptions(this Command c) 91private static IEnumerable<Option> OptionsForParent(Command c) 93foreach (var o in c.Options) 102foreach (var o in OptionsForParent(p)) 114public static bool IsFlag(this Option option) => option.Arity.Equals(ArgumentArity.Zero);
shells\BashShellProvider.cs (1)
185internal static string? GenerateOptionHandler(Option option)
shells\FishShellProvider.cs (2)
258foreach (var option in valueOptions) 331foreach (var option in cmd.HierarchicalOptions().Where(o => !o.Hidden))
shells\PowershellShellProvider.cs (3)
91private static IEnumerable<string> GenerateOptionNameCompletions(Option o) 178foreach (var option in command.HierarchicalOptions()) 242private static void GenerateDynamicCompletionsForOptions(string[] commandNameList, IList<Option> options, IndentedTextWriter writer)
shells\ZshShellProvider.cs (2)
83foreach (var option in command.HierarchicalOptions()) 307private static string[]? ZshValueExpression(Option option)