3 types derived from Option
System.CommandLine (3)
Help\HelpOption.cs (1)
11
public sealed class HelpOption :
Option
Option{T}.cs (1)
10
public class Option<T> :
Option
VersionOption.cs (1)
14
public sealed class VersionOption :
Option
193 references to Option
aspire (27)
Commands\BaseCommand.cs (1)
308
foreach (
var
option in Options)
Commands\GroupedHelpWriter.cs (3)
305
internal static string FormatOptionLabel(
Option
option, bool includeValueName = false)
320
private static bool IsBooleanOption(
Option
option)
325
private static string GetOptionValueName(
Option
option)
Commands\OptionWithLegacy.cs (1)
52
internal static void Add<T>(this IList<
Option
> options, OptionWithLegacy<T> optionWithLegacy)
Commands\ParseResultHelper.cs (5)
61
params
Option
[] excludedOptions)
205
Option
[] excludedOptions)
220
foreach (
var
option in excludedOptions)
409
private static void CollectOptionNames(IList<
Option
> options, bool includeOnlyRecursive, Dictionary<string, string> knownOptions)
411
foreach (
var
option in options)
Commands\ResourceCommand.cs (10)
282
var options = new Dictionary<ResourceSnapshotCommandArgument,
Option
>();
290
var
option = CreateCommandArgumentOption(argument, parseMode);
329
var
option = options[argument];
382
private static
Option
CreateCommandArgumentOption(ResourceSnapshotCommandArgument argument, CommandArgumentParseMode parseMode)
393
Option
option = (IsBooleanInput(argument), IsNumberInput(argument), parseAsString) switch
782
private static IEnumerable<
Option
> GetVisibleCliOptions(System.CommandLine.Parsing.CommandResult commandResult)
786
foreach (
var
option in commandResult.Command.Options)
797
foreach (
var
option in parentCommandResult.Command.Options)
825
private static void AddOptionNames(IEnumerable<
Option
> options, bool includeOnlyRecursive, HashSet<string> names)
827
foreach (
var
option in options)
Commands\RootCommand.cs (5)
101
internal static IReadOnlyList<
Option
> GlobalOptions { get; } =
137
var
option = GlobalOptions.Append(StartDebugSessionOption)
157
private static readonly (
Option
Option, Func<ParseResult, string[]?> GetArgs)[] s_childProcessOptions =
239
foreach (
var
option in GlobalOptions)
314
foreach (
var
option in Options)
Templating\CliTemplateFactory.cs (1)
308
private static void AddOptionIfMissing(System.CommandLine.Command command, System.CommandLine.
Option
option)
Templating\DotNetTemplateFactory.cs (1)
404
private static void AddOptionIfMissing(Command command,
Option
option)
Aspire.Cli.Tests (3)
Commands\NewCommandTests.cs (1)
130
var
channelOption = command.Options.Single(option => option.Name == "--channel");
Commands\TerminalCommandTests.cs (1)
181
var
replicaOption = Assert.Single(result.CommandResult.Command.Options, option => option.Name == "--replica");
Commands\UpdateCommandTests.cs (1)
58
var
channelOption = command.Options.Single(option => option.Name == "--channel");
crossgen2 (2)
parent\parent\Common\CommandLineHelpers.cs (2)
164
foreach (
Option
option in command.Options)
240
foreach (
Option
option in res.CommandResult.Command.Options)
dotnet-aot (15)
parent\dotnet\CliSchema.cs (3)
138
private static Dictionary<string, OptionDetails>? CreateOptionsDictionary(IList<
Option
> options)
145
foreach (
var
option in options.OrderBy(o => o.Name, StringComparer.OrdinalIgnoreCase))
186
private static OptionDetails CreateOptionDetails(
Option
option) => new OptionDetails(
parent\dotnet\Commands\Run\AotRunCommand.cs (1)
428
private static
Option
? GetUnsupportedOption(ParseResult parseResult, RunCommandDefinition definition)
parent\dotnet\Commands\Test\AotTestCommand.cs (1)
65
private static
Option
? GetUnsupportedOption(
parent\dotnet\Commands\Test\MTP\MicrosoftTestingPlatformTestCommand.Help.cs (1)
128
private (List<CommandLineOptionMessage> BuiltInOptions, List<CommandLineOptionMessage> NonBuiltInOptions) GetAllOptions(IList<
Option
> commandOptions)
parent\dotnet\Parser.cs (5)
118
Option
option = rootCommand.Options[i];
291
private sealed class AotPrintHelpAction(
Option
option, HelpBuilder builder, params Command[] managedHelpCommands)
437
HashSet<
Option
> uniqueOptions = [];
438
foreach (
Option
option in context.Command.Options)
468
foreach (
var
option in command.Options)
parent\dotnet\ParserOptionActions.cs (3)
25
internal abstract class InvocableOptionAction(
Option
option) : SynchronousCommandLineAction
30
public
Option
Option { get; } = option;
95
internal class PrintHelpAction(
Option
option, HelpBuilder builder) : InvocableOptionAction(option)
parent\Microsoft.TemplateEngine.Cli\SymbolExtensions.cs (1)
11
public static void EnsureHelpName(this
Option
cliOption)
dotnet-watch (2)
CommandLine\CommandLineOptions.cs (1)
84
foreach (
var
buildOption in buildOptions)
CommandLine\DotnetWatchCommandDefinition.cs (1)
137
public bool IsWatchOption(
Option
option)
ilasm (6)
NativeCommandLine.cs (6)
59
Dictionary<string,
Option
> modernShortOptions = new(StringComparer.Ordinal);
60
foreach (
Option
option in command.Options)
193
void AddModernOption(string name,
Option
option)
208
void AddModernShortOption(string name,
Option
option)
252
Dictionary<string,
Option
> modernShortOptions)
259
if (!modernShortOptions.TryGetValue($"-{optionName}", out
Option
? option))
ilc (2)
parent\parent\Common\CommandLineHelpers.cs (2)
164
foreach (
Option
option in command.Options)
240
foreach (
Option
option in res.CommandResult.Command.Options)
Microsoft.DotNet.Cli.CommandLine (5)
ForwardedOptionExtensions.cs (2)
19
extension(
Option
option)
214
public IEnumerable<string> OptionValuesToBeForwarded(IEnumerable<
Option
> options)
OptionBuilderExtensions.cs (1)
14
extension<T>(T option) where T :
Option
ResultNavigationExtensions.cs (2)
76
public static bool HasOption(this ParseResult parseResult,
Option
option) => parseResult.GetResult(option) is OptionResult or && !or.Implicit;
89
public 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)
50
public static TDefinition AddOptions<TDefinition>(this TDefinition command, IEnumerable<
Option
> options)
Commands\New\InstantiateCommandDefinition.cs (1)
30
foreach (
var
option in InstantiateOptions.AllOptions)
Commands\New\InstantiateOptions.cs (1)
17
public IEnumerable<
Option
> AllOptions
Commands\New\LegacyFilterOptions.cs (1)
17
public IEnumerable<
Option
> AllOptions
Commands\New\LegacyOptions.cs (2)
17
public IEnumerable<
Option
> AllOptions
26
foreach (
var
option in FilterOptions.AllOptions)
Commands\Package\PackageListCommandDefinition.cs (13)
19
public readonly
Option
OutdatedOption = new Option<bool>("--outdated")
25
public readonly
Option
DeprecatedOption = new Option<bool>("--deprecated")
31
public readonly
Option
VulnerableOption = new Option<bool>("--vulnerable")
37
public readonly
Option
FrameworkOption = new Option<IEnumerable<string>>("--framework", "-f")
44
public readonly
Option
TransitiveOption = new Option<bool>("--include-transitive")
50
public readonly
Option
PrereleaseOption = new Option<bool>("--include-prerelease")
56
public readonly
Option
HighestPatchOption = new Option<bool>("--highest-patch")
62
public readonly
Option
HighestMinorOption = new Option<bool>("--highest-minor")
68
public readonly
Option
ConfigOption = new Option<string>("--config", "--configfile")
74
public readonly
Option
SourceOption = new Option<IEnumerable<string>>("--source", "-s")
83
public readonly
Option
NoRestore = new Option<bool>("--no-restore")
89
public readonly
Option
VerbosityOption = new Option<Utils.VerbosityOptions>("--verbosity", "-v")
100
public readonly
Option
OutputVersionOption = new Option<int>("--output-version")
Commands\Tool\ToolLocationOptions.cs (1)
19
public void AddTo(IList<
Option
> options)
Common\ImplicitRestoreOptions.cs (1)
105
public void AddTo(IList<
Option
> options)
Common\NuGetRestoreOptions.cs (1)
54
public void AddTo(IList<
Option
> options)
Common\TargetPlatformOptions.cs (3)
16
public readonly
Option
RuntimeOption;
30
public TargetPlatformOptions(
Option
runtimeOption)
42
public void AddTo(IList<
Option
> options)
Help\HelpBuilder.cs (4)
191
if (symbol is
Option
or Command)
207
?? (symbol is
Option
option
247
var defaultArguments = arguments.Where(x => !x.Hidden && (x is Argument { HasDefaultValue: true } || x is
Option
{ HasDefaultValue: true })).ToArray();
267
case
Option
option:
Help\HelpBuilder.Default.cs (6)
27
Option
option => option.HasDefaultValue && !(option.ValueType == typeof(bool) && option.Arity.MaximumNumberOfValues == 0)
56
Option
option => GetUsageLabel(option.HelpName, option.ValueType, option.CompletionSources, option, option.Arity) ?? "",
97
public static string GetOptionUsageLabel(
Option
symbol)
165
foreach (
Option
option in ctx.Command.Options)
187
foreach (
var
option in parentCommand.Options)
249
if (symbol is
Option
{ Required: true })
Microsoft.DotNet.Cli.Utils (2)
MSBuildArgs.cs (2)
103
public static MSBuildArgs AnalyzeMSBuildArguments(IEnumerable<string> forwardedAndUserFacingArgs, params
Option
[] options)
106
foreach (
var
option in options)
Microsoft.TemplateEngine.Cli (29)
ChoiceTemplateParameter.cs (1)
71
protected override
Option
GetBaseOption(IReadOnlySet<string> aliases)
CliTemplateParameter.cs (6)
137
/// Creates <see cref="
Option
"/> for template parameter.
140
internal
Option
GetOption(IReadOnlySet<string> aliases)
142
Option
option = GetBaseOption(aliases);
206
protected virtual
Option
GetBaseOption(IReadOnlySet<string> aliases)
209
Option
cliOption = Type switch
274
protected void AddAliases(
Option
option, IReadOnlySet<string> aliases)
Commands\BaseCommand.cs (1)
135
protected static void PrintDeprecationMessage<TDeprecatedCommand, TNewCommand>(ParseResult parseResult, Func<TNewCommand,
Option
>? additionalNewOptionSelector = null)
Commands\BaseFilterableArgs.cs (1)
50
foreach (
var
option in filterableCommand.FilterOptions)
Commands\CommandLineUtils.cs (5)
69
internal static string FormatArgumentUsage(
Option
option) => FormatArgumentUsage(new[] { option });
72
internal static string FormatArgumentUsage(IReadOnlyList<
Option
> options)
79
var
option = options[i];
119
bool IsMultiParented(
Option
option) =>
122
bool IsOptional(
Option
option) =>
Commands\create\InstantiateCommand.cs (1)
25
internal IReadOnlyList<
Option
> PassByOptions =>
Commands\create\InstantiateCommand.Help.cs (2)
299
List<
Option
> optionsToShow = new()
334
foreach (
Option
cliOption in optionsToShow)
Commands\create\TemplateCommand.cs (1)
297
foreach (
Option
option in command.Options)
Commands\create\TemplateOption.cs (2)
10
private
Option
_option;
25
internal
Option
Option => _option;
Commands\Example.cs (2)
96
internal Example<T> WithOption(Func<T,
Option
> optionSelector, params string[] args)
98
var
option = optionSelector(currentCommand);
Commands\Extensions.cs (3)
15
internal static string? GetValueForOptionOrNull(this ParseResult parseResult,
Option
option)
28
internal static bool HasErrorFor(this ParseResult parseResult,
Option
option, [NotNullWhen(true)] out ParseError? error)
35
static bool IsOptionResult(SymbolResult? symbolResult,
Option
option)
Commands\IFilterableCommand.cs (1)
10
IEnumerable<
Option
> FilterOptions { get; }
Commands\list\BaseListCommand.cs (1)
23
public IEnumerable<
Option
> FilterOptions => _definition.FilterOptions.AllOptions;
Commands\search\BaseSearchCommand.cs (1)
17
public IEnumerable<
Option
> FilterOptions => Definition.FilterOptions.AllOptions;
SymbolExtensions.cs (1)
11
public static void EnsureHelpName(this
Option
cliOption)
SelectTests (2)
Program.cs (2)
89
foreach (
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)
29
private ChildSymbolList<
Option
>? _options;
51
foreach (
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.
72
public IList<
Option
> Options => _options ??= new (this);
223
/// Adds an <see cref="
Option
"/> to the command.
226
public void Add(
Option
option) => Options.Add(option);
316
var
option = parentCommand.Options[i];
Help\HelpBuilder.cs (2)
413
if (symbol is
Option
or Command)
429
?? (symbol is
Option
option
Help\HelpBuilder.Default.cs (9)
29
Option
option => ShouldShowDefaultValue(option)
49
Option
option => ShouldShowDefaultValue(option),
54
public static bool ShouldShowDefaultValue(
Option
option) =>
74
Option
option => GetUsageLabel(option.HelpName, option.ValueType, option.CompletionSources, option, option.Arity) ?? "",
99
if (symbol is
Option
)
131
public static string GetOptionUsageLabel(
Option
symbol)
161
if (symbol is
Option
{ Required: true })
234
foreach (
Option
option in ctx.Command.Options.OrderBy(o => o is HelpOption or VersionOption))
257
foreach (
var
option in parentCommand.Options)
Help\HelpBuilderExtensions.cs (1)
14
case
Option
option:
Invocation\ParseErrorAction.cs (2)
121
? targetSymbol.Children.Where(x => !x.Hidden && x is
Option
or Command)
133
AliasSet? 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)
199
public OptionResult? GetResult(
Option
option) =>
Parsing\CommandResult.cs (1)
81
var
option = options[i];
Parsing\OptionResult.cs (2)
15
Option
option,
28
public
Option
Option { get; }
Parsing\ParseOperation.cs (4)
212
Option
option = (
Option
)CurrentToken.Symbol!;
386
if (kvp is { Key:
Option
{ Action: { Terminating: false } action }, Value: OptionResult { Implicit: true } } &&
450
if (symbol is
Option
{ Action: { } optionAction } option)
Parsing\StringExtensions.cs (10)
131
if (PreviousTokenIsAnOptionExpectingAnArgument(out
var
option))
140
tokenList.Add(Option(arg, (
Option
)token.Symbol!));
167
tokenList.Add(Option(first, (
Option
)subtoken.Symbol!));
185
Token OptionArgument(string value,
Option
option) => new(value, TokenType.Argument, option, i);
189
Token Option(string value,
Option
option) => new(value, TokenType.Option, option, i);
233
if (i != alias.Length - 1 && ((
Option
)found.Symbol!).Greedy)
248
bool PreviousTokenIsAnOptionExpectingAnArgument(out
Option
? option)
256
if (token.Symbol is
Option
{ Greedy: true } opt)
444
Option
option = parentCommand.Options[i];
474
static void AddOptionTokens(Dictionary<string, Token> tokens,
Option
option)
Parsing\SymbolResult.cs (1)
84
public OptionResult? GetResult(
Option
option) => SymbolResultTree.GetResult(option);
Parsing\SymbolResultTree.cs (1)
40
internal OptionResult? GetResult(
Option
option)
Parsing\TokenType.cs (1)
26
/// <see cref="CommandLine.
Option
"/>
System.CommandLine.StaticCompletions (16)
DynamicSymbolExtensions.cs (1)
19
extension(
Option
option)
HelpGenerationExtensions.cs (7)
37
public static string[] Names(this
Option
option)
43
public static (string primary, string[]? aliases) PrimaryNameAndAliases(this
Option
option)
76
public static IEnumerable<
Option
> HierarchicalOptions(this Command c)
91
private static IEnumerable<
Option
> OptionsForParent(Command c)
93
foreach (
var
o in c.Options)
102
foreach (
var
o in OptionsForParent(p))
114
public static bool IsFlag(this
Option
option) => option.Arity.Equals(ArgumentArity.Zero);
shells\BashShellProvider.cs (1)
185
internal static string? GenerateOptionHandler(
Option
option)
shells\FishShellProvider.cs (2)
258
foreach (
var
option in valueOptions)
331
foreach (
var
option in cmd.HierarchicalOptions().Where(o => !o.Hidden))
shells\PowershellShellProvider.cs (3)
91
private static IEnumerable<string> GenerateOptionNameCompletions(
Option
o)
178
foreach (
var
option in command.HierarchicalOptions())
242
private static void GenerateDynamicCompletionsForOptions(string[] commandNameList, IList<
Option
> options, IndentedTextWriter writer)
shells\ZshShellProvider.cs (2)
83
foreach (
var
option in command.HierarchicalOptions())
307
private static string[]? ZshValueExpression(
Option
option)