⬆️ Constraint dart_style v3 which also bumps the SDK constraint to 3.4 (#681)

## What does this change?

Use the `dart_style` v3 to cover the short-style formatting of old projects.

## Type of change

- [x] Bug fix (non-breaking change which fixes an issue)

Author: AlexV525

.github/workflows/build.yml

@@ -61,5 +61,5 @@ jobs:
 
       - name: Check for any formatting and statically analyze the code.
         run: |
-          melos format
+          melos run format
           melos analyze

examples/example/lib/gen/assets.gen.dart

@@ -107,7 +107,7 @@ class $AssetsLottieGen {
         cat,
         geometricalAnimation,
         hamburgerArrow,
-        spinningCarrousel,
+        spinningCarrousel
       ];
 }
 

examples/example/pubspec.yaml

@@ -3,8 +3,7 @@ description: A sample project using FlutterGen.
 publish_to: 'none'
 
 environment:
-  sdk: '>=3.2.0 <4.0.0'
-  flutter: '>=3.16.0'
+  sdk: ^3.4.0
 
 dependencies:
   flutter:

examples/example_resources/lib/gen/assets.gen.dart

@@ -24,7 +24,8 @@ class $AssetsImagesGen {
   SvgGenImage get dart => const SvgGenImage('assets/images/dart.svg');
 
   /// File path: assets/images/favorite.flr
-  String get favorite => 'assets/images/favorite.flr';
+  String get favorite =>
+      'packages/example_resources/assets/images/favorite.flr';
 
   /// File path: assets/images/flutter3.jpg
   AssetGenImage get flutter3 =>
@@ -54,7 +55,7 @@ class $AssetsUnknownGen {
 }
 
 class ResAssets {
-  ResAssets._();
+  const ResAssets._();
 
   static const String package = 'example_resources';
 

examples/example_resources/pubspec.yaml

@@ -3,8 +3,7 @@ description: A sample project using FlutterGen.
 publish_to: 'none'
 
 environment:
-  sdk: '>=3.2.0 <4.0.0'
-  flutter: '>=3.16.0'
+  sdk: ^3.4.0
 
 dependencies:
   flutter:

melos.yaml

@@ -28,13 +28,11 @@ scripts:
       flutter: false
     description: dart pub upgrade
 
-  analyze:
-    exec: flutter analyze
-    description: flutter analyze
-
   format:
-    run: dart format --set-exit-if-changed .
-    description: dart format --set-exit-if-changed .
+    run: |
+      dart format --set-exit-if-changed .
+      git --no-pager diff --exit-code
+    description: Format Dart files and exit if unstaged changes exist
 
   build:
     exec: flutter build apk

packages/command/pubspec.yaml

@@ -7,7 +7,7 @@ documentation: https://github.com/FlutterGen/flutter_gen
 issue_tracker: https://github.com/FlutterGen/flutter_gen/issues
 
 environment:
-  sdk: ^3.0.0
+  sdk: ^3.4.0
 
 executables:
   fluttergen: flutter_gen_command

packages/core/lib/flutter_generator.dart

@@ -1,11 +1,11 @@
 import 'dart:io' show stdout, Directory, File;
 
-import 'package:dart_style/dart_style.dart' show DartFormatter;
 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:path/path.dart' show join, normalize;
 
 class FlutterGenerator {
@@ -15,29 +15,26 @@ class FlutterGenerator {
     this.assetsName = 'assets.gen.dart',
     this.colorsName = 'colors.gen.dart',
     this.fontsName = 'fonts.gen.dart',
+    this.overrideOutputPath,
   });
 
   final File pubspecFile;
   final File? buildFile;
   final String assetsName;
   final String colorsName;
   final String fontsName;
+  final String? overrideOutputPath;
 
   Future<void> build({Config? config, FileWriter? writer}) async {
     config ??= loadPubspecConfigOrNull(pubspecFile, buildFile: buildFile);
     if (config == null) {
       return;
     }
 
+    final formatter = buildDartFormatterFromConfig(config);
     final flutter = config.pubspec.flutter;
     final flutterGen = config.pubspec.flutterGen;
     final output = config.pubspec.flutterGen.output;
-    final lineLength = config.pubspec.flutterGen.lineLength;
-    final formatter = DartFormatter(
-      languageVersion: DartFormatter.latestLanguageVersion,
-      pageWidth: lineLength,
-      lineEnding: '\n',
-    );
 
     void defaultWriter(String contents, String path) {
       final file = File(path);
@@ -49,39 +46,40 @@ class FlutterGenerator {
 
     writer ??= defaultWriter;
 
-    final absoluteOutput =
-        Directory(normalize(join(pubspecFile.parent.path, output)));
+    final absoluteOutput = Directory(
+      normalize(overrideOutputPath ?? join(pubspecFile.parent.path, output)),
+    );
     if (!absoluteOutput.existsSync()) {
       absoluteOutput.createSync(recursive: true);
     }
 
-    if (flutterGen.colors.enabled && flutterGen.colors.inputs.isNotEmpty) {
-      final generated =
-          generateColors(pubspecFile, formatter, flutterGen.colors);
-      final colorsPath =
-          normalize(join(pubspecFile.parent.path, output, colorsName));
-      writer(generated, colorsPath);
-      stdout.writeln('[FlutterGen] Generated: $colorsPath');
-    }
-
     if (flutterGen.assets.enabled && flutter.assets.isNotEmpty) {
       final generated = await generateAssets(
         AssetsGenConfig.fromConfig(pubspecFile, config),
         formatter,
       );
-      final assetsPath =
-          normalize(join(pubspecFile.parent.path, output, assetsName));
+      final assetsPath = normalize(join(absoluteOutput.path, assetsName));
       writer(generated, assetsPath);
       stdout.writeln('[FlutterGen] Generated: $assetsPath');
     }
 
+    if (flutterGen.colors.enabled && flutterGen.colors.inputs.isNotEmpty) {
+      final generated = generateColors(
+        pubspecFile,
+        formatter,
+        flutterGen.colors,
+      );
+      final colorsPath = normalize(join(absoluteOutput.path, colorsName));
+      writer(generated, colorsPath);
+      stdout.writeln('[FlutterGen] Generated: $colorsPath');
+    }
+
     if (flutterGen.fonts.enabled && flutter.fonts.isNotEmpty) {
       final generated = generateFonts(
         FontsGenConfig.fromConfig(config),
         formatter,
       );
-      final fontsPath =
-          normalize(join(pubspecFile.parent.path, output, fontsName));
+      final fontsPath = normalize(join(absoluteOutput.path, fontsName));
       writer(generated, fontsPath);
       stdout.writeln('[FlutterGen] Generated: $fontsPath');
     }

packages/core/lib/settings/config.dart

@@ -86,10 +86,10 @@ Config loadPubspecConfig(File pubspecFile, {File? buildFile}) {
 Config? loadPubspecConfigOrNull(File pubspecFile, {File? buildFile}) {
   try {
     return loadPubspecConfig(pubspecFile, buildFile: buildFile);
-  } on FileSystemException catch (e) {
-    stderr.writeln(e.message);
-  } on InvalidSettingsException catch (e) {
-    stderr.writeln(e.message);
+  } on FileSystemException catch (e, s) {
+    stderr.writeln('$e\n$s');
+  } on InvalidSettingsException catch (e, s) {
+    stderr.writeln('$e\n$s');
   }
   return null;
 }

packages/core/lib/settings/pubspec.dart

@@ -1,4 +1,5 @@
 import 'package:json_annotation/json_annotation.dart';
+import 'package:pub_semver/pub_semver.dart' show VersionConstraint;
 
 part 'pubspec.g.dart';
 
@@ -8,6 +9,7 @@ part 'pubspec.g.dart';
 class Pubspec {
   const Pubspec({
     required this.packageName,
+    required this.environment,
     required this.flutterGen,
     required this.flutter,
   });
@@ -17,13 +19,58 @@ class Pubspec {
   @JsonKey(name: 'name', required: true)
   final String packageName;
 
+  @JsonKey(name: 'environment', fromJson: _environmentFromJson)
+  final Map<String, VersionConstraint?> environment;
+
   @JsonKey(name: 'flutter_gen', required: true)
   final FlutterGen flutterGen;
 
   @JsonKey(name: 'flutter', required: true)
   final Flutter flutter;
 }
 
+// https://github.com/dart-lang/tools/blob/d3b54e89c4f71a114554499dec00ecd87a491b2b/pkgs/pubspec_parse/lib/src/pubspec.dart#L203
+Map<String, VersionConstraint?> _environmentFromJson(Map? source) {
+  if (source == null) {
+    return {};
+  }
+  return source.map((k, value) {
+    final key = k as String;
+    if (key == 'dart') {
+      // github.com/dart-lang/pub/blob/d84173eeb03c3/lib/src/pubspec.dart#L342
+      // 'dart' is not allowed as a key!
+      throw CheckedFromJsonException(
+        source,
+        'dart',
+        'VersionConstraint',
+        'Use "sdk" to for Dart SDK constraints.',
+        badKey: true,
+      );
+    }
+
+    VersionConstraint? constraint;
+    if (value == null) {
+      constraint = null;
+    } else if (value is String) {
+      try {
+        constraint = VersionConstraint.parse(value);
+      } on FormatException catch (e) {
+        throw CheckedFromJsonException(source, key, 'Pubspec', e.message);
+      }
+
+      return MapEntry(key, constraint);
+    } else {
+      throw CheckedFromJsonException(
+        source,
+        key,
+        'VersionConstraint',
+        '`$value` is not a String.',
+      );
+    }
+    return MapEntry(key, constraint);
+  });
+}
+
 @JsonSerializable(disallowUnrecognizedKeys: false)
 class Flutter {
   const Flutter({