Skip to content
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.

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

Remove some methods and method parameters from ToolEnvironment. #1316

Merged
merged 1 commit into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
- Renamed `runProc` -> `runConstrained`.
- Removed `ProcessOutput.asBytes`.
- `ToolException` has reference to the entire `PanaProcessResult`, instead of just the `stderr`.
- `ToolEnvironment` does not expose `environment`.
- `ToolEnvironment`:
- removed parameters from `dartdoc()`
- removed `get environment`, `detectFlutterUse()` and `getFlutterVersion()`

## 0.21.45

Expand Down
1 change: 0 additions & 1 deletion lib/src/package_context.dart
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,6 @@ class PackageContext {
final pr = await toolEnvironment.dartdoc(
packageDir,
dartdocOutputDir,
validateLinks: false,
timeout: timeout,
usesFlutter: usesFlutter,
);
Expand Down
48 changes: 9 additions & 39 deletions lib/src/sdk_env.dart
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import 'logging.dart';
import 'model.dart' show PanaRuntimeInfo;
import 'package_analyzer.dart' show InspectOptions;
import 'pana_cache.dart';
import 'pubspec_io.dart';
import 'tool/run_constrained.dart';
import 'utils.dart';
import 'version.dart';
Expand Down Expand Up @@ -76,7 +75,7 @@ class ToolEnvironment {
final dartSdkInfo = DartSdkInfo.parse(dartVersionResult.asJoinedOutput);
Map<String, dynamic>? flutterVersions;
try {
flutterVersions = await getFlutterVersion();
flutterVersions = await _getFlutterVersion();
} catch (e) {
log.warning('Unable to detect Flutter version.', e);
}
Expand Down Expand Up @@ -257,7 +256,7 @@ class ToolEnvironment {
return files.toList()..sort();
}

Future<Map<String, dynamic>> getFlutterVersion() async {
Future<Map<String, dynamic>> _getFlutterVersion() async {
final result = await runConstrained(
[..._flutterSdk.flutterCmd, '--version', '--machine'],
throwOnError: true,
Expand All @@ -275,16 +274,6 @@ class ToolEnvironment {
});
}

Future<bool> detectFlutterUse(String packageDir) async {
try {
final pubspec = pubspecFromDir(packageDir);
return pubspec.usesFlutter;
} catch (e, st) {
log.info('Unable to read pubspec.yaml', e, st);
}
return false;
}

Future<PanaProcessResult> runUpgrade(
String packageDir,
bool usesFlutter, {
Expand Down Expand Up @@ -409,15 +398,12 @@ class ToolEnvironment {
Future<PanaProcessResult> dartdoc(
String packageDir,
String outputDir, {
String? hostedUrl,
String? canonicalPrefix,
bool validateLinks = true,
bool linkToRemote = false,
Duration? timeout,
List<String>? excludedLibs,
required bool usesFlutter,
}) async {
PanaProcessResult pr;
final sdkDir =
usesFlutter ? _flutterSdk._dartSdk._baseDir : _dartSdk._baseDir;

final args = [
'--output',
outputDir,
Expand All @@ -426,27 +412,11 @@ class ToolEnvironment {
'$_defaultMaxFileCount',
'--max-total-size',
'$_defaultMaxTotalLengthBytes',
'--no-validate-links',
if (sdkDir != null) ...['--sdk-dir', sdkDir],
];
if (excludedLibs != null && excludedLibs.isNotEmpty) {
args.addAll(['--exclude', excludedLibs.join(',')]);
}
if (hostedUrl != null) {
args.addAll(['--hosted-url', hostedUrl]);
}
if (canonicalPrefix != null) {
args.addAll(['--rel-canonical-prefix', canonicalPrefix]);
}
if (!validateLinks) {
args.add('--no-validate-links');
}
if (linkToRemote) {
args.add('--link-to-remote');
}
final sdkDir =
usesFlutter ? _flutterSdk._dartSdk._baseDir : _dartSdk._baseDir;
if (sdkDir != null) {
args.addAll(['--sdk-dir', sdkDir]);
}

PanaProcessResult pr;

if (_useGlobalDartdoc) {
if (!_globalDartdocActivated) {
Expand Down