⚡️ Use fine-grained logger instead of stdout.writeln (#694)

## What does this change?

Fixes #693

This PR also deletes the deprecation header. And added test configurations to let tests run with `concurrency=1`.

Author: AlexV525

examples/example/example.iml

@@ -11,10 +11,10 @@
       <excludeFolder url="file://$MODULE_DIR$/build" />
       <excludeFolder url="file://$MODULE_DIR$/android/.gradle" />
       <excludeFolder url="file://$MODULE_DIR$/android/.idea" />
-      <excludeFolder url="file://$MODULE_DIR$/ios/Flutter" />
+      <excludeFolder url="file://$MODULE_DIR$/ios/Flutter/ephemeral" />
       <excludeFolder url="file://$MODULE_DIR$/ios/Pods" />
       <excludeFolder url="file://$MODULE_DIR$/ios/.symlinks" />
-      <excludeFolder url="file://$MODULE_DIR$/macos/Flutter" />
+      <excludeFolder url="file://$MODULE_DIR$/macos/Flutter/ephemeral" />
       <excludeFolder url="file://$MODULE_DIR$/macos/Pods" />
       <excludeFolder url="file://$MODULE_DIR$/macos/.symlinks" />
     </content>
@@ -23,4 +23,4 @@
     <orderEntry type="library" name="Flutter Plugins" level="project" />
     <orderEntry type="library" name="Dart Packages" level="project" />
   </component>
-</module>
+</module>

examples/example/ios/.gitignore

@@ -0,0 +1,34 @@
+**/dgph
+*.mode1v3
+*.mode2v3
+*.moved-aside
+*.pbxuser
+*.perspectivev3
+**/*sync/
+.sconsign.dblite
+.tags*
+**/.vagrant/
+**/DerivedData/
+Icon?
+**/Pods/
+**/.symlinks/
+profile
+xcuserdata
+**/.generated/
+Flutter/App.framework
+Flutter/Flutter.framework
+Flutter/Flutter.podspec
+Flutter/Generated.xcconfig
+Flutter/ephemeral/
+Flutter/app.flx
+Flutter/app.zip
+Flutter/flutter_assets/
+Flutter/flutter_export_environment.sh
+ServiceDefinitions.json
+Runner/GeneratedPluginRegistrant.*
+
+# Exceptions to above rules.
+!default.mode1v3
+!default.mode2v3
+!default.pbxuser
+!default.perspectivev3

examples/example/ios/Flutter/AppFrameworkInfo.plist

@@ -21,6 +21,6 @@
   <key>CFBundleVersion</key>
   <string>1.0</string>
   <key>MinimumOSVersion</key>
-  <string>11.0</string>
+  <string>12.0</string>
 </dict>
 </plist>

examples/example/macos/.gitignore

@@ -0,0 +1,34 @@
+**/dgph
+*.mode1v3
+*.mode2v3
+*.moved-aside
+*.pbxuser
+*.perspectivev3
+**/*sync/
+.sconsign.dblite
+.tags*
+**/.vagrant/
+**/DerivedData/
+Icon?
+**/Pods/
+**/.symlinks/
+profile
+xcuserdata
+**/.generated/
+Flutter/App.framework
+Flutter/Flutter.framework
+Flutter/Flutter.podspec
+Flutter/Generated.xcconfig
+Flutter/ephemeral/
+Flutter/app.flx
+Flutter/app.zip
+Flutter/flutter_assets/
+Flutter/flutter_export_environment.sh
+ServiceDefinitions.json
+Runner/GeneratedPluginRegistrant.*
+
+# Exceptions to above rules.
+!default.mode1v3
+!default.mode2v3
+!default.pbxuser
+!default.perspectivev3

packages/command/bin/flutter_gen_command.dart

@@ -2,11 +2,20 @@ import 'dart:io';
 
 import 'package:args/args.dart';
 import 'package:flutter_gen_core/flutter_generator.dart';
-import 'package:flutter_gen_core/utils/cast.dart';
-import 'package:flutter_gen_core/utils/error.dart';
-import 'package:flutter_gen_core/version.gen.dart';
+import 'package:flutter_gen_core/utils/cast.dart' show safeCast;
+import 'package:flutter_gen_core/utils/log.dart' show log;
+import 'package:flutter_gen_core/version.gen.dart' show packageVersion;
+import 'package:logging/logging.dart' show Level;
 
 void main(List<String> args) async {
+  log.onRecord.listen((record) {
+    if (record.level >= Level.WARNING) {
+      stderr.writeln('[FlutterGen] [${record.level.name}] ${record.message}');
+    } else {
+      stdout.writeln('[FlutterGen] ${record.message}');
+    }
+  });
+
   final parser = ArgParser();
   parser.addOption(
     'config',
@@ -39,18 +48,14 @@ void main(List<String> args) async {
   try {
     results = parser.parse(args);
     if (results.wasParsed('help')) {
-      stdout.writeln(parser.usage);
+      log.info('Usage of the `fluttergen` command:\n${parser.usage}');
       return;
     } else if (results.wasParsed('version')) {
-      stdout.writeln('[FlutterGen] v$packageVersion');
+      log.info('v$packageVersion');
       return;
     }
   } on FormatException catch (e) {
-    stderr.writeAll(
-      <String>[e.message, 'usage: flutter_gen [options...]', ''],
-      '\n',
-    );
-    return;
+    throw '$e\n\n${parser.usage}';
   }
 
   final pubspecPath = safeCast<String>(results['config']);
@@ -65,9 +70,5 @@ void main(List<String> args) async {
   }
   final buildFile = buildPath == null ? null : File(buildPath).absolute;
 
-  try {
-    await FlutterGenerator(pubspecFile, buildFile: buildFile).build();
-  } on InvalidSettingsException catch (e) {
-    stderr.write(e.message);
-  }
+  await FlutterGenerator(pubspecFile, buildFile: buildFile).build();
 }

packages/command/dart_test.yaml

@@ -0,0 +1 @@
+concurrency: 1

packages/command/pubspec.yaml

@@ -15,6 +15,7 @@ executables:
 dependencies:
   flutter_gen_core: 5.10.0
   args: ^2.0.0
+  logging: ^1.3.0
 
 dev_dependencies:
   lints: any # Ignoring the version to allow editing across SDK versions.

packages/command/test/flutter_gen_command_test.dart

@@ -1,6 +1,5 @@
 import 'dart:io' show Platform;
 
-import 'package:flutter_gen_core/generators/generator_helper.dart' as helper;
 import 'package:flutter_gen_core/version.gen.dart';
 import 'package:test/test.dart';
 import 'package:test_process/test_process.dart';
@@ -37,6 +36,10 @@ void main() {
       'dart',
       ['bin/flutter_gen_command.dart', '--help'],
     );
+    expect(
+      await process.stdout.next,
+      equals('[FlutterGen] Usage of the `fluttergen` command:'),
+    );
     expect(
       await process.stdout.next,
       equals('-c, --config          Set the path of pubspec.yaml.'),
@@ -62,13 +65,13 @@ void main() {
     );
     expect(
       await process.stderr.next,
-      equals('Could not find an option named "--wrong".'),
+      equals('Unhandled exception:'),
     );
     expect(
       await process.stderr.next,
-      equals('usage: flutter_gen [options...]'),
+      equals('FormatException: Could not find an option named "--wrong".'),
     );
-    await process.shouldExit(0);
+    await process.shouldExit(255);
   });
 
   test('Execute deprecated config with fluttergen', () async {
@@ -80,10 +83,17 @@ void main() {
         'test/deprecated_configs.yaml',
       ],
     );
-    final errors = (await process.stderr.rest.toList()).join('\n');
-    expect(errors, contains(helper.sDeprecationHeader));
-    expect(errors, contains('style'));
-    expect(errors, contains('package_parameter_enabled'));
-    await process.shouldExit(0);
+    expect(
+      await process.stderr.next,
+      equals('Unhandled exception:'),
+    );
+    expect(
+      await process.stderr.next,
+      startsWith('InvalidSettingsException: '),
+    );
+    final rest = (await process.stderr.rest.toList()).join('\n');
+    expect(rest, contains('style'));
+    expect(rest, contains('package_parameter_enabled'));
+    await process.shouldExit(255);
   });
 }

packages/core/dart_test.yaml

@@ -0,0 +1 @@
+concurrency: 1

packages/core/lib/flutter_generator.dart

@@ -1,11 +1,12 @@
-import 'dart:io' show stdout, Directory, File;
+import 'dart:io' show Directory, File;
 
 import 'package:flutter_gen_core/generators/assets_generator.dart';
 import 'package:flutter_gen_core/generators/colors_generator.dart';
 import 'package:flutter_gen_core/generators/fonts_generator.dart';
 import 'package:flutter_gen_core/settings/config.dart';
 import 'package:flutter_gen_core/utils/file.dart';
 import 'package:flutter_gen_core/utils/formatter.dart';
+import 'package:flutter_gen_core/utils/log.dart';
 import 'package:path/path.dart' show join, normalize;
 
 class FlutterGenerator {
@@ -60,7 +61,7 @@ class FlutterGenerator {
       );
       final assetsPath = normalize(join(absoluteOutput.path, assetsName));
       writer(generated, assetsPath);
-      stdout.writeln('[FlutterGen] Generated: $assetsPath');
+      log.info('Generated: $assetsPath');
     }
 
     if (flutterGen.colors.enabled && flutterGen.colors.inputs.isNotEmpty) {
@@ -71,7 +72,7 @@ class FlutterGenerator {
       );
       final colorsPath = normalize(join(absoluteOutput.path, colorsName));
       writer(generated, colorsPath);
-      stdout.writeln('[FlutterGen] Generated: $colorsPath');
+      log.info('Generated: $colorsPath');
     }
 
     if (flutterGen.fonts.enabled && flutter.fonts.isNotEmpty) {
@@ -81,9 +82,9 @@ class FlutterGenerator {
       );
       final fontsPath = normalize(join(absoluteOutput.path, fontsName));
       writer(generated, fontsPath);
-      stdout.writeln('[FlutterGen] Generated: $fontsPath');
+      log.info('Generated: $fontsPath');
     }
 
-    stdout.writeln('[FlutterGen] Finished generating.');
+    log.info('Finished generating.');
   }
 }