Skip to content

Commit 7bf51d0

Browse files
committed
refactor(flutter_tools): delegate FlutterCommand helpers to OptionBundle.register
1 parent 845e957 commit 7bf51d0

3 files changed

Lines changed: 38 additions & 36 deletions

File tree

‎packages/flutter_tools/lib/src/runner/flutter_command.dart‎

Lines changed: 8 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -453,21 +453,13 @@ abstract class FlutterCommand extends Command<void> {
453453
/// The `hide` argument indicates whether or not to hide these options when
454454
/// the user asks for help.
455455
void usesFilesystemOptions({required bool hide}) {
456-
argParser.addDescriptors(const <OptionDescriptor<Object?>>[
457-
BuildInfoOptions.outputDill,
458-
BuildInfoOptions.fileSystemRoot,
459-
BuildInfoOptions.fileSystemScheme,
460-
], hideOverride: hide);
456+
const FilesystemOptionsBundle().register(this, argParser, hideOverride: hide);
461457
}
462458

463459
/// Adds options for connecting to the Dart VM Service port.
464460
void usesPortOptions({required bool verboseHelp}) {
465-
argParser.addDescriptors(const <OptionDescriptor<Object?>>[
466-
DebuggingOptionDescriptors.vmServicePort,
467-
DebuggingOptionDescriptors.deviceVmservicePort,
468-
DebuggingOptionDescriptors.hostVmservicePort,
469-
], verboseHelp: verboseHelp);
470-
_usesPortOption = true;
461+
const VmServicePortOptionsBundle(includeIpv6: false)
462+
.register(this, argParser, verboseHelp: verboseHelp);
471463
}
472464

473465
/// Add option values for output directory of artifacts
@@ -488,11 +480,8 @@ abstract class FlutterCommand extends Command<void> {
488480
}
489481

490482
void addDdsOptions({required bool verboseHelp}) {
491-
argParser.addDescriptors(const <OptionDescriptor<Object?>>[
492-
DebuggingOptionDescriptors.ddsPort,
493-
DebuggingOptionDescriptors.dds,
494-
DebuggingOptionDescriptors.disableDds,
495-
], verboseHelp: verboseHelp);
483+
const DdsAndDevToolsOptionsBundle(includeDevTools: false)
484+
.register(this, argParser, verboseHelp: verboseHelp);
496485
}
497486

498487
late final bool enableDds = getValue(DebuggingOptionDescriptors.dds);
@@ -692,20 +681,11 @@ abstract class FlutterCommand extends Command<void> {
692681
bool excludeDebug = false,
693682
bool excludeRelease = false,
694683
}) {
695-
configureBuildModes(
684+
BuildModeOptionsBundle(
696685
defaultToRelease: defaultToRelease,
697686
excludeDebug: excludeDebug,
698687
excludeRelease: excludeRelease,
699-
);
700-
701-
if (!excludeDebug) {
702-
CommonOptions.debugMode.addTo(argParser, verboseHelp: verboseHelp);
703-
}
704-
CommonOptions.profileMode.addTo(argParser, verboseHelp: verboseHelp);
705-
if (!excludeRelease) {
706-
CommonOptions.releaseMode.addTo(argParser, verboseHelp: verboseHelp);
707-
CommonOptions.jitReleaseMode.addTo(argParser, verboseHelp: verboseHelp);
708-
}
688+
).register(this, argParser, verboseHelp: verboseHelp);
709689
}
710690

711691
void addSplitDebugInfoOption() {
@@ -747,10 +727,7 @@ abstract class FlutterCommand extends Command<void> {
747727
}
748728

749729
void addAndroidSpecificBuildOptions({bool hide = false}) {
750-
BuildInfoOptions.androidGradleDaemon.addTo(argParser, hideOverride: hide);
751-
BuildInfoOptions.androidSkipBuildDependencyValidation.addTo(argParser, hideOverride: hide);
752-
BuildInfoOptions.androidProjectArg.addTo(argParser, hideOverride: hide);
753-
BuildInfoOptions.androidProjectCacheDir.addTo(argParser, hideOverride: hide);
730+
const AndroidGradleOptionsBundle().register(this, argParser, hideOverride: hide);
754731
}
755732

756733
void addNativeNullAssertions({bool hide = false}) {

‎packages/flutter_tools/lib/src/runner/options/option_bundle.dart‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,18 @@ abstract class OptionBundle {
2626

2727
/// Registers all option descriptors and child bundles into [parser] and binds
2828
/// to [command].
29-
void register(FlutterCommand command, ArgParser parser) {
29+
void register(FlutterCommand command, ArgParser parser, {bool? verboseHelp, bool? hideOverride}) {
3030
if (title != null) {
3131
parser.addSeparator(title!);
3232
}
3333
onRegister(command);
34-
for (final OptionDescriptor<Object?> descriptor in descriptors) {
35-
descriptor.addTo(parser, verboseHelp: command.verboseHelp);
36-
}
34+
parser.addDescriptors(
35+
descriptors,
36+
verboseHelp: verboseHelp ?? command.verboseHelp,
37+
hideOverride: hideOverride,
38+
);
3739
for (final OptionBundle subBundle in subBundles) {
38-
subBundle.register(command, parser);
40+
subBundle.register(command, parser, verboseHelp: verboseHelp, hideOverride: hideOverride);
3941
}
4042
}
4143
}

‎packages/flutter_tools/test/general.shard/runner/options/option_descriptor_test.dart‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -863,6 +863,29 @@ void main() {
863863
);
864864
},
865865
);
866+
867+
testUsingContext('OptionBundle.register supports verboseHelp and hideOverride overrides for FlutterCommand helpers', () async {
868+
final command = _FakeCommand(name: 'helper-test', description: 'Helper delegation test');
869+
command.usesFilesystemOptions(hide: false);
870+
command.usesPortOptions(verboseHelp: true);
871+
command.addBuildModeFlags(verboseHelp: true, defaultToRelease: false, excludeRelease: true);
872+
873+
expect(command.argParser.options['output-dill']!.hide, isFalse);
874+
expect(command.argParser.options['vm-service-port']!.hide, isFalse);
875+
expect(command.argParser.options, isNot(contains('ipv6')));
876+
expect(command.getBuildMode(), BuildMode.debug);
877+
expect(command.argParser.options.keys, containsAll(<String>['debug', 'profile']));
878+
expect(command.argParser.options, isNot(contains('release')));
879+
880+
final hiddenCommand = _FakeCommand(name: 'hidden-test', description: 'Hidden override');
881+
const FilesystemOptionsBundle().register(
882+
hiddenCommand,
883+
hiddenCommand.argParser,
884+
verboseHelp: true,
885+
hideOverride: true,
886+
);
887+
expect(hiddenCommand.argParser.options['output-dill']!.hide, isTrue);
888+
});
866889
});
867890
}
868891

0 commit comments

Comments
 (0)