feat(create): add create config to very_good.yaml

Add a `create` section to `very_good.yaml` so `very_good create` and its
subcommands can read defaults for `description`, `org_name`, `publishable`,
and `template`. CLI arguments continue to take precedence over config values.

Closes #1654

Author: marcossevilla

.github/workflows/e2e.yaml

@@ -43,6 +43,7 @@ jobs:
           - test/commands/create/flame_game/flame_game_test.dart
           - test/commands/create/flutter_package/flutter_pkg_test.dart
           - test/commands/create/flutter_plugin/flutter_plugin_test.dart
+          - test/commands/create/very_good_config/very_good_config_test.dart
 
           # E2E tests for the `packages check licenses` command
           - test/commands/packages/check/licenses/licenses_allowed_test.dart

e2e/test/commands/create/very_good_config/fixture/very_good.yaml

@@ -0,0 +1,3 @@
+create:
+  description: A project configured via very_good.yaml.
+  publishable: true

e2e/test/commands/create/very_good_config/malformed_fixture/very_good.yaml

@@ -0,0 +1,3 @@
+- not
+- a
+- map

e2e/test/commands/create/very_good_config/very_good_config_test.dart

@@ -0,0 +1,85 @@
+import 'package:mason/mason.dart';
+import 'package:mocktail/mocktail.dart';
+import 'package:path/path.dart' as path;
+import 'package:test/test.dart';
+import 'package:universal_io/io.dart';
+
+import '../../../../helpers/helpers.dart';
+
+void main() {
+  group('very_good.yaml', () {
+    test(
+      'applies create defaults from very_good.yaml when flags are not passed',
+      timeout: const Timeout(Duration(minutes: 2)),
+      withRunner((commandRunner, logger, updater, logs, progressLogs) async {
+        final tempDirectory = Directory.systemTemp.createTempSync(
+          'very_good_config_create',
+        );
+        addTearDown(() => tempDirectory.deleteSync(recursive: true));
+
+        final fixture = Directory(
+          path.join(
+            Directory.current.path,
+            'test/commands/create/very_good_config/fixture',
+          ),
+        );
+
+        await copyDirectory(fixture, tempDirectory);
+
+        final cwd = Directory.current;
+        Directory.current = tempDirectory;
+        addTearDown(() => Directory.current = cwd);
+
+        final result = await commandRunner.run([
+          'create',
+          'dart_package',
+          'very_good_dart',
+        ]);
+        expect(result, equals(ExitCode.success.code));
+
+        final pubspec = File(
+          path.join(tempDirectory.path, 'very_good_dart', 'pubspec.yaml'),
+        );
+        expect(pubspec.existsSync(), isTrue);
+        expect(
+          pubspec.readAsStringSync(),
+          contains('A project configured via very_good.yaml.'),
+        );
+      }),
+    );
+
+    test(
+      'fails with config exit code when very_good.yaml is malformed',
+      timeout: const Timeout(Duration(minutes: 2)),
+      withRunner((commandRunner, logger, updater, logs, progressLogs) async {
+        final tempDirectory = Directory.systemTemp.createTempSync(
+          'very_good_config_create_malformed',
+        );
+        addTearDown(() => tempDirectory.deleteSync(recursive: true));
+
+        final fixture = Directory(
+          path.join(
+            Directory.current.path,
+            'test/commands/create/very_good_config/malformed_fixture',
+          ),
+        );
+
+        await copyDirectory(fixture, tempDirectory);
+
+        final cwd = Directory.current;
+        Directory.current = tempDirectory;
+        addTearDown(() => Directory.current = cwd);
+
+        await expectLater(
+          commandRunner.run(['create', 'dart_package', 'very_good_dart']),
+          completion(equals(ExitCode.config.code)),
+        );
+        verify(
+          () => logger.err(
+            any(that: contains('Could not read `very_good.yaml`')),
+          ),
+        ).called(1);
+      }),
+    );
+  });
+}

lib/src/commands/create/commands/create_subcommand.dart

@@ -8,6 +8,7 @@ import 'package:meta/meta.dart';
 import 'package:path/path.dart' as path;
 import 'package:very_good_cli/src/commands/commands.dart';
 import 'package:very_good_cli/src/commands/create/templates/templates.dart';
+import 'package:very_good_cli/src/very_good_config/very_good_config.dart';
 
 // A valid Dart identifier that can be used for a package, i.e. no
 // capital letters.
@@ -105,6 +106,14 @@ abstract class CreateSubCommand extends Command<int> {
   final Logger logger;
   final MasonGeneratorFromBundle _generatorFromBundle;
 
+  /// The resolved `very_good create` configuration read from the closest
+  /// `very_good.yaml` file.
+  ///
+  /// Values declared here are used as defaults for any option that was not
+  /// explicitly passed on the command line. It defaults to an empty
+  /// configuration until [run] loads it.
+  VeryGoodCreateConfig createConfig = const VeryGoodCreateConfig();
+
   /// [ArgResults] which can be overridden for testing.
   @visibleForTesting
   ArgResults? argResultOverrides;
@@ -160,8 +169,20 @@ abstract class CreateSubCommand extends Command<int> {
     return name;
   }
 
+  /// Resolves the value for the argument named [name] against the matching
+  /// `very_good.yaml` [configValue].
+  ///
+  /// A command line argument that was explicitly parsed always wins. Otherwise
+  /// the [configValue] is used when present, falling back to the argument's
+  /// default value.
+  T? resolveArg<T>(String name, T? configValue) {
+    if (argResults.wasParsed(name)) return argResults[name] as T?;
+    return configValue ?? argResults[name] as T?;
+  }
+
   /// Gets the description for the project.
-  String get projectDescription => argResults['description'] as String? ?? '';
+  String get projectDescription =>
+      resolveArg<String>('description', createConfig.description) ?? '';
 
   /// Should return the desired template to be created during a command run.
   ///
@@ -181,6 +202,18 @@ abstract class CreateSubCommand extends Command<int> {
 
   @override
   Future<int> run() async {
+    try {
+      createConfig = VeryGoodConfig.loadFromClosestAncestor(
+        Directory.current,
+      ).create;
+    } on VeryGoodConfigParseException catch (e) {
+      logger.err(
+        'Could not read `$veryGoodConfigFileName`.\n'
+        '${e.message}',
+      );
+      return ExitCode.config.code;
+    }
+
     final template = this.template;
     final bundle = template.bundle;
 
@@ -258,7 +291,8 @@ abstract class CreateSubCommand extends Command<int> {
 mixin OrgName on CreateSubCommand {
   /// Gets the organization name.
   String get orgName {
-    final orgName = argResults['org-name'] as String? ?? _defaultOrgName;
+    final orgName =
+        resolveArg<String>('org-name', createConfig.orgName) ?? _defaultOrgName;
     _validateOrgName(orgName);
     return orgName;
   }
@@ -303,9 +337,15 @@ mixin MultiTemplates on CreateSubCommand {
   @override
   Template get template {
     final templateName =
-        argResults['template'] as String? ?? defaultTemplateName;
-
-    return templates.firstWhere((template) => template.name == templateName);
+        resolveArg<String>('template', createConfig.template) ??
+        defaultTemplateName;
+
+    return templates.firstWhere(
+      (template) => template.name == templateName,
+      orElse: () => usageException(
+        '"$templateName" is not an allowed value for option "--template".',
+      ),
+    );
   }
 }
 
@@ -316,5 +356,6 @@ mixin MultiTemplates on CreateSubCommand {
 /// to the brick generator.
 mixin Publishable on CreateSubCommand {
   /// Gets the publishable flag.
-  bool get publishable => argResults['publishable'] as bool? ?? false;
+  bool get publishable =>
+      resolveArg<bool>('publishable', createConfig.publishable) ?? false;
 }

lib/src/commands/create/commands/docs_site.dart

@@ -30,7 +30,9 @@ class CreateDocsSite extends CreateSubCommand with Publishable {
   Map<String, dynamic> getTemplateVars() {
     return <String, dynamic>{
       ...super.getTemplateVars(),
-      'org_name': argResults['org-name'],
+      'org_name':
+          resolveArg<String>('org-name', createConfig.orgName) ??
+          _defaultOrgName,
     };
   }
 

lib/src/very_good_config/very_good_config.dart

@@ -48,7 +48,10 @@ class VeryGoodConfigParseException implements Exception {
 )
 class VeryGoodConfig extends Equatable {
   /// {@macro very_good_config}
-  const VeryGoodConfig({this.test = const VeryGoodTestConfig()});
+  const VeryGoodConfig({
+    this.test = const VeryGoodTestConfig(),
+    this.create = const VeryGoodCreateConfig(),
+  });
 
   /// Creates a [VeryGoodConfig] from a decoded YAML/JSON [json] map.
   factory VeryGoodConfig.fromJson(Map<dynamic, dynamic> json) {
@@ -121,8 +124,54 @@ class VeryGoodConfig extends Equatable {
   /// Configuration values for the `very_good test` command.
   final VeryGoodTestConfig test;
 
+  /// Configuration values for the `very_good create` command.
+  final VeryGoodCreateConfig create;
+
+  @override
+  List<Object?> get props => [test, create];
+}
+
+/// {@template very_good_create_config}
+/// Configuration values that customize the defaults of the
+/// `very_good create` command and its subcommands.
+///
+/// Any field that is left as `null` retains its CLI default.
+/// {@endtemplate}
+@JsonSerializable(
+  anyMap: true,
+  checked: true,
+  createToJson: false,
+  disallowUnrecognizedKeys: true,
+  fieldRename: FieldRename.snake,
+)
+class VeryGoodCreateConfig extends Equatable {
+  /// {@macro very_good_create_config}
+  const VeryGoodCreateConfig({
+    this.description,
+    this.orgName,
+    this.publishable,
+    this.template,
+  });
+
+  /// Creates a [VeryGoodCreateConfig] from a decoded YAML/JSON [json] map.
+  factory VeryGoodCreateConfig.fromJson(Map<dynamic, dynamic> json) {
+    return _$VeryGoodCreateConfigFromJson(json);
+  }
+
+  /// The description for the generated project.
+  final String? description;
+
+  /// The organization for the generated project.
+  final String? orgName;
+
+  /// Whether the generated project is intended to be published.
+  final bool? publishable;
+
+  /// The template used to generate the project.
+  final String? template;
+
   @override
-  List<Object?> get props => [test];
+  List<Object?> get props => [description, orgName, publishable, template];
 }
 
 /// {@template very_good_test_config}

lib/src/very_good_config/very_good_config.g.dart

@@ -68,6 +68,23 @@ You cannot combine `.` with `--output-directory`. Very Good CLI will exit with
 an error if you specify both.
 :::
 
+## Configuring defaults with `very_good.yaml`
+
+To avoid repeating the same flags every time you scaffold a new project, you may create a `very_good.yaml` file at the root of your project. The `create` section accepts the same names as the CLI flags in snake_case (e.g. `--org-name` becomes `org_name`). Values from `very_good.yaml` are used as defaults; anything you pass on the command line takes precedence.
+
+```yaml
+# very_good.yaml
+create:
+  description: A Very Good project.
+  org_name: com.very.good
+  publishable: true
+  template: core
+```
+
+With the file above, running `very_good create flutter_app my_app` behaves the same as running `very_good create flutter_app my_app --desc 'A Very Good project.' --org-name com.very.good --publishable --template core`. You can still override any of these values on the command line, for example `very_good create flutter_app my_app --org-name com.example` to use a different org name for a single run.
+
+The `very_good.yaml` file is looked up starting from the directory where the command runs and walking up through its ancestors. The closest file wins; configuration from ancestor directories is not merged. This lets a single `very_good.yaml` at the repository root apply to commands run from any nested package.
+
 ## Available templates
 
 Each subcommand maps to a specific project template. For detailed usage options

site/docs/commands/create.md

@@ -31,6 +31,7 @@ Future<void> testMultiTemplateCommand({
   final argResults = _MockArgResults();
   final command = multiTemplatesCommand..argResultOverrides = argResults;
 
+  when(() => argResults.wasParsed(any())).thenReturn(true);
   when(() => argResults['template'] as String?).thenReturn(templateName);
   when(
     () => argResults['output-directory'] as String?,