Skip to content

Add flutter pub package support and --link-to-remote to grinder #2130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 21, 2020
Merged

Add flutter pub package support and --link-to-remote to grinder #2130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
675b27c
Add flutter support and --link-to-remote to grinder
jcollins-g Jan 15, 2020
569db8d
Merge branch 'master' into grind-support-flutter-packages
jcollins-g Jan 16, 2020
9c8f496
Add dependency check for requires-flutter
jcollins-g Jan 16, 2020
65426d6
Merge branch 'master' into grind-support-flutter-packages
jcollins-g Jan 17, 2020
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
3 changes: 2 additions & 1 deletion lib/src/package_meta.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,8 @@ class _FilePackageMeta extends PackageMeta {

@override
bool get requiresFlutter =>
_pubspec['environment']?.containsKey('flutter') == true;
_pubspec['environment']?.containsKey('flutter') == true ||
_pubspec['dependencies']?.containsKey('flutter') == true;

@override
FileContents getReadmeContents() {
Expand Down
43 changes: 32 additions & 11 deletions tool/grind.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import 'dart:async';
import 'dart:io' hide ProcessException;

import 'package:dartdoc/src/io_utils.dart';
import 'package:dartdoc/src/package_meta.dart';
import 'package:grinder/grinder.dart';
import 'package:io/io.dart';
import 'package:path/path.dart' as path;
Expand Down Expand Up @@ -759,17 +760,37 @@ Future<String> _buildPubPackageDocs(
Directory(path.join(env['PUB_CACHE'], 'hosted', 'pub.dartlang.org'));
Directory pubPackageDir =
cache.listSync().firstWhere((e) => e.path.contains(pubPackageName));
await launcher.runStreamed('pub', ['get'],
workingDirectory: pubPackageDir.absolute.path);
await launcher.runStreamed(
Platform.resolvedExecutable,
[
'--enable-asserts',
path.join(Directory.current.absolute.path, 'bin', 'dartdoc.dart'),
'--json',
'--show-progress',
]..addAll(dartdocParameters),
workingDirectory: pubPackageDir.absolute.path);
if (PackageMeta.fromDir(pubPackageDir).requiresFlutter) {
FlutterRepo flutterRepo =
await FlutterRepo.fromExistingFlutterRepo(await cleanFlutterRepo);
await launcher.runStreamed(flutterRepo.cachePub, ['get'],
environment: flutterRepo.env,
workingDirectory: pubPackageDir.absolute.path);
await launcher.runStreamed(
flutterRepo.cacheDart,
[
'--enable-asserts',
path.join(Directory.current.absolute.path, 'bin', 'dartdoc.dart'),
'--json',
'--link-to-remote',
'--show-progress',
]..addAll(dartdocParameters),
environment: flutterRepo.env,
workingDirectory: pubPackageDir.absolute.path);
} else {
await launcher.runStreamed('pub', ['get'],
workingDirectory: pubPackageDir.absolute.path);
await launcher.runStreamed(
Platform.resolvedExecutable,
[
'--enable-asserts',
path.join(Directory.current.absolute.path, 'bin', 'dartdoc.dart'),
'--json',
'--link-to-remote',
'--show-progress',
]..addAll(dartdocParameters),
workingDirectory: pubPackageDir.absolute.path);
}
return path.join(pubPackageDir.absolute.path, 'doc', 'api');
}

Expand Down