feat: add command/bootstrap/runPubGetInParallel melos.yaml option (…

…#285)
invertase · Apr 28, 2022 · f48e8f1 · f48e8f1
1 parent 1fdff16
commit f48e8f1
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 4 deletions.
diff --git a/docs/configuration/overview.mdx b/docs/configuration/overview.mdx
@@ -81,6 +81,12 @@ Whether to use `pubspec_overrides.yaml` for overriding workspace dependencies du
 
 Enabling this option requires Dart **2.17.0** or greater.
 
+### `command/bootstrap/runPubGetInParallel`
+
+Whether to run `pub get` in parallel during bootstrapping.
+
+The default is `true`.
+
 ### `command/version/message`
 
 A template for the commit message, that is generated by `melos version`.

diff --git a/packages/melos/lib/src/commands/bootstrap.dart b/packages/melos/lib/src/commands/bootstrap.dart
@@ -87,7 +87,10 @@ mixin _BootstrapMixin on _CleanMixin {
     └> ${AnsiStyles.blue(printablePath(package.pathRelativeToWorkspace))}''',
         );
       },
-      parallelism: canRunPubGetConcurrently ? null : 1,
+      parallelism: workspace.config.commands.bootstrap.runPubGetInParallel &&
+              canRunPubGetConcurrently
+          ? null
+          : 1,
     ).drain<void>();
   }
 
@@ -163,7 +166,10 @@ mixin _BootstrapMixin on _CleanMixin {
           );
           return package;
         },
-        parallelism: canRunPubGetConcurrently ? null : 1,
+        parallelism: workspace.config.commands.bootstrap.runPubGetInParallel &&
+                canRunPubGetConcurrently
+            ? null
+            : 1,
       );
 
   Future<void> _runPubGetForPackage(

diff --git a/packages/melos/lib/src/workspace_configs.dart b/packages/melos/lib/src/workspace_configs.dart
@@ -180,6 +180,7 @@ CommandConfigs(
 class BootstrapCommandConfigs {
   const BootstrapCommandConfigs({
     this.usePubspecOverrides = false,
+    this.runPubGetInParallel = true,
   });
 
   factory BootstrapCommandConfigs.fromYaml(Map<Object?, Object?> yaml) {
@@ -190,8 +191,16 @@ class BootstrapCommandConfigs {
         ) ??
         false;
 
+    final runPubGetInParallel = assertKeyIsA<bool?>(
+          key: 'runPubGetInParallel',
+          map: yaml,
+          path: 'command/bootstrap',
+        ) ??
+        true;
+
     return BootstrapCommandConfigs(
       usePubspecOverrides: usePubspecOverrides,
+      runPubGetInParallel: runPubGetInParallel,
     );
   }
 
@@ -201,26 +210,37 @@ class BootstrapCommandConfigs {
   /// dependencies during development.
   final bool usePubspecOverrides;
 
+  /// Whether to run `pub get` in parallel during bootstrapping.
+  ///
+  /// The default is `true`.
+  final bool runPubGetInParallel;
+
   Map<String, Object?> toJson() {
     return {
       'usePubspecOverrides': usePubspecOverrides,
+      'runPubGetInParallel': runPubGetInParallel,
     };
   }
 
   @override
   bool operator ==(Object other) =>
       other is BootstrapCommandConfigs &&
       runtimeType == other.runtimeType &&
-      other.usePubspecOverrides == usePubspecOverrides;
+      other.usePubspecOverrides == usePubspecOverrides &&
+      other.runPubGetInParallel == runPubGetInParallel;
 
   @override
-  int get hashCode => runtimeType.hashCode ^ usePubspecOverrides.hashCode;
+  int get hashCode =>
+      runtimeType.hashCode ^
+      usePubspecOverrides.hashCode ^
+      runPubGetInParallel.hashCode;
 
   @override
   String toString() {
     return '''
 BootstrapCommandConfigs(
   usePubspecOverrides: $usePubspecOverrides,
+  runPubGetInParallel: $runPubGetInParallel,
 )''';
   }
 }

diff --git a/packages/melos/test/workspace_config_test.dart b/packages/melos/test/workspace_config_test.dart
@@ -30,6 +30,13 @@ void main() {
       expect(value.usePubspecOverrides, false);
     });
 
+    test('runPubGetInParallel is optional', () {
+      // ignore: use_named_constants
+      const value = BootstrapCommandConfigs();
+
+      expect(value.runPubGetInParallel, true);
+    });
+
     group('fromYaml', () {
       test('accepts empty object', () {
         expect(
@@ -47,15 +54,26 @@ void main() {
         );
       });
 
+      test('throws if runPubGetInParallel is not a bool', () {
+        expect(
+          () => BootstrapCommandConfigs.fromYaml(const {
+            'runPubGetInParallel': 42,
+          }),
+          throwsMelosConfigException(),
+        );
+      });
+
       test('can decode values', () {
         expect(
           BootstrapCommandConfigs.fromYaml(
             const {
               'usePubspecOverrides': true,
+              'runPubGetInParallel': false,
             },
           ),
           const BootstrapCommandConfigs(
             usePubspecOverrides: true,
+            runPubGetInParallel: false,
           ),
         );
       });