mirror of
https://github.com/flutter/flutter.git
synced 2026-02-20 02:29:02 +08:00
1709c884aa
Sources under `packages/flutter_tools/` aren't accessible to the average Flutter user by navigating through sources from their projects, so it doesn't need to be as explicitly verbose with types for readability purposes. The `always_specify_types` lint results in extremely verbose code within the tool which adds little value. This change disables `always_specify_types` in favor of a new set of lints that aim to reduce verbosity by removing obvious types while also maintaining readability in cases where variable types otherwise wouldn't be obvious: - `omit_obvious_local_variable_types` - `omit_obvious_property_types` - `specify_nonobvious_local_variable_types` - `specify_nonobvious_property_types`
75 lines
2.4 KiB
Dart
75 lines
2.4 KiB
Dart
// Copyright 2014 The Flutter Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style license that can be
|
|
// found in the LICENSE file.
|
|
|
|
import 'package:completion/completion.dart';
|
|
|
|
import '../base/common.dart';
|
|
import '../base/file_system.dart';
|
|
import '../globals.dart' as globals;
|
|
import '../runner/flutter_command.dart';
|
|
|
|
class ShellCompletionCommand extends FlutterCommand {
|
|
ShellCompletionCommand() {
|
|
argParser.addFlag(
|
|
'overwrite',
|
|
help:
|
|
'Causes the given shell completion setup script to be overwritten if it already exists.',
|
|
);
|
|
}
|
|
|
|
@override
|
|
final name = 'bash-completion';
|
|
|
|
@override
|
|
final description =
|
|
'Output command line shell completion setup scripts.\n\n'
|
|
'This command prints the flutter command line completion setup script for Bash and Zsh. To '
|
|
'use it, specify an output file and follow the instructions in the generated output file to '
|
|
'install it in your shell environment. Once it is sourced, your shell will be able to '
|
|
'complete flutter commands and options.';
|
|
|
|
@override
|
|
final String category = FlutterCommandCategory.sdk;
|
|
|
|
@override
|
|
final aliases = <String>['zsh-completion'];
|
|
|
|
@override
|
|
bool get shouldUpdateCache => false;
|
|
|
|
/// Return null to disable analytics recording of the `bash-completion` command.
|
|
@override
|
|
Future<String?> get usagePath async => null;
|
|
|
|
@override
|
|
Future<FlutterCommandResult> runCommand() async {
|
|
final List<String> rest = argResults?.rest ?? <String>[];
|
|
if (rest.length > 1) {
|
|
throwToolExit('Too many arguments given to bash-completion command.', exitCode: 1);
|
|
}
|
|
|
|
if (rest.isEmpty || rest.first == '-') {
|
|
final String script = generateCompletionScript(<String>['flutter']);
|
|
globals.stdio.stdoutWrite(script);
|
|
return FlutterCommandResult.warning();
|
|
}
|
|
|
|
final File outputFile = globals.fs.file(rest.first);
|
|
if (outputFile.existsSync() && !boolArg('overwrite')) {
|
|
throwToolExit(
|
|
'Output file ${outputFile.path} already exists, will not overwrite. '
|
|
'Use --overwrite to force overwriting existing output file.',
|
|
exitCode: 1,
|
|
);
|
|
}
|
|
try {
|
|
outputFile.writeAsStringSync(generateCompletionScript(<String>['flutter']));
|
|
} on FileSystemException catch (error) {
|
|
throwToolExit('Unable to write shell completion setup script.\n$error', exitCode: 1);
|
|
}
|
|
|
|
return FlutterCommandResult.success();
|
|
}
|
|
}
|