Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/config/example/command_example.dart
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Future<void> main(final List<String> args) async {
}

/// `--version` / `-v`: prints the version instead of running a subcommand.
class VersionActionOption extends FlagOption with ActionOptionMixin {
class VersionActionOption extends FlagOption with ActionOptionMixin<bool> {
/// Creates the version action option.
const VersionActionOption()
: super(
Expand Down
4 changes: 2 additions & 2 deletions packages/config/lib/src/command/abstract_command.dart
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import 'dart:async' show FutureOr;

import '../../middleware.dart' show MiddlewareChain, Middleware;
import '../config/config.dart'
import '../../config.dart'
show
OptionDefinition,
CommandDefinition,
Configuration,
ConfigurationBroker,
ArgParseResult,
NewParsedArgs;
import '../../middleware.dart' show MiddlewareChain, Middleware;
import 'command.dart' show Command;
import 'command_context.dart';
import 'command_middleware.dart';
Expand Down
25 changes: 25 additions & 0 deletions packages/config/lib/src/command/action_option.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import 'dart:async' show FutureOr;

import '../../config.dart' show OptionDefinition;
import 'command_context.dart';

/// ActionOptionMixin can be added to an option definition to make CommandRunner
/// run it as an "action option" when it is specified on the command line.
///
/// As a convenience, access the full option object via the inherited [option]
/// getter.
mixin ActionOptionMixin<V> implements OptionDefinition<V> {
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
/// Whether this action option accepts a partial command line,
/// i.e. runs even if the command line is incomplete.
///
/// True by default for action options.
///
/// {@macro acceptsPartialCommandLine}
bool get acceptsPartialCommandLine => true;

/// Runs this action option.
/// [context] is the context of the command that defined this action option.
FutureOr<R?> run<O extends OptionDefinition, R>(
final CommandContext<O, R> context,
);
}
8 changes: 4 additions & 4 deletions packages/config/lib/src/command/builtin_global_option.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import 'dart:async' show FutureOr;

import '../config/config.dart'
import '../../config.dart'
show ConfigOptionBase, EnumOption, EnumParser, FlagOption, OptionDefinition;
import 'action_option.dart';
import 'command_context.dart';
import 'command_runner.dart' show ActionOptionMixin;
import 'completion/completion.dart' show printCompletionScript;
import 'completion/completion_shell.dart' show CompletionShell;
import 'help_command.dart' show printCommandUsage;
Expand All @@ -23,7 +23,7 @@ enum BuiltinGlobalOption<V extends Object> implements OptionDefinition<V> {
final ConfigOptionBase<V> option;
}

class HelpActionOption extends FlagOption with ActionOptionMixin {
class HelpActionOption extends FlagOption with ActionOptionMixin<bool> {
const HelpActionOption()
: super(
argName: 'help',
Expand All @@ -42,7 +42,7 @@ class HelpActionOption extends FlagOption with ActionOptionMixin {
}

class CompletionActionOption extends EnumOption<CompletionShell>
with ActionOptionMixin {
with ActionOptionMixin<CompletionShell> {
const CompletionActionOption()
: super(
enumParser: const EnumParser(CompletionShell.values),
Expand Down
2 changes: 1 addition & 1 deletion packages/config/lib/src/command/command.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import 'dart:async' show FutureOr;

import '../config/config.dart'
import '../../config.dart'
show
OptionDefinition,
CommandUsageDefinition,
Expand Down
23 changes: 22 additions & 1 deletion packages/config/lib/src/command/command_context.dart
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import '../../config.dart' show OptionDefinition, Configuration;
import '../../config.dart'
show OptionDefinition, Configuration, ValueSourceType;
import 'abstract_command.dart';
import 'action_option.dart';
import 'builtin_global_option.dart';
import 'context_provider.dart';

Expand Down Expand Up @@ -84,4 +86,23 @@ class CommandContext<O extends OptionDefinition, T> {
final nextContext = next;
return nextContext == null ? this : nextContext.leaf();
}

/// Returns the action options of the command that were specified on the
/// command line, if any.
///
/// If non-empty, the first one is run instead of the command.
List<ActionOptionMixin> specifiedActionOptions() {
final allArgOptions = [
...config.optionsWhereSource(
(final ValueSourceType s) => s == ValueSourceType.arg,
),
...builtinConfig.optionsWhereSource(
(final ValueSourceType s) => s == ValueSourceType.arg,
),
];
return allArgOptions
.map((final o) => o is ActionOptionMixin ? o : o.option)
.whereType<ActionOptionMixin>()
.toList();
}
}
2 changes: 1 addition & 1 deletion packages/config/lib/src/command/command_middleware.dart
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import 'dart:async' show FutureOr;

import '../../config.dart' show OptionDefinition;
import '../../middleware.dart';
import '../config/config.dart' show OptionDefinition;
import 'command_context.dart';

typedef CommandHandler<O extends OptionDefinition, T> =
Expand Down
28 changes: 19 additions & 9 deletions packages/config/lib/src/command/command_resolver.dart
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
import '../config/arg_parser/arg_parser.dart'
import '../../config.dart'
show
ArgParseResult,
DoubleDashHandling,
ParserSettings,
scanAndParseCommands,
subcommandRequiredErrorPrefix;
import '../config/config.dart'
show
subcommandRequiredErrorPrefix,
CommandDefinition,
OptionDefinition,
UsageException,
CommandUsageException;
import '../config/output_formatting.dart' show formatConfigError;
CommandUsageException,
formatConfigError;
import 'abstract_command.dart';
import 'action_option.dart';
import 'command_context.dart';
import 'command_runner.dart'
show CommandRunner, specifiedActionOption, ActionOptionMixin;
import 'command_runner.dart' show CommandRunner;
import 'context_provider.dart';

/// Interface for the command resolver, which resolves the configurations for
Expand Down Expand Up @@ -166,7 +164,7 @@ class StandardCommandResolver<O extends OptionDefinition, T>
}

bool _acceptsPartialCommandLine(final CommandContext contexts) {
if (specifiedActionOption(contexts)
if (_specifiedActionOption(contexts)
case final ActionOptionMixin actionOption) {
return actionOption.acceptsPartialCommandLine;
}
Expand Down Expand Up @@ -197,3 +195,15 @@ class StandardCommandResolver<O extends OptionDefinition, T>
}
}
}

/// Returns the first of the action options that were specified on the command
/// line, or null if none.
ActionOptionMixin? _specifiedActionOption(final CommandContext contexts) {
CommandContext? context = contexts;
while (context != null) {
final actionOption = context.specifiedActionOptions().firstOrNull;
if (actionOption != null) return actionOption;
context = context.next;
}
return null;
}
59 changes: 7 additions & 52 deletions packages/config/lib/src/command/command_runner.dart
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
import 'dart:async' show Future, FutureOr;
import 'dart:io' show Platform, stderr;

import '../config/arg_parser/arg_parser.dart'
show CommandAliasesDefinition, CommandDefinition, CommandUsageDefinition;
import '../config/config.dart'
import '../../config.dart'
show
OptionDefinition,
CommandAliasesDefinition,
CommandDefinition,
CommandUsageDefinition,
Configuration,
OptionDefinition,
UsageException,
ParsedArgs,
ConfigOptionBase,
FlagOption,
MultiOption,
ArgParseResult,
NewParsedArgs,
ValueSourceType;
NewParsedArgs;
import 'abstract_command.dart';
import 'builtin_global_option.dart';
import 'command_context.dart';
Expand Down Expand Up @@ -399,7 +399,7 @@ class CommandRunner<O extends OptionDefinition, T>
FutureOr<T?> _runNested(
final CommandContext<OptionDefinition, T> context,
) {
final actionOption = _specifiedActionOptions(context).firstOrNull;
final actionOption = context.specifiedActionOptions().firstOrNull;
if (actionOption != null) {
return context.command.runCommand(
context,
Expand Down Expand Up @@ -456,51 +456,6 @@ class CommandRunner<O extends OptionDefinition, T>
/// by third-party completion engines such as Carapace.
const String _completeRequestCommand = '__complete';

/// ActionOptionMixin can be added to an option definition to make CommandRunner
/// run it as an "action option" when it is specified on the command line.
mixin ActionOptionMixin {
/// Whether this action option accepts a partial command line,
/// i.e. runs even if the command line is incomplete.
///
/// True by default for action options.
///
/// {@macro acceptsPartialCommandLine}
bool get acceptsPartialCommandLine => true;

/// Runs this action option.
/// [context] is the context of the command that defined this action option.
FutureOr<R?> run<O extends OptionDefinition, R>(
final CommandContext<O, R> context,
);
}

ActionOptionMixin? specifiedActionOption(final CommandContext contexts) {
CommandContext? context = contexts;
while (context != null) {
final actionOption = _specifiedActionOptions(context).firstOrNull;
if (actionOption != null) return actionOption;
context = context.next;
}
return null;
}

List<ActionOptionMixin> _specifiedActionOptions(
final CommandContext context,
) {
final allArgOptions = [
...context.config.optionsWhereSource(
(final ValueSourceType s) => s == ValueSourceType.arg,
),
...context.builtinConfig.optionsWhereSource(
(final ValueSourceType s) => s == ValueSourceType.arg,
),
];
return allArgOptions
.map((final option) => option.option)
.whereType<ActionOptionMixin>()
.toList();
}

class OriginalCommandLine {
final List<String> args;

Expand Down
1 change: 1 addition & 0 deletions packages/config/lib/src/command/commands.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
/// help, usage output and shell completion.
library;

export 'action_option.dart';
export 'builtin_global_option.dart';
export 'command.dart';
export 'command_context.dart';
Expand Down
2 changes: 1 addition & 1 deletion packages/config/lib/src/command/help_command.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import 'dart:async' show FutureOr;

import 'package:collection/collection.dart';

import '../config/config.dart'
import '../../config.dart'
show OptionDefinition, CommandUsageDefinition, CommandAliasesDefinition;
import 'abstract_command.dart' show AbstractCommand;
import 'command.dart' show Command;
Expand Down
63 changes: 62 additions & 1 deletion packages/config/test/command/command_middleware_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -1426,6 +1426,48 @@ void main() {
});
});

group('Given an action option enum that is itself the action', () {
late List<String> trace;
late CommandRunner<OptionDefinition, String> runner;

setUp(() {
trace = [];
_enumActionTrace = trace;
runner = CommandRunner<OptionDefinition, String>(
'tool',
'Tools',
globalOptions: [_EnumVersionOption.version],
subcommands: [
RecordingCommand<OptionDefinition>(
name: 'project',
description: 'Manage projects',
trace: trace,
),
],
);
});

tearDown(() {
_enumActionTrace = null;
});

group('when --version is passed', () {
late String? result;

setUp(() async {
result = await runner.run(['--version', 'project']);
});

test('then that enum runs and the subcommand does not', () {
expect(trace, ['enum-version']);
});

test('then the runner returns the enum action result', () {
expect(result, 'enum-version');
});
});
});

group('Given an action option defined on a leaf command', () {
late List<String> trace;
late CommandRunner<OptionDefinition, String> runner;
Expand Down Expand Up @@ -1496,7 +1538,26 @@ CommandMiddleware<O, String> _traceMiddleware<O extends OptionDefinition>(
};
}

class _VersionAction extends FlagOption with ActionOptionMixin {
List<String>? _enumActionTrace;

enum _EnumVersionOption<V extends Object> with ActionOptionMixin<V> {
version(FlagOption(argName: 'version', negatable: false));

const _EnumVersionOption(this.option);

@override
final ConfigOptionBase<V> option;

@override
FutureOr<R?> run<O extends OptionDefinition, R>(
final CommandContext<O, R> context,
) {
_enumActionTrace?.add('enum-version');
return 'enum-version' as R?;
}
}

class _VersionAction extends FlagOption with ActionOptionMixin<bool> {
_VersionAction(this.trace) : super(argName: 'version', negatable: false);

final List<String> trace;
Expand Down
Loading