♻️ Fighting with the Dart formatter

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -52,7 +52,7 @@ body:
 
         flutter_gen:
           output: lib/gen/
-          line_length: 80
+        #  line_length: 80
 
           integrations:
             flutter_svg: true

README.md

@@ -143,7 +143,7 @@ Default configuration can be found [here](https://github.com/FlutterGen/flutter_
 
 flutter_gen:
   output: lib/gen/ # Optional (default: lib/gen/)
-  line_length: 80 # Optional (default: 80)
+  # line_length: 80 # Optional
 
   # Optional
   integrations:
@@ -184,7 +184,7 @@ targets:
       flutter_gen_runner: # or flutter_gen
         options: 
           output: lib/build_gen/ # Optional (default: lib/gen/)
-          line_length: 120 # Optional (default: 80)
+          line_length: 120 # Optional
 ```
 
 ## Available Parsers

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

@@ -1,11 +1,13 @@
+// dart format width=80
+
 /// GENERATED CODE - DO NOT MODIFY BY HAND
 /// *****************************************************
 ///  FlutterGen
 /// *****************************************************
 
 // coverage:ignore-file
 // ignore_for_file: type=lint
-// ignore_for_file: directives_ordering,unnecessary_import,implicit_dynamic_list_literal,deprecated_member_use
+// ignore_for_file: deprecated_member_use,directives_ordering,implicit_dynamic_list_literal,unnecessary_import
 
 import 'package:flutter/services.dart';
 import 'package:flutter/widgets.dart';

examples/example/lib/gen/colors.gen.dart

@@ -1,11 +1,12 @@
+// dart format width=80
 /// GENERATED CODE - DO NOT MODIFY BY HAND
 /// *****************************************************
 ///  FlutterGen
 /// *****************************************************
 
 // coverage:ignore-file
 // ignore_for_file: type=lint
-// ignore_for_file: directives_ordering,unnecessary_import,implicit_dynamic_list_literal,deprecated_member_use
+// ignore_for_file: deprecated_member_use,directives_ordering,implicit_dynamic_list_literal,unnecessary_import
 
 import 'package:flutter/painting.dart';
 import 'package:flutter/material.dart';

examples/example/lib/gen/fonts.gen.dart

@@ -1,11 +1,12 @@
+// dart format width=80
 /// GENERATED CODE - DO NOT MODIFY BY HAND
 /// *****************************************************
 ///  FlutterGen
 /// *****************************************************
 
 // coverage:ignore-file
 // ignore_for_file: type=lint
-// ignore_for_file: directives_ordering,unnecessary_import,implicit_dynamic_list_literal,deprecated_member_use
+// ignore_for_file: deprecated_member_use,directives_ordering,implicit_dynamic_list_literal,unnecessary_import
 
 class MyFontFamily {
   MyFontFamily._();

examples/example/pubspec.yaml

@@ -14,20 +14,21 @@ dependencies:
 
   flutter_svg: ^2.0.0
   lottie: ^3.0.0
-  rive: ^0.11.0
+  rive: ^0.13.20
 
 dev_dependencies:
+  lints: any
   flutter_test:
     sdk: flutter
+
   flutter_gen_runner:
     path: ../../packages/runner
 
-  lints: ^2.0.0
   build_runner: ^2.0.0
 
 flutter_gen:
   output: lib/gen/ # Optional (default: lib/gen/)
-  line_length: 80 # Optional (default: 80)
+#  line_length: 80 # Optional
 
   integrations:
     flutter_svg: true

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

@@ -1,11 +1,13 @@
+// dart format width=80
+
 /// GENERATED CODE - DO NOT MODIFY BY HAND
 /// *****************************************************
 ///  FlutterGen
 /// *****************************************************
 
 // coverage:ignore-file
 // ignore_for_file: type=lint
-// ignore_for_file: directives_ordering,unnecessary_import,implicit_dynamic_list_literal,deprecated_member_use
+// ignore_for_file: deprecated_member_use,directives_ordering,implicit_dynamic_list_literal,unnecessary_import
 
 import 'package:flutter/services.dart';
 import 'package:flutter/widgets.dart';

examples/example_resources/lib/gen/colors.gen.dart

@@ -1,11 +1,12 @@
+// dart format width=80
 /// GENERATED CODE - DO NOT MODIFY BY HAND
 /// *****************************************************
 ///  FlutterGen
 /// *****************************************************
 
 // coverage:ignore-file
 // ignore_for_file: type=lint
-// ignore_for_file: directives_ordering,unnecessary_import,implicit_dynamic_list_literal,deprecated_member_use
+// ignore_for_file: deprecated_member_use,directives_ordering,implicit_dynamic_list_literal,unnecessary_import
 
 import 'package:flutter/painting.dart';
 import 'package:flutter/material.dart';

examples/example_resources/pubspec.yaml

@@ -11,7 +11,7 @@ dependencies:
 
   flutter_svg: ^2.0.0
   lottie: ^3.0.0
-  rive: ^0.11.0
+  rive: ^0.13.20
 
 dev_dependencies:
   flutter_gen_runner:
@@ -21,7 +21,6 @@ dev_dependencies:
 
 flutter_gen:
   output: lib/gen/
-  line_length: 80
 
   integrations:
     flutter_svg: true

packages/core/lib/generators/assets_generator.dart

@@ -84,7 +84,7 @@ Future<String> generateAssets(
   final deprecatedPackageParam =
       config.flutterGen.assets.packageParameterEnabled != null;
   if (deprecatedStyle || deprecatedPackageParam) {
-    final deprecationBuffer = StringBuffer();
+    final deprecationBuffer = StringBuffer('\n');
     if (deprecatedStyle) {
       deprecationBuffer.writeln(
         sBuildDeprecation(
@@ -145,6 +145,7 @@ Future<String> generateAssets(
   }
 
   final buffer = StringBuffer();
+  buffer.writeln('// dart format width=${formatter.pageWidth}\n');
   buffer.writeln(header);
   buffer.writeln(ignore);
   buffer.writeln(importsBuffer.toString());

packages/core/lib/generators/colors_generator.dart

@@ -24,6 +24,7 @@ String generateColors(
 
   final buffer = StringBuffer();
   final className = colorsConfig.outputs.className;
+  buffer.writeln('// dart format width=${formatter.pageWidth}');
   buffer.writeln(header);
   buffer.writeln(ignore);
   buffer.writeln("import 'package:flutter/painting.dart';");

packages/core/lib/generators/fonts_generator.dart

@@ -45,6 +45,7 @@ String generateFonts(
 
   final buffer = StringBuffer();
   final className = fontsConfig.outputs.className;
+  buffer.writeln('// dart format width=${formatter.pageWidth}');
   buffer.writeln(header);
   buffer.writeln(ignore);
   buffer.writeln('class $className {');

packages/core/lib/generators/generator_helper.dart

@@ -10,11 +10,18 @@ String get header {
 ''';
 }
 
+const _ignoredRules = <String>[
+  'deprecated_member_use',
+  'directives_ordering',
+  'implicit_dynamic_list_literal',
+  'unnecessary_import',
+];
+
 String get ignore {
   return '''// coverage:ignore-file
 // ignore_for_file: type=lint
-// ignore_for_file: directives_ordering,unnecessary_import,implicit_dynamic_list_literal,deprecated_member_use
-  
+// ignore_for_file: ${_ignoredRules.join(',')}
+
 ''';
 }
 

packages/core/lib/settings/config.dart

@@ -1,19 +1,35 @@
 import 'dart:io';
 
+// import 'package:collection/collection.dart';
+// import 'package:dart_style/dart_style.dart' show TrailingCommas;
 import 'package:flutter_gen_core/settings/config_default.dart';
 import 'package:flutter_gen_core/settings/pubspec.dart';
+import 'package:flutter_gen_core/utils/cast.dart' show safeCast;
 import 'package:flutter_gen_core/utils/error.dart';
 import 'package:flutter_gen_core/utils/log.dart';
 import 'package:flutter_gen_core/utils/map.dart';
 import 'package:flutter_gen_core/version.gen.dart';
 import 'package:path/path.dart';
+import 'package:pub_semver/pub_semver.dart' show VersionConstraint;
 import 'package:yaml/yaml.dart';
 
 class Config {
-  const Config._({required this.pubspec, required this.pubspecFile});
+  const Config._({
+    required this.pubspec,
+    required this.pubspecFile,
+    required this.sdkConstraint,
+    // required this.formatterTrailingCommas,
+    required this.formatterPageWidth,
+  });
 
   final Pubspec pubspec;
   final File pubspecFile;
+  final VersionConstraint? sdkConstraint;
+
+  // TODO(ANYONE): Allow passing the trailing commas option after the SDK constraint was bumped to ^3.7.
+  // final TrailingCommas? formatterTrailingCommas;
+
+  final int? formatterPageWidth;
 }
 
 Config loadPubspecConfig(File pubspecFile, {File? buildFile}) {
@@ -24,10 +40,16 @@ Config loadPubspecConfig(File pubspecFile, {File? buildFile}) {
   log.info('v$packageVersion Loading ...');
   log.info('Reading options from $pubspecLocaleHint');
 
-  final defaultMap = loadYaml(configDefaultYamlContent) as Map?;
+  VersionConstraint? sdkConstraint;
+
+  final defaultMap = loadYaml(configDefaultYamlContent) as YamlMap?;
 
   final pubspecContent = pubspecFile.readAsStringSync();
-  final pubspecMap = loadYaml(pubspecContent) as Map?;
+  final pubspecMap = loadYaml(pubspecContent) as YamlMap?;
+  if (safeCast<String>(pubspecMap?['environment']?['sdk']) case final sdk?) {
+    sdkConstraint = VersionConstraint.parse(sdk);
+  }
+
   Map mergedMap = mergeMap([defaultMap, pubspecMap]);
 
   YamlMap? getBuildFileOptions(File file) {
@@ -76,7 +98,44 @@ Config loadPubspecConfig(File pubspecFile, {File? buildFile}) {
   }
 
   final pubspec = Pubspec.fromJson(mergedMap);
-  return Config._(pubspec: pubspec, pubspecFile: pubspecFile);
+
+  final pubspecLockFile = File(
+    normalize(join(basename(pubspecFile.parent.path), 'pubspec.lock')),
+  );
+  final pubspecLockContent = switch (pubspecLockFile.existsSync()) {
+    true => pubspecLockFile.readAsStringSync(),
+    false => '',
+  };
+  final pubspecLockMap = loadYaml(pubspecLockContent) as YamlMap?;
+  if (safeCast<String>(pubspecLockMap?['sdks']?['dart']) case final sdk?) {
+    sdkConstraint ??= VersionConstraint.parse(sdk);
+  }
+
+  final analysisOptionsFile = File(
+    normalize(join(basename(pubspecFile.parent.path), 'analysis_options.yaml')),
+  );
+  final analysisOptionsContent = switch (analysisOptionsFile.existsSync()) {
+    true => analysisOptionsFile.readAsStringSync(),
+    false => '',
+  };
+  final analysisOptionsMap = loadYaml(analysisOptionsContent) as YamlMap?;
+  // final formatterTrailingCommas = switch (safeCast<String>(
+  //   analysisOptionsMap?['formatter']?['trailing_commas'],
+  // )) {
+  //   final s? => TrailingCommas.values.firstWhereOrNull((e) => e.name == s),
+  //   _ => null,
+  // };
+  final formatterPageWidth = safeCast<int>(
+    analysisOptionsMap?['formatter']?['page_width'],
+  );
+
+  return Config._(
+    pubspec: pubspec,
+    pubspecFile: pubspecFile,
+    sdkConstraint: sdkConstraint,
+    // formatterTrailingCommas: formatterTrailingCommas,
+    formatterPageWidth: formatterPageWidth,
+  );
 }
 
 Config? loadPubspecConfigOrNull(File pubspecFile, {File? buildFile}) {

packages/core/lib/settings/config_default.dart

@@ -2,12 +2,9 @@ const configDefaultYamlContent = '''
 name: UNKNOWN
 
 flutter_gen:
-  # Optional
-  output: lib/gen/
-  # Optional
-  line_length: 80
-  # Optional
-  parse_metadata: false
+  output: lib/gen/ # Optional
+#  line_length: 80 # Optional
+  parse_metadata: false # Optional
 
   # Optional
   integrations:
@@ -17,37 +14,28 @@ flutter_gen:
     lottie: false
 
   assets:
-    # Optional
-    enabled: true
-    # Optional
-    outputs:
-      # Optional
+    enabled: true # Optional
+    outputs: # Optional
       # Set to true if you want this package to be a package dependency
       # See: https://flutter.dev/docs/development/ui/assets-and-images#from-packages
-      package_parameter_enabled: false
-      # Optional
+      package_parameter_enabled: false # Optional
       # Available values:
       # - camel-case
       # - snake-case
       # - dot-delimiter
-      style: dot-delimiter
+      style: dot-delimiter # Optional
       class_name: Assets
     exclude: []
 
   fonts:
-    # Optional
-    enabled: true
-    # Optional
-    outputs:
+    enabled: true # Optional
+    outputs: # Optional
       class_name: FontFamily
 
   colors:
-    # Optional
-    enabled: true
-    # Optional
-    inputs: []
-    # Optional
-    outputs:
+    enabled: true # Optional
+    inputs: [] # Optional
+    outputs: # Optional
       class_name: ColorName
 
 flutter:

packages/core/lib/settings/pubspec.dart

@@ -114,8 +114,8 @@ class FlutterGen {
   @JsonKey(name: 'output', required: true)
   final String output;
 
-  @JsonKey(name: 'line_length', required: true)
-  final int lineLength;
+  @JsonKey(name: 'line_length')
+  final int? lineLength;
 
   @JsonKey(name: 'parse_metadata', required: true)
   final bool parseMetadata;