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

import 'dart:convert';
import 'dart:io';

8
import 'package:args/args.dart';
9
import 'package:intl/intl.dart';
10
import 'package:meta/meta.dart';
11
import 'package:path/path.dart' as path;
12
import 'package:platform/platform.dart';
13
import 'package:process/process.dart';
14

15 16
import 'dartdoc_checker.dart';

17 18
const String kDocsRoot = 'dev/docs';
const String kPublishRoot = '$kDocsRoot/doc';
Seth Ladd's avatar
Seth Ladd committed
19

20 21 22
const String kDummyPackageName = 'Flutter';
const String kPlatformIntegrationPackageName = 'platform_integration';

23 24 25
/// This script expects to run with the cwd as the root of the flutter repo. It
/// will generate documentation for the packages in `//packages/` and write the
/// documentation to `//dev/docs/doc/api/`.
26
///
Seth Ladd's avatar
Seth Ladd committed
27
/// This script also updates the index.html file so that it can be placed
28 29
/// at the root of api.flutter.dev. We are keeping the files inside of
/// api.flutter.dev/flutter for now, so we need to manipulate paths
Seth Ladd's avatar
Seth Ladd committed
30
/// a bit. See https://github.com/flutter/flutter/issues/3900 for more info.
31 32 33 34 35
///
/// This will only work on UNIX systems, not Windows. It requires that 'git' be
/// in your path. It requires that 'flutter' has been run previously. It uses
/// the version of Dart downloaded by the 'flutter' tool in this repository and
/// will crash if that is absent.
36
Future<void> main(List<String> arguments) async {
37 38
  final ArgParser argParser = _createArgsParser();
  final ArgResults args = argParser.parse(arguments);
39
  if (args['help'] as bool) {
40 41 42 43
    print ('Usage:');
    print (argParser.usage);
    exit(0);
  }
44 45 46 47
  // If we're run from the `tools` dir, set the cwd to the repo root.
  if (path.basename(Directory.current.path) == 'tools')
    Directory.current = Directory.current.parent.parent;

48
  final ProcessResult flutter = Process.runSync('flutter', <String>[]);
49
  final File versionFile = File('version');
50
  if (flutter.exitCode != 0 || !versionFile.existsSync())
51
    throw Exception('Failed to determine Flutter version.');
52
  final String version = versionFile.readAsStringSync();
53

54
  // Create the pubspec.yaml file.
55
  final StringBuffer buf = StringBuffer();
56
  buf.writeln('name: $kDummyPackageName');
57
  buf.writeln('homepage: https://flutter.dev');
58
  buf.writeln('version: 0.0.0');
59 60
  buf.writeln('environment:');
  buf.writeln("  sdk: '>=2.10.0 <3.0.0'");
61
  buf.writeln('dependencies:');
62
  for (final String package in findPackageNames()) {
63
    buf.writeln('  $package:');
64
    buf.writeln('    sdk: flutter');
65
  }
66
  buf.writeln('  $kPlatformIntegrationPackageName: 0.0.1');
67
  buf.writeln('dependency_overrides:');
68 69
  buf.writeln('  $kPlatformIntegrationPackageName:');
  buf.writeln('    path: $kPlatformIntegrationPackageName');
70
  File('$kDocsRoot/pubspec.yaml').writeAsStringSync(buf.toString());
71 72

  // Create the library file.
73
  final Directory libDir = Directory('$kDocsRoot/lib');
74 75
  libDir.createSync();

76
  final StringBuffer contents = StringBuffer('library temp_doc;\n\n');
77
  for (final String libraryRef in libraryRefs()) {
78
    contents.writeln("import 'package:$libraryRef';");
79
  }
80
  File('$kDocsRoot/lib/temp_doc.dart').writeAsStringSync(contents.toString());
81

82 83 84 85 86 87 88
  final String flutterRoot = Directory.current.path;
  final Map<String, String> pubEnvironment = <String, String>{
    'FLUTTER_ROOT': flutterRoot,
  };

  // If there's a .pub-cache dir in the flutter root, use that.
  final String pubCachePath = '$flutterRoot/.pub-cache';
89
  if (Directory(pubCachePath).existsSync()) {
90 91 92
    pubEnvironment['PUB_CACHE'] = pubCachePath;
  }

93
  final String dartExecutable = '$flutterRoot/bin/cache/dart-sdk/bin/dart';
94

95
  // Run pub.
96 97 98
  ProcessWrapper process = ProcessWrapper(await runPubProcess(
    dartBinaryPath: dartExecutable,
    arguments: <String>['get'],
99
    workingDirectory: kDocsRoot,
100
    environment: pubEnvironment,
101
  ));
102 103
  printStream(process.stdout, prefix: 'pub:stdout: ');
  printStream(process.stderr, prefix: 'pub:stderr: ');
104
  final int code = await process.done;
105 106 107
  if (code != 0)
    exit(code);

108
  createFooter('$kDocsRoot/lib/', version);
109
  copyAssets();
110
  createSearchMetadata('$kDocsRoot/lib/opensearch.xml', '$kDocsRoot/doc/opensearch.xml');
111
  cleanOutSnippets();
112

113 114 115
  final List<String> dartdocBaseArgs = <String>[
    'global',
    'run',
116
    if (args['checked'] as bool) '-c',
117 118
    'dartdoc',
  ];
119

120 121
  // Verify which version of snippets and dartdoc we're using.
  final ProcessResult snippetsResult = Process.runSync(
122
    dartExecutable,
123
    <String>[
124
      'pub',
125 126 127
      'global',
      'list',
    ],
128
    workingDirectory: kDocsRoot,
129
    environment: pubEnvironment,
130
    stdoutEncoding: utf8,
131
  );
132 133 134 135 136 137 138 139
  print('');
  final Iterable<RegExpMatch> versionMatches = RegExp(r'^(?<name>snippets|dartdoc) (?<version>[^\s]+)', multiLine: true)
      .allMatches(snippetsResult.stdout as String);
  for (final RegExpMatch match in versionMatches) {
    print('${match.namedGroup('name')} version: ${match.namedGroup('version')}');
  }

  print('flutter version: $version\n');
140

141 142 143 144 145 146 147
  // Dartdoc warnings and errors in these packages are considered fatal.
  // All packages owned by flutter should be in the list.
  // TODO(goderbauer): Figure out how to add 'dart:ui'.
  final List<String> flutterPackages = <String>[
    kDummyPackageName,
    kPlatformIntegrationPackageName,
    ...findPackageNames(),
148
  ];
149

150
  // Generate the documentation.
151 152
  // We don't need to exclude flutter_tools in this list because it's not in the
  // recursive dependencies of the package defined at dev/docs/pubspec.yaml
153 154
  final List<String> dartdocArgs = <String>[
    ...dartdocBaseArgs,
155
    '--allow-tools',
156 157
    if (args['json'] as bool) '--json',
    if (args['validate-links'] as bool) '--validate-links' else '--no-validate-links',
158 159 160
    '--link-to-source-excludes', '../../bin/cache',
    '--link-to-source-root', '../..',
    '--link-to-source-uri-template', 'https://github.com/flutter/flutter/blob/master/%f%#L%l%',
161
    '--inject-html',
162
    '--use-base-href',
163 164
    '--header', 'styles.html',
    '--header', 'analytics.html',
165
    '--header', 'survey.html',
166
    '--header', 'snippets.html',
167
    '--header', 'opensearch.html',
168
    '--footer-text', 'lib/footer.html',
169
    '--allow-warnings-in-packages', flutterPackages.join(','),
170
    '--exclude-packages',
171 172 173 174 175 176
    <String>[
      'analyzer',
      'args',
      'barback',
      'csslib',
      'flutter_goldens',
177
      'flutter_goldens_client',
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
      'front_end',
      'fuchsia_remote_debug_protocol',
      'glob',
      'html',
      'http_multi_server',
      'io',
      'isolate',
      'js',
      'kernel',
      'logging',
      'mime',
      'mockito',
      'node_preamble',
      'plugin',
      'shelf',
      'shelf_packages_handler',
      'shelf_static',
      'shelf_web_socket',
      'utf',
      'watcher',
      'yaml',
    ].join(','),
200
    '--exclude',
201
    <String>[
202
      'dart:io/network_policy.dart', // dart-lang/dartdoc#2437
203 204 205 206 207 208 209 210 211
      'package:Flutter/temp_doc.dart',
      'package:http/browser_client.dart',
      'package:intl/intl_browser.dart',
      'package:matcher/mirror_matchers.dart',
      'package:quiver/io.dart',
      'package:quiver/mirrors.dart',
      'package:vm_service_client/vm_service_client.dart',
      'package:web_socket_channel/html.dart',
    ].join(','),
212
    '--favicon=favicon.ico',
213
    '--package-order', 'flutter,Dart,$kPlatformIntegrationPackageName,flutter_test,flutter_driver',
214
    '--auto-include-dependencies',
215
  ];
216

217
  String quote(String arg) => arg.contains(' ') ? "'$arg'" : arg;
218
  print('Executing: (cd $kDocsRoot ; $dartExecutable ${dartdocArgs.map<String>(quote).join(' ')})');
219

220 221 222
  process = ProcessWrapper(await runPubProcess(
    dartBinaryPath: dartExecutable,
    arguments: dartdocArgs,
223
    workingDirectory: kDocsRoot,
224
    environment: pubEnvironment,
225
  ));
226 227
  printStream(process.stdout, prefix: args['json'] as bool ? '' : 'dartdoc:stdout: ',
    filter: args['verbose'] as bool ? const <Pattern>[] : <Pattern>[
228 229
      RegExp(r'^generating docs for library '), // unnecessary verbosity
      RegExp(r'^pars'), // unnecessary verbosity
230 231
    ],
  );
232 233
  printStream(process.stderr, prefix: args['json'] as bool ? '' : 'dartdoc:stderr: ',
    filter: args['verbose'] as bool ? const <Pattern>[] : <Pattern>[
234
      RegExp(r'^ warning: .+: \(.+/\.pub-cache/hosted/pub.dartlang.org/.+\)'), // packages outside our control
235 236
    ],
  );
237
  final int exitCode = await process.done;
Seth Ladd's avatar
Seth Ladd committed
238 239 240 241

  if (exitCode != 0)
    exit(exitCode);

242
  sanityCheckDocs();
243
  checkForUnresolvedDirectives('$kPublishRoot/api');
244

Seth Ladd's avatar
Seth Ladd committed
245 246 247
  createIndexAndCleanup();
}

248
ArgParser _createArgsParser() {
249
  final ArgParser parser = ArgParser();
250 251
  parser.addFlag('help', abbr: 'h', negatable: false,
      help: 'Show command help.');
252
  parser.addFlag('verbose', defaultsTo: true,
253 254 255
      help: 'Whether to report all error messages (on) or attempt to '
          'filter out some known false positives (off).  Shut this off '
          'locally if you want to address Flutter-specific issues.');
256
  parser.addFlag('checked', abbr: 'c',
257
      help: 'Run dartdoc in checked mode.');
258
  parser.addFlag('json',
259
      help: 'Display json-formatted output from dartdoc and skip stdout/stderr prefixing.');
260
  parser.addFlag('validate-links',
261
      help: 'Display warnings for broken links generated by dartdoc (slow)');
262 263 264
  return parser;
}

265
final RegExp gitBranchRegexp = RegExp(r'^## (.*)');
266

267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
/// Get the name of the release branch.
///
/// On LUCI builds, the git HEAD is detached, so first check for the env
/// variable "LUCI_BRANCH"; if it is not set, fall back to calling git.
String getBranchName({
  @visibleForTesting
  Platform platform = const LocalPlatform(),
  @visibleForTesting
  ProcessManager processManager = const LocalProcessManager(),
}) {
  final String? luciBranch = platform.environment['LUCI_BRANCH'];
  if (luciBranch != null && luciBranch.trim().isNotEmpty) {
    return luciBranch.trim();
  }
  final ProcessResult gitResult = processManager.runSync(<String>['git', 'status', '-b', '--porcelain']);
282 283
  if (gitResult.exitCode != 0)
    throw 'git status exit with non-zero exit code: ${gitResult.exitCode}';
284
  final RegExpMatch? gitBranchMatch = gitBranchRegexp.firstMatch(
285
      (gitResult.stdout as String).trim().split('\n').first);
286
  return gitBranchMatch == null ? '' : gitBranchMatch.group(1)!.split('...').first;
287 288
}

289
String gitRevision() {
290 291
  const int kGitRevisionLength = 10;

292
  final ProcessResult gitResult = Process.runSync('git', <String>['rev-parse', 'HEAD']);
293
  if (gitResult.exitCode != 0)
294
    throw 'git rev-parse exit with non-zero exit code: ${gitResult.exitCode}';
295
  final String gitRevision = (gitResult.stdout as String).trim();
296

297 298
  return gitRevision.length > kGitRevisionLength ? gitRevision.substring(0, kGitRevisionLength) : gitRevision;
}
299

300
void createFooter(String footerPath, String version) {
301
  final String timestamp = DateFormat('yyyy-MM-dd HH:mm').format(DateTime.now());
302
  final String gitBranch = getBranchName();
303 304 305 306
  final String gitBranchOut = gitBranch.isEmpty ? '' : '• $gitBranch';
  File('${footerPath}footer.html').writeAsStringSync('<script src="footer.js"></script>');
  File('$kPublishRoot/api/footer.js')
    ..createSync(recursive: true)
307 308
    ..writeAsStringSync('''
(function() {
Dan Field's avatar
Dan Field committed
309 310 311 312 313 314 315 316 317
  var span = document.querySelector('footer>span');
  if (span) {
    span.innerText = 'Flutter $version  $timestamp  ${gitRevision()} $gitBranchOut';
  }
  var sourceLink = document.querySelector('a.source-link');
  if (sourceLink) {
    sourceLink.href = sourceLink.href.replace('/master/', '/${gitRevision()}/');
  }
})();
318
''');
319 320
}

321 322 323 324 325 326 327 328 329
/// Generates an OpenSearch XML description that can be used to add a custom
/// search for Flutter API docs to the browser. Unfortunately, it has to know
/// the URL to which site to search, so we customize it here based upon the
/// branch name.
void createSearchMetadata(String templatePath, String metadataPath) {
  final String template = File(templatePath).readAsStringSync();
  final String branch = getBranchName();
  final String metadata = template.replaceAll(
    '{SITE_URL}',
330
    branch == 'stable' ? 'https://api.flutter.dev/' : 'https://master-api.flutter.dev/',
331 332 333 334 335
  );
  Directory(path.dirname(metadataPath)).create(recursive: true);
  File(metadataPath).writeAsStringSync(metadata);
}

336 337 338 339
/// Recursively copies `srcDir` to `destDir`, invoking [onFileCopied], if
/// specified, for each source/destination file pair.
///
/// Creates `destDir` if needed.
340
void copyDirectorySync(Directory srcDir, Directory destDir, [void Function(File srcFile, File destFile)? onFileCopied]) {
341 342 343 344 345 346
  if (!srcDir.existsSync())
    throw Exception('Source directory "${srcDir.path}" does not exist, nothing to copy');

  if (!destDir.existsSync())
    destDir.createSync(recursive: true);

347
  for (final FileSystemEntity entity in srcDir.listSync()) {
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
    final String newPath = path.join(destDir.path, path.basename(entity.path));
    if (entity is File) {
      final File newFile = File(newPath);
      entity.copySync(newPath);
      onFileCopied?.call(entity, newFile);
    } else if (entity is Directory) {
      copyDirectorySync(entity, Directory(newPath));
    } else {
      throw Exception('${entity.path} is neither File nor Directory');
    }
  }
}

void copyAssets() {
  final Directory assetsDir = Directory(path.join(kPublishRoot, 'assets'));
  if (assetsDir.existsSync()) {
    assetsDir.deleteSync(recursive: true);
  }
  copyDirectorySync(
      Directory(path.join(kDocsRoot, 'assets')),
      Directory(path.join(kPublishRoot, 'assets')),
          (File src, File dest) => print('Copied ${src.path} to ${dest.path}'));
}

372 373
/// Clean out any existing snippets so that we don't publish old files from
/// previous runs accidentally.
374 375 376 377 378 379 380 381 382
void cleanOutSnippets() {
  final Directory snippetsDir = Directory(path.join(kPublishRoot, 'snippets'));
  if (snippetsDir.existsSync()) {
    snippetsDir
      ..deleteSync(recursive: true)
      ..createSync(recursive: true);
  }
}

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
void _sanityCheckExample(File file, RegExp regExp) {
  if (file.existsSync()) {
    final List<String> contents = file.readAsLinesSync();
    bool found = false;
    for (final String line in contents) {
      if (regExp.matchAsPrefix(line) != null) {
        found = true;
        break;
      }
    }
    if (!found) {
      throw Exception("Missing example code in ${file.path}. Either it didn't get published, publishing has changed, or the example no longer exists.");
    }
  } else {
    throw Exception("Missing example code sanity test file ${file.path}. Either it didn't get published, or you might have to update the test to look at a different file.");
  }
}

/// Runs a sanity check by running a test.
402
void sanityCheckDocs() {
403
  final List<String> canaries = <String>[
404 405 406 407 408 409 410 411 412
    '$kPublishRoot/assets/overrides.css',
    '$kPublishRoot/api/dart-io/File-class.html',
    '$kPublishRoot/api/dart-ui/Canvas-class.html',
    '$kPublishRoot/api/dart-ui/Canvas/drawRect.html',
    '$kPublishRoot/api/flutter_driver/FlutterDriver/FlutterDriver.connectedTo.html',
    '$kPublishRoot/api/flutter_test/WidgetTester/pumpWidget.html',
    '$kPublishRoot/api/material/Material-class.html',
    '$kPublishRoot/api/material/Tooltip-class.html',
    '$kPublishRoot/api/widgets/Widget-class.html',
413
  ];
414
  for (final String canary in canaries) {
415 416
    if (!File(canary).existsSync())
      throw Exception('Missing "$canary", which probably means the documentation failed to build correctly.');
417
  }
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
  // Make sure at least one example of each kind includes source code.

  // Check a "sample" example, any one will do.
  final File sampleExample = File('$kPublishRoot/api/widgets/showGeneralDialog.html');
  final RegExp sampleRegExp = RegExp(r'\s*<pre id="longSnippet1" class="language-dart">\s*<code class="language-dart">\s*import &#39;package:flutter&#47;material.dart&#39;;');
  _sanityCheckExample(sampleExample, sampleRegExp);

  // Check a "snippet" example, any one will do.
  final File snippetExample = File('$kPublishRoot/api/widgets/ModalRoute/barrierColor.html');
  final RegExp snippetRegExp = RegExp(r'\s*<pre class="language-dart" id="sample-code">.*Color get barrierColor =&gt; Theme\.of\(navigator\.context\)\.backgroundColor;.*</pre>');
  _sanityCheckExample(snippetExample, snippetRegExp);

  // Check a "dartpad" example, any one will do.
  final File dartpadExample = File('$kPublishRoot/api/widgets/PhysicalShape-class.html');
  final RegExp dartpadRegExp = RegExp(r'\s*<iframe class="snippet-dartpad" src="https://dartpad\.dev.*sample_id=widgets\.PhysicalShape\.\d+.*">\s*</iframe>');
  _sanityCheckExample(dartpadExample, dartpadRegExp);
434 435
}

Seth Ladd's avatar
Seth Ladd committed
436 437 438
/// Creates a custom index.html because we try to maintain old
/// paths. Cleanup unused index.html files no longer needed.
void createIndexAndCleanup() {
439
  print('\nCreating a custom index.html in $kPublishRoot/index.html');
440
  removeOldFlutterDocsDir();
Seth Ladd's avatar
Seth Ladd committed
441 442 443
  renameApiDir();
  copyIndexToRootOfDocs();
  addHtmlBaseToIndex();
444
  changePackageToSdkInTitlebar();
Seth Ladd's avatar
Seth Ladd committed
445
  putRedirectInOldIndexLocation();
446
  writeSnippetsIndexFile();
Seth Ladd's avatar
Seth Ladd committed
447 448 449
  print('\nDocs ready to go!');
}

450 451
void removeOldFlutterDocsDir() {
  try {
452
    Directory('$kPublishRoot/flutter').deleteSync(recursive: true);
453
  } on FileSystemException {
454 455 456 457
    // If the directory does not exist, that's OK.
  }
}

Seth Ladd's avatar
Seth Ladd committed
458
void renameApiDir() {
459
  Directory('$kPublishRoot/api').renameSync('$kPublishRoot/flutter');
Seth Ladd's avatar
Seth Ladd committed
460 461
}

462
void copyIndexToRootOfDocs() {
463
  File('$kPublishRoot/flutter/index.html').copySync('$kPublishRoot/index.html');
Seth Ladd's avatar
Seth Ladd committed
464 465
}

466
void changePackageToSdkInTitlebar() {
467
  final File indexFile = File('$kPublishRoot/index.html');
468 469
  String indexContents = indexFile.readAsStringSync();
  indexContents = indexContents.replaceFirst(
470 471
    '<li><a href="https://flutter.dev">Flutter package</a></li>',
    '<li><a href="https://flutter.dev">Flutter SDK</a></li>',
472 473 474 475 476
  );

  indexFile.writeAsStringSync(indexContents);
}

Seth Ladd's avatar
Seth Ladd committed
477
void addHtmlBaseToIndex() {
478
  final File indexFile = File('$kPublishRoot/index.html');
Seth Ladd's avatar
Seth Ladd committed
479
  String indexContents = indexFile.readAsStringSync();
480 481 482 483
  indexContents = indexContents.replaceFirst(
    '</title>\n',
    '</title>\n  <base href="./flutter/">\n',
  );
484 485
  indexContents = indexContents.replaceAll(
    'href="Android/Android-library.html"',
486
    'href="/javadoc/"',
487
  );
488 489
  indexContents = indexContents.replaceAll(
      'href="iOS/iOS-library.html"',
490
      'href="/objcdoc/"',
491 492
  );

Seth Ladd's avatar
Seth Ladd committed
493 494 495 496
  indexFile.writeAsStringSync(indexContents);
}

void putRedirectInOldIndexLocation() {
497
  const String metaTag = '<meta http-equiv="refresh" content="0;URL=../index.html">';
498
  File('$kPublishRoot/flutter/index.html').writeAsStringSync(metaTag);
499 500
}

501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
void writeSnippetsIndexFile() {
  final Directory snippetsDir = Directory(path.join(kPublishRoot, 'snippets'));
  if (snippetsDir.existsSync()) {
    const JsonEncoder jsonEncoder = JsonEncoder.withIndent('    ');
    final Iterable<File> files = snippetsDir
        .listSync()
        .whereType<File>()
        .where((File file) => path.extension(file.path) == '.json');
        // Combine all the metadata into a single JSON array.
    final Iterable<String> fileContents = files.map((File file) => file.readAsStringSync());
    final List<dynamic> metadataObjects = fileContents.map<dynamic>(json.decode).toList();
    final String jsonArray = jsonEncoder.convert(metadataObjects);
    File('$kPublishRoot/snippets/index.json').writeAsStringSync(jsonArray);
  }
}

Seth Ladd's avatar
Seth Ladd committed
517
List<String> findPackageNames() {
518
  return findPackages().map<String>((FileSystemEntity file) => path.basename(file.path)).toList();
519 520
}

521
/// Finds all packages in the Flutter SDK
522
List<Directory> findPackages() {
523
  return Directory('packages')
524
    .listSync()
525 526 527
    .where((FileSystemEntity entity) {
      if (entity is! Directory)
        return false;
528
      final File pubspec = File('${entity.path}/pubspec.yaml');
529 530 531 532
      if (!pubspec.existsSync()) {
        print("Unexpected package '${entity.path}' found in packages directory");
        return false;
      }
533 534
      // TODO(ianh): Use a real YAML parser here
      return !pubspec.readAsStringSync().contains('nodoc: true');
535
    })
536
    .cast<Directory>()
537 538 539
    .toList();
}

540
/// Returns import or on-disk paths for all libraries in the Flutter SDK.
541
Iterable<String> libraryRefs() sync* {
542
  for (final Directory dir in findPackages()) {
543
    final String dirName = path.basename(dir.path);
544
    for (final FileSystemEntity file in Directory('${dir.path}/lib').listSync()) {
545
      if (file is File && file.path.endsWith('.dart')) {
546 547
        yield '$dirName/${path.basename(file.path)}';
      }
548 549
    }
  }
550 551

  // Add a fake package for platform integration APIs.
552 553
  yield '$kPlatformIntegrationPackageName/android.dart';
  yield '$kPlatformIntegrationPackageName/ios.dart';
554 555
}

556
void printStream(Stream<List<int>> stream, { String prefix = '', List<Pattern> filter = const <Pattern>[] }) {
557 558
  assert(prefix != null);
  assert(filter != null);
559
  stream
560 561
    .transform<String>(utf8.decoder)
    .transform<String>(const LineSplitter())
562 563 564 565
    .listen((String line) {
      if (!filter.any((Pattern pattern) => line.contains(pattern)))
        print('$prefix$line'.trim());
    });
566
}
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581

Future<Process> runPubProcess({
  required String dartBinaryPath,
  required List<String> arguments,
  String? workingDirectory,
  Map<String, String>? environment,
  @visibleForTesting
  ProcessManager processManager = const LocalProcessManager(),
}) {
  return processManager.start(
    <Object>[dartBinaryPath, 'pub', ...arguments],
    workingDirectory: workingDirectory,
    environment: environment,
  );
}