executable.dart 10.2 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import 'runner.dart' as runner;
6
import 'src/artifacts.dart';
7
import 'src/base/context.dart';
8
import 'src/base/io.dart';
9
import 'src/base/logger.dart';
10
import 'src/base/platform.dart';
11
import 'src/base/template.dart';
12
import 'src/base/terminal.dart';
13 14
import 'src/base/user_messages.dart';
import 'src/cache.dart';
Hixie's avatar
Hixie committed
15
import 'src/commands/analyze.dart';
16
import 'src/commands/assemble.dart';
17
import 'src/commands/attach.dart';
18
import 'src/commands/build.dart';
19
import 'src/commands/channel.dart';
20
import 'src/commands/clean.dart';
21
import 'src/commands/config.dart';
22
import 'src/commands/create.dart';
23
import 'src/commands/custom_devices.dart';
Devon Carew's avatar
Devon Carew committed
24
import 'src/commands/daemon.dart';
25
import 'src/commands/debug_adapter.dart';
26
import 'src/commands/devices.dart';
27
import 'src/commands/doctor.dart';
28
import 'src/commands/downgrade.dart';
yjbanov's avatar
yjbanov committed
29
import 'src/commands/drive.dart';
30
import 'src/commands/emulators.dart';
31
import 'src/commands/generate.dart';
32
import 'src/commands/generate_localizations.dart';
33
import 'src/commands/ide_config.dart';
34 35
import 'src/commands/install.dart';
import 'src/commands/logs.dart';
36
import 'src/commands/make_host_app_editable.dart';
37
import 'src/commands/packages.dart';
38
import 'src/commands/precache.dart';
39
import 'src/commands/run.dart';
Devon Carew's avatar
Devon Carew committed
40
import 'src/commands/screenshot.dart';
41
import 'src/commands/shell_completion.dart';
42
import 'src/commands/symbolize.dart';
43
import 'src/commands/test.dart';
44
import 'src/commands/update_packages.dart';
45
import 'src/commands/upgrade.dart';
46
import 'src/devtools_launcher.dart';
47
import 'src/features.dart';
48
import 'src/globals.dart' as globals;
49 50 51
// Files in `isolated` are intentionally excluded from google3 tooling.
import 'src/isolated/mustache_template.dart';
import 'src/isolated/resident_web_runner.dart';
52
import 'src/pre_run_validator.dart';
53
import 'src/project_validator.dart';
54
import 'src/resident_runner.dart';
55
import 'src/runner/flutter_command.dart';
56
import 'src/web/web_runner.dart';
57

58 59
/// Main entry point for commands.
///
60
/// This function is intended to be used from the `flutter` command line tool.
61
Future<void> main(List<String> args) async {
62 63
  final bool veryVerbose = args.contains('-vv');
  final bool verbose = args.contains('-v') || args.contains('--verbose') || veryVerbose;
64
  final bool prefixedErrors = args.contains('--prefixed-errors');
65 66 67 68 69
  // Support the -? Powershell help idiom.
  final int powershellHelpIndex = args.indexOf('-?');
  if (powershellHelpIndex != -1) {
    args[powershellHelpIndex] = '-h';
  }
70 71 72

  final bool doctor = (args.isNotEmpty && args.first == 'doctor') ||
      (args.length == 2 && verbose && args.last == 'doctor');
73
  final bool help = args.contains('-h') || args.contains('--help') ||
74
      (args.isNotEmpty && args.first == 'help') || (args.length == 1 && verbose);
75
  final bool muteCommandLogging = (help || doctor) && !veryVerbose;
76
  final bool verboseHelp = help && verbose;
77
  final bool daemon = args.contains('daemon');
78 79
  final bool runMachine = (args.contains('--machine') && args.contains('run')) ||
                          (args.contains('--machine') && args.contains('attach'));
Devon Carew's avatar
Devon Carew committed
80

81 82 83 84 85
  // Cache.flutterRoot must be set early because other features use it (e.g.
  // enginePath's initializer uses it). This can only work with the real
  // instances of the platform or filesystem, so just use those.
  Cache.flutterRoot = Cache.defaultFlutterRoot(
    platform: const LocalPlatform(),
86
    fileSystem: globals.localFileSystem,
87 88 89
    userMessages: UserMessages(),
  );

90 91 92
  await runner.run(
    args,
    () => generateCommands(
93
      verboseHelp: verboseHelp,
94
      verbose: verbose,
95
    ),
96 97 98 99 100 101 102 103 104 105 106 107 108
    verbose: verbose,
    muteCommandLogging: muteCommandLogging,
    verboseHelp: verboseHelp,
    overrides: <Type, Generator>{
      // The web runner is not supported in google3 because it depends
      // on dwds.
      WebRunnerFactory: () => DwdsWebRunnerFactory(),
      // The mustache dependency is different in google3
      TemplateRenderer: () => const MustacheTemplateRenderer(),
      // The devtools launcher is not supported in google3 because it depends on
      // devtools source code.
      DevtoolsLauncher: () => DevtoolsServerLauncher(
        processManager: globals.processManager,
109
        dartExecutable: globals.artifacts!.getArtifactPath(Artifact.engineDartBinary),
110
        logger: globals.logger,
111
        botDetector: globals.botDetector,
112 113
      ),
      Logger: () {
114 115 116 117 118 119 120
        final LoggerFactory loggerFactory = LoggerFactory(
          outputPreferences: globals.outputPreferences,
          terminal: globals.terminal,
          stdio: globals.stdio,
        );
        return loggerFactory.createLogger(
          daemon: daemon,
121
          machine: runMachine,
122 123 124 125
          verbose: verbose && !muteCommandLogging,
          prefixedErrors: prefixedErrors,
          windows: globals.platform.isWindows,
        );
126
      },
127
      AnsiTerminal: () {
128 129 130 131
        return AnsiTerminal(
          stdio: globals.stdio,
          platform: globals.platform,
          now: DateTime.now(),
132 133 134
          // So that we don't animate anything before calling applyFeatureFlags, default
          // the animations to disabled in real apps.
          defaultCliAnimationEnabled: false,
135
        );
136
        // runner.run calls "terminal.applyFeatureFlags()"
137
      },
138
      PreRunValidator: () => PreRunValidator(fileSystem: globals.fs),
139
    },
140
    shutdownHooks: globals.shutdownHooks,
141
  );
142
}
143

144
List<FlutterCommand> generateCommands({
145 146
  required bool verboseHelp,
  required bool verbose,
147 148 149 150 151 152 153 154
}) => <FlutterCommand>[
  AnalyzeCommand(
    verboseHelp: verboseHelp,
    fileSystem: globals.fs,
    platform: globals.platform,
    processManager: globals.processManager,
    logger: globals.logger,
    terminal: globals.terminal,
155
    artifacts: globals.artifacts!,
156
    // new ProjectValidators should be added here for the --suggestions to run
157 158 159 160 161 162 163 164
    allProjectValidators: <ProjectValidator>[
      GeneralInfoProjectValidator(),
      VariableDumpMachineProjectValidator(
        logger: globals.logger,
        fileSystem: globals.fs,
        platform: globals.platform,
      ),
    ],
165
    suppressAnalytics: globals.flutterUsage.suppressAnalytics,
166
  ),
167
  AssembleCommand(verboseHelp: verboseHelp, buildSystem: globals.buildSystem),
168 169 170 171 172 173 174 175 176 177
  AttachCommand(
    verboseHelp: verboseHelp,
    stdio: globals.stdio,
    logger: globals.logger,
    terminal: globals.terminal,
    signals: globals.signals,
    platform: globals.platform,
    processInfo: globals.processInfo,
    fileSystem: globals.fs,
  ),
178
  BuildCommand(
179
    artifacts: globals.artifacts!,
180 181 182
    fileSystem: globals.fs,
    buildSystem: globals.buildSystem,
    osUtils: globals.os,
183
    processUtils: globals.processUtils,
184 185
    verboseHelp: verboseHelp,
    androidSdk: globals.androidSdk,
186
    logger: globals.logger,
187
  ),
188 189 190
  ChannelCommand(verboseHelp: verboseHelp),
  CleanCommand(verbose: verbose),
  ConfigCommand(verboseHelp: verboseHelp),
191 192 193 194 195 196 197 198 199 200
  CustomDevicesCommand(
    customDevicesConfig: globals.customDevicesConfig,
    operatingSystemUtils: globals.os,
    terminal: globals.terminal,
    platform: globals.platform,
    featureFlags: featureFlags,
    processManager: globals.processManager,
    fileSystem: globals.fs,
    logger: globals.logger
  ),
201 202
  CreateCommand(verboseHelp: verboseHelp),
  DaemonCommand(hidden: !verboseHelp),
203
  DebugAdapterCommand(verboseHelp: verboseHelp),
204 205
  DevicesCommand(verboseHelp: verboseHelp),
  DoctorCommand(verbose: verbose),
206
  DowngradeCommand(verboseHelp: verboseHelp, logger: globals.logger),
207 208 209
  DriveCommand(verboseHelp: verboseHelp,
    fileSystem: globals.fs,
    logger: globals.logger,
210
    platform: globals.platform,
211
    signals: globals.signals,
212 213 214 215 216 217
  ),
  EmulatorsCommand(),
  GenerateCommand(),
  GenerateLocalizationsCommand(
    fileSystem: globals.fs,
    logger: globals.logger,
218 219
    artifacts: globals.artifacts!,
    processManager: globals.processManager,
220
  ),
221 222 223
  InstallCommand(
    verboseHelp: verboseHelp,
  ),
224 225 226 227
  LogsCommand(
    sigint: ProcessSignal.sigint,
    sigterm: ProcessSignal.sigterm,
  ),
228 229 230 231 232 233 234 235 236 237
  MakeHostAppEditableCommand(),
  PackagesCommand(),
  PrecacheCommand(
    verboseHelp: verboseHelp,
    cache: globals.cache,
    logger: globals.logger,
    platform: globals.platform,
    featureFlags: featureFlags,
  ),
  RunCommand(verboseHelp: verboseHelp),
238
  ScreenshotCommand(fs: globals.fs),
239
  ShellCompletionCommand(),
240
  TestCommand(verboseHelp: verboseHelp, verbose: verbose),
241 242 243 244 245 246 247 248 249 250
  UpgradeCommand(verboseHelp: verboseHelp),
  SymbolizeCommand(
    stdio: globals.stdio,
    fileSystem: globals.fs,
  ),
  // Development-only commands. These are always hidden,
  IdeConfigCommand(),
  UpdatePackagesCommand(),
];

251 252 253 254 255
/// An abstraction for instantiation of the correct logger type.
///
/// Our logger class hierarchy and runtime requirements are overly complicated.
class LoggerFactory {
  LoggerFactory({
256 257 258
    required Terminal terminal,
    required Stdio stdio,
    required OutputPreferences outputPreferences,
259 260 261 262 263 264 265 266 267 268 269 270 271
    StopwatchFactory stopwatchFactory = const StopwatchFactory(),
  }) : _terminal = terminal,
       _stdio = stdio,
       _stopwatchFactory = stopwatchFactory,
       _outputPreferences = outputPreferences;

  final Terminal _terminal;
  final Stdio _stdio;
  final StopwatchFactory _stopwatchFactory;
  final OutputPreferences _outputPreferences;

  /// Create the appropriate logger for the current platform and configuration.
  Logger createLogger({
272 273 274 275 276
    required bool verbose,
    required bool prefixedErrors,
    required bool machine,
    required bool daemon,
    required bool windows,
277 278 279 280 281 282 283 284 285 286 287 288 289 290
  }) {
    Logger logger;
    if (windows) {
      logger = WindowsStdoutLogger(
        terminal: _terminal,
        stdio: _stdio,
        outputPreferences: _outputPreferences,
        stopwatchFactory: _stopwatchFactory,
      );
    } else {
      logger = StdoutLogger(
        terminal: _terminal,
        stdio: _stdio,
        outputPreferences: _outputPreferences,
291
        stopwatchFactory: _stopwatchFactory
292 293 294 295 296
      );
    }
    if (verbose) {
      logger = VerboseLogger(logger, stopwatchFactory: _stopwatchFactory);
    }
297 298 299
    if (prefixedErrors) {
      logger = PrefixedErrorLogger(logger);
    }
300 301 302
    if (daemon) {
      return NotifyingLogger(verbose: verbose, parent: logger);
    }
303
    if (machine) {
304 305 306 307 308
      return AppRunLogger(parent: logger);
    }
    return logger;
  }
}