Add list command (#384)

Bump min SDK to 2.17

Author: kevmoo

.github/workflows/dart.yml

@@ -1,7 +1,8 @@
 ## 6.3.0-dev
 
 - Update to `subosito/flutter-action@v2.4.0`.
-- Require at least Dart >= 2.16.0
+- Require at least Dart >= 2.17.0
+- Add the `list` command.
 
 ## 6.2.2
 

mono_repo/CHANGELOG.md

@@ -34,6 +34,7 @@ Global options:
 Available commands:
   check       Check the state of the repository.
   generate    Generates the CI configuration for child packages.
+  list        List all packages configured for mono_repo.
   presubmit   Run the CI presubmits locally.
   pub         Runs the `pub` command with the provided arguments across all packages.
 

mono_repo/README.md

@@ -0,0 +1,108 @@
+// Copyright (c) 2022, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'package:pubspec_parse/pubspec_parse.dart';
+
+import '../package_config.dart';
+import '../root_config.dart';
+import 'mono_repo_command.dart';
+
+class ListCommand extends MonoRepoCommand {
+  ListCommand() {
+    argParser
+      ..addFlag(
+        'only-published',
+        abbr: 'p',
+        help: 'Only list packages with a version and without publish_to set to '
+            'none.',
+      )
+      ..addMultiOption(
+        'show',
+        abbr: 's',
+        help:
+            'The properties of the package to show in a comma-seperated list.',
+        allowed: Column.values.map((e) => e.name),
+        allowedHelp: {for (var item in Column.values) item.name: item.help},
+        defaultsTo: Column.values
+            .where((element) => element.defaultsTo)
+            .map((e) => e.name),
+      );
+  }
+
+  @override
+  String get name => 'list';
+
+  @override
+  String get description => 'List all packages configured for mono_repo.';
+
+  @override
+  void run() => print(
+        listPackages(
+          rootConfig(),
+          onlyPublished: argResults!['only-published'] as bool,
+          showItems: (argResults!['show'] as List<String>)
+              .map(
+                (e) =>
+                    Column.values.singleWhere((element) => element.name == e),
+              )
+              .toSet(),
+        ).join('\n'),
+      );
+}
+
+enum Column {
+  name(
+    help: 'The name of the package as specified in the "name" field.',
+    defaultsTo: true,
+  ),
+  path(
+    help: 'The path to the package relative to the root of the repository.',
+    defaultsTo: true,
+  ),
+  version(
+    help: 'The version of the package as specified in the "version" field.',
+    defaultsTo: false,
+  ),
+  publishTo(
+    help: 'The value of the "publish_to" field.',
+    defaultsTo: false,
+  );
+
+  const Column({
+    required this.help,
+    required this.defaultsTo,
+  });
+
+  final String help;
+  final bool defaultsTo;
+
+  String valueFor(PackageConfig cfg) {
+    switch (this) {
+      case Column.name:
+        return cfg.pubspec.name;
+      case Column.path:
+        return cfg.relativePath;
+      case Column.version:
+        return cfg.pubspec.version?.toString() ?? '';
+      case Column.publishTo:
+        return cfg.pubspec.publishTo ?? '';
+    }
+  }
+}
+
+Iterable<String> listPackages(
+  RootConfig rootConfig, {
+  required bool onlyPublished,
+  required Set<Column> showItems,
+}) sync* {
+  for (var pkg in rootConfig) {
+    if (onlyPublished && !_published(pkg.pubspec)) {
+      continue;
+    }
+    yield showItems.map((e) => e.valueFor(pkg)).join(',');
+  }
+}
+
+bool _published(Pubspec pubspec) =>
+    pubspec.version != null && pubspec.publishTo != 'none';

mono_repo/lib/src/commands/list_command.dart

@@ -9,6 +9,7 @@ import 'package:args/command_runner.dart';
 
 import 'commands/check.dart';
 import 'commands/generate.dart';
+import 'commands/list_command.dart';
 import 'commands/mono_repo_command.dart';
 import 'commands/presubmit.dart';
 import 'commands/pub.dart';
@@ -18,6 +19,7 @@ final commands = List<Command<void>>.unmodifiable(
   [
     CheckCommand(),
     GenerateCommand(),
+    ListCommand(),
     PresubmitCommand(),
     PubCommand(),
   ],

mono_repo/lib/src/runner.dart

@@ -10,17 +10,17 @@ stages:
     - analyze: --fatal-infos .
     sdk: dev
   - analyze:
-    sdk: 2.16.0
+    sdk: 2.17.0
 - test:
   - test: -x yaml -P presubmit --test-randomize-ordering-seed=random
     os:
     - linux
     - windows
-    sdk: [2.16.0, dev]
+    sdk: [2.17.0, dev]
   - test: -t yaml --test-randomize-ordering-seed=random
     os:
     - linux
-    sdk: [2.16.0, dev]
+    sdk: [2.17.0, dev]
 
 cache:
   directories:

mono_repo/mono_pkg.yaml

@@ -6,7 +6,7 @@ version: 6.3.0-dev
 repository: https://github.com/google/mono_repo.dart
 
 environment:
-  sdk: '>=2.16.0 <3.0.0'
+  sdk: '>=2.17.0 <3.0.0'
 
 dependencies:
   args: ^2.0.0