feat(create): add flame_game template (#544)

Author: Jochum van der Ploeg

lib/src/commands/create/create.dart

@@ -20,6 +20,7 @@ final _templates = [
   FlutterPluginTemplate(),
   VeryGoodDartCLITemplate(),
   VeryGoodDocsSiteTemplate(),
+  VeryGoodFlameGameTemplate(),
 ];
 
 final _defaultTemplate = _templates.first;

lib/src/commands/create/templates/templates.dart

@@ -4,5 +4,6 @@ export 'very_good_core/very_good_core.dart';
 export 'very_good_dart_cli/very_good_dart_cli.dart';
 export 'very_good_dart_package/very_good_dart_package.dart';
 export 'very_good_docs_site/very_good_docs_site.dart';
+export 'very_good_flame_game/very_good_flame_game.dart';
 export 'very_good_flutter_package/very_good_flutter_package.dart';
 export 'very_good_flutter_plugin/very_good_flutter_plugin.dart';

lib/src/commands/create/templates/very_good_flame_game/very_good_flame_game.dart

@@ -0,0 +1,2 @@
+export 'very_good_flame_game_bundle.dart';
+export 'very_good_flame_game_template.dart';

lib/src/commands/create/templates/very_good_flame_game/very_good_flame_game_bundle.dart

@@ -0,0 +1,32 @@
+import 'dart:io';
+
+import 'package:mason/mason.dart';
+import 'package:very_good_cli/src/commands/create/templates/templates.dart';
+import 'package:very_good_cli/src/logger_extension.dart';
+
+/// {@template flame_game_template}
+/// A Flame Game template.
+/// {@endtemplate}
+class VeryGoodFlameGameTemplate extends Template {
+  /// {@macro flame_game_template}
+  VeryGoodFlameGameTemplate()
+      : super(
+          name: 'flame_game',
+          bundle: veryGoodFlameGameBundle,
+          help: 'Generate a Very Good Flame game.',
+        );
+
+  @override
+  Future<void> onGenerateComplete(Logger logger, Directory outputDir) async {
+    await installDartPackages(logger, outputDir);
+    await applyDartFixes(logger, outputDir);
+    _logSummary(logger);
+  }
+
+  void _logSummary(Logger logger) {
+    logger
+      ..info('\n')
+      ..created('Created a Very Good Game powered by Flame! 🔥🦄')
+      ..info('\n');
+  }
+}

lib/src/commands/create/templates/very_good_flame_game/very_good_flame_game_template.dart

@@ -10,7 +10,7 @@ dependencies:
   args: ^2.1.0
   glob: ^2.0.2
   lcov_parser: ^0.1.2
-  mason: ">=0.1.0-dev.35 <0.1.0-dev.36"
+  mason: ">=0.1.0-dev.36 <0.1.0-dev.37"
   mason_logger: ^0.2.2
   meta: ^1.3.0
   path: ^1.8.0

pubspec.yaml

@@ -242,6 +242,54 @@ void main() {
         expect(buildResult.stderr, isEmpty);
       });
 
+      test('create -t flame_game', () async {
+        final directory = Directory(path.join('.tmp', 'very_good_flame_game'));
+
+        final result = await commandRunner.run(
+          ['create', 'very_good_flame_game', '-t', 'flame_game', '-o', '.tmp'],
+        );
+        expect(result, equals(ExitCode.success.code));
+
+        final formatResult = await Process.run(
+          'flutter',
+          ['format', '--set-exit-if-changed', '.'],
+          workingDirectory: directory.path,
+          runInShell: true,
+        );
+        expect(formatResult.exitCode, equals(ExitCode.success.code));
+        expect(formatResult.stderr, isEmpty);
+
+        final analyzeResult = await Process.run(
+          'flutter',
+          ['analyze', '.'],
+          workingDirectory: directory.path,
+          runInShell: true,
+        );
+        expect(analyzeResult.exitCode, equals(ExitCode.success.code));
+        expect(analyzeResult.stderr, isEmpty);
+        expect(analyzeResult.stdout, contains('No issues found!'));
+
+        final testResult = await Process.run(
+          'flutter',
+          ['test', '--no-pub', '--coverage'],
+          workingDirectory: directory.path,
+          runInShell: true,
+        );
+        expect(testResult.exitCode, equals(ExitCode.success.code));
+        expect(testResult.stderr, isEmpty);
+        expect(testResult.stdout, contains('All tests passed!'));
+
+        final testCoverageResult = await Process.run(
+          'genhtml',
+          ['coverage/lcov.info', '-o', 'coverage'],
+          workingDirectory: directory.path,
+          runInShell: true,
+        );
+        expect(testCoverageResult.exitCode, equals(ExitCode.success.code));
+        expect(testCoverageResult.stderr, isEmpty);
+        expect(testCoverageResult.stdout, contains('lines......: 97.8%'));
+      });
+
       test('create -t core', () async {
         final directory = Directory(path.join('.tmp', 'very_good_core'));
 
@@ -290,6 +338,6 @@ void main() {
         expect(testCoverageResult.stdout, contains('lines......: 100.0%'));
       });
     },
-    timeout: const Timeout(Duration(seconds: 90)),
+    timeout: const Timeout(Duration(minutes: 2)),
   );
 }

test/e2e_test.dart

@@ -26,13 +26,14 @@ const expectedUsage = [
       '''                              (defaults to "A Very Good Project created by Very Good CLI.")\n'''
       '''    --executable-name         Used by the dart_cli template, the CLI executable name (defaults to the project name)\n'''
       '    --org-name                The organization for this new project.\n'
-      '                              (defaults to "com.example.verygoodcore")\n'
+      '''                              (defaults to "com.example.verygoodcore")\n'''
       '''-t, --template                The template used to generate this new project.\n'''
       '\n'
       '''          [core] (default)    Generate a Very Good Flutter application.\n'''
       '''          [dart_cli]          Generate a Very Good Dart CLI application.\n'''
       '          [dart_pkg]          Generate a reusable Dart package.\n'
       '          [docs_site]         Generate a Very Good documentation site.\n'
+      '          [flame_game]        Generate a Very Good Flame game.\n'
       '          [flutter_pkg]       Generate a reusable Flutter package.\n'
       '          [flutter_plugin]    Generate a reusable Flutter plugin.\n'
       '\n'
@@ -803,6 +804,15 @@ void main() {
             expectedLogSummary: 'Created a Very Good documentation site! 🦄',
           );
         });
+
+        test('flame game template', () async {
+          await expectValidTemplateName(
+            templateName: 'flame_game',
+            expectedBundle: veryGoodFlameGameBundle,
+            expectedLogSummary:
+                'Created a Very Good Game powered by Flame! 🔥🦄',
+          );
+        });
       });
     });
   });