From 556ed220222d254950de29dd8193a169cbfc46a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20So=C3=B3s?= Date: Tue, 16 Jan 2024 14:52:33 +0100 Subject: [PATCH] Remove some methods and method parameters from ToolEnvironment. (#1316) --- CHANGELOG.md | 4 ++- lib/src/package_context.dart | 1 - lib/src/sdk_env.dart | 48 +++++++----------------------------- 3 files changed, 12 insertions(+), 41 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c76f70c5..1e8276832 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/lib/src/package_context.dart b/lib/src/package_context.dart index 093f76e11..1bc9f0308 100644 --- a/lib/src/package_context.dart +++ b/lib/src/package_context.dart @@ -241,7 +241,6 @@ class PackageContext { final pr = await toolEnvironment.dartdoc( packageDir, dartdocOutputDir, - validateLinks: false, timeout: timeout, usesFlutter: usesFlutter, ); diff --git a/lib/src/sdk_env.dart b/lib/src/sdk_env.dart index d08f1a29f..db45f1e48 100644 --- a/lib/src/sdk_env.dart +++ b/lib/src/sdk_env.dart @@ -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'; @@ -76,7 +75,7 @@ class ToolEnvironment { final dartSdkInfo = DartSdkInfo.parse(dartVersionResult.asJoinedOutput); Map? flutterVersions; try { - flutterVersions = await getFlutterVersion(); + flutterVersions = await _getFlutterVersion(); } catch (e) { log.warning('Unable to detect Flutter version.', e); } @@ -257,7 +256,7 @@ class ToolEnvironment { return files.toList()..sort(); } - Future> getFlutterVersion() async { + Future> _getFlutterVersion() async { final result = await runConstrained( [..._flutterSdk.flutterCmd, '--version', '--machine'], throwOnError: true, @@ -275,16 +274,6 @@ class ToolEnvironment { }); } - Future 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 runUpgrade( String packageDir, bool usesFlutter, { @@ -409,15 +398,12 @@ class ToolEnvironment { Future dartdoc( String packageDir, String outputDir, { - String? hostedUrl, - String? canonicalPrefix, - bool validateLinks = true, - bool linkToRemote = false, Duration? timeout, - List? excludedLibs, required bool usesFlutter, }) async { - PanaProcessResult pr; + final sdkDir = + usesFlutter ? _flutterSdk._dartSdk._baseDir : _dartSdk._baseDir; + final args = [ '--output', outputDir, @@ -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) {