chore: enhance generate script with Dart formatting support

Author: gabbopalma

maplibre_gl_platform_interface/analysis_options.yaml

@@ -1 +1,4 @@
-include: ../analysis_options.yaml
+include: ../analysis_options.yaml
+analyzer:
+  errors:
+    unintended_html_in_doc_comment: ignore

maplibre_gl_platform_interface/lib/src/source_properties.dart

@@ -1,3 +1,5 @@
+// @dart=3.9
+
 // This file is generated by
 // ./scripts/lib/generate.dart
 
@@ -63,8 +65,8 @@ class VectorSourceProperties implements SourceProperties {
   final String? attribution;
 
   /// A property to use as a feature id (for feature state). Either a
-  /// property name, or an object of the form `{sourceLayer:
-  /// propertyName}`. If specified as a string for a vector tile source,
+  /// property name, or an object of the form `{<sourceLayer>:
+  /// <propertyName>}`. If specified as a string for a vector tile source,
   /// the same property is used across all its source layers.
   ///
   /// Type: promoteId
@@ -607,15 +609,9 @@ class VideoSourceProperties implements SourceProperties {
   /// Type: array
   final List<List>? coordinates;
 
-  const VideoSourceProperties({
-    this.urls,
-    this.coordinates,
-  });
+  const VideoSourceProperties({this.urls, this.coordinates});
 
-  VideoSourceProperties copyWith(
-    List<String>? urls,
-    List<List>? coordinates,
-  ) {
+  VideoSourceProperties copyWith(List<String>? urls, List<List>? coordinates) {
     return VideoSourceProperties(
       urls: urls ?? this.urls,
       coordinates: coordinates ?? this.coordinates,
@@ -657,15 +653,9 @@ class ImageSourceProperties implements SourceProperties {
   /// Type: array
   final List<List>? coordinates;
 
-  const ImageSourceProperties({
-    this.url,
-    this.coordinates,
-  });
+  const ImageSourceProperties({this.url, this.coordinates});
 
-  ImageSourceProperties copyWith(
-    String? url,
-    List<List>? coordinates,
-  ) {
+  ImageSourceProperties copyWith(String? url, List<List>? coordinates) {
     return ImageSourceProperties(
       url: url ?? this.url,
       coordinates: coordinates ?? this.coordinates,

scripts/lib/generate.dart

@@ -3,6 +3,8 @@ import 'dart:convert';
 
 import 'package:mustache_template/mustache_template.dart';
 import 'package:recase/recase.dart';
+import 'package:dart_style/dart_style.dart';
+import 'package:pub_semver/pub_semver.dart';
 
 import 'conversions.dart';
 
@@ -91,7 +93,33 @@ Future<void> render(
   final template = Template(templateFile);
   final outputFile = File('$outputPath/$filename');
 
-  outputFile.writeAsString(template.renderString(renderContext));
+  var rendered = template.renderString(renderContext);
+
+  // Format Dart files so that subsequent `dart format --set-exit-if-changed` doesn't fail (in CI).
+  if (filename.endsWith('.dart')) {
+    try {
+      // Determine language version from current Dart SDK (major.minor)
+      final sdkVersion = Platform.version.split(' ').first; // e.g. 3.5.2
+      final versionParts = sdkVersion.split('.');
+      final languageVersion =
+          '${versionParts.elementAt(0)}.${versionParts.elementAt(1)}';
+
+      // Prepend language version pragma if not already present
+      if (!rendered.startsWith('// @dart=')) {
+        rendered = '// @dart=$languageVersion\n\n$rendered';
+      }
+
+      // Pass the version to the formatter so it can format accordingly
+      final versionObj = Version.parse('$languageVersion.0');
+      final formatter = DartFormatter(languageVersion: versionObj);
+      rendered = formatter.format(rendered);
+    } catch (e) {
+      // If formatting fails, keep the unformatted content but log a warning.
+      stderr.writeln('Warning: dart_style failed for $filename: $e');
+    }
+  }
+
+  await outputFile.writeAsString(rendered);
 }
 
 List<Map<String, dynamic>> buildStyleProperties(

scripts/pubspec.yaml

@@ -9,6 +9,7 @@ environment:
   sdk: ">=3.5.0 <4.0.0"
 
 dependencies:
+  dart_style: ^3.1.2
   mustache_template: ^2.0.1
   recase: ^4.1.0