Running `dart format` on Dart version 3.7.0 creates inconsistent results.

[jpeiffer]

dart --version

Dart SDK version: 3.7.0 (stable) (Wed Feb 5 04:53:58 2025 -0800) on "macos_arm64"

When running: dart format lib test on the MacOS computer interactively, I get back:

Formatted 7 files (0 changed) in 0.15 seconds.

However, the GitHub Action that runs the similar command but with the flag to fail on formatted file:

dart format --set-exit-if-changed lib test

... results in:

Formatted lib/src/builder/rive_builder.dart
Formatted 5 files (1 changed) in 0.33 seconds.

I updated this action to print the file before and after. Those are pasted below. The difference appears to be the leading whitespace in the final build method. It's not clear why the MacOS / interactive version is doubling up on the tabs but the GitHub Action using the same dart version is using a single tab spacing.

The file count is different because the format is run before the code generation to print out the before / after prior to the build failing. For a true apples-to-apples, this action runs the code generator but still reformats the rive_builder.dart file.

This can be validated using:

• Repository: https://github.com/peiffer-innovations/json_dynamic_widget_plugin_rive
• Commit: peiffer-innovations/json_dynamic_widget_plugin_rive@e3eadab

Accepted by dart format on MacOS

import 'dart:convert';
import 'package:json_dynamic_widget/json_dynamic_widget.dart';
import 'package:rive/rive.dart';
part 'rive_builder.g.dart';
/// Creates a [Rive] widget.
@jsonWidget
abstract class _RiveBuilder extends JsonWidgetBuilder {
  const _RiveBuilder({
    super.args,
  });
  @override
  _Rive buildCustom({
    ChildWidgetBuilder? childBuilder,
    required BuildContext context,
    required JsonWidgetData data,
    Key? key,
  });
}
class _Rive extends StatelessWidget {
  const _Rive({
    this.alignment = Alignment.center,
    required this.animations,
    required this.antialiasing,
    required this.artboard,
    required this.asset,
    @JsonBuildArg() this.childBuilder,
    this.fit = BoxFit.contain,
    super.key,
    required this.package,
    required this.placeholder,
    required this.rive,
    required this.stateMachines,
    required this.url,
  })  : assert((asset == null && url == null) ||
            (asset == null && rive == null) ||
            (rive == null && url == null)),
        assert(asset != null || rive != null || url != null);
  final Alignment alignment;
  final List<String>? animations;
  final bool? antialiasing;
  final String? artboard;
    required this.artboard,
    required this.animations,
    required this.antialiasing,
    this.fit = BoxFit.contain,
    required this.rive,
  });
  final Alignment alignment;
  final String? artboard;
  final List<String>? animations;
  final bool? antialiasing;
  final BoxFit fit;
  final String rive;
  @override
  _RiveMemoryWidgetState createState() => _RiveMemoryWidgetState();
}
class _RiveMemoryWidgetState extends State<_RiveMemoryWidget> {
  final List<RiveAnimationController> _animations = [];
  late Artboard _artboard;
  @override
  void initState() {
    super.initState();
    final file = RiveFile.import(
      ByteData.sublistView(base64.decode(widget.rive)),
    );
    if (widget.artboard == null) {
      _artboard = file.mainArtboard;
    } else {
      _artboard = file.artboardByName(widget.artboard!)!;
    }
    if (widget.animations?.isNotEmpty == true) {
      for (var name in widget.animations!) {
        final controller = SimpleAnimation(name);
        _artboard.addController(controller);
        _animations.add(controller);
      }
    } else {
      final controller = SimpleAnimation(_artboard.animations.first.name);
      _artboard.addController(controller);
      _animations.add(controller);
    }
  }
  @override
  void dispose() {
    super.dispose();
    for (var controller in _animations) {
      controller.dispose();
    }
  }
  @override
  Widget build(BuildContext context) => Rive(
        artboard: _artboard,
        alignment: widget.alignment,
        antialiasing: widget.antialiasing ?? true,
        fit: widget.fit,
      );
}

Produced by dart format via GH Action

import 'dart:convert';
import 'package:json_dynamic_widget/json_dynamic_widget.dart';
import 'package:rive/rive.dart';
part 'rive_builder.g.dart';
/// Creates a [Rive] widget.
@jsonWidget
abstract class _RiveBuilder extends JsonWidgetBuilder {
  const _RiveBuilder({super.args});
  @override
  _Rive buildCustom({
    ChildWidgetBuilder? childBuilder,
    required BuildContext context,
    required JsonWidgetData data,
    Key? key,
  });
}
class _Rive extends StatelessWidget {
  const _Rive({
    this.alignment = Alignment.center,
    required this.animations,
    required this.antialiasing,
    required this.artboard,
    required this.asset,
    @JsonBuildArg() this.childBuilder,
    this.fit = BoxFit.contain,
    super.key,
    required this.package,
    required this.placeholder,
    required this.rive,
    required this.stateMachines,
    required this.url,
  }) : assert(
         (asset == null && url == null) ||
             (asset == null && rive == null) ||
             (rive == null && url == null),
       ),
       assert(asset != null || rive != null || url != null);
  final Alignment alignment;
  final List<String>? animations;
  final bool? antialiasing;
  final String? artboard;
  final String? asset;
    required this.animations,
    required this.antialiasing,
    this.fit = BoxFit.contain,
    required this.rive,
  });
  final Alignment alignment;
  final String? artboard;
  final List<String>? animations;
  final bool? antialiasing;
  final BoxFit fit;
  final String rive;
  @override
  _RiveMemoryWidgetState createState() => _RiveMemoryWidgetState();
}
class _RiveMemoryWidgetState extends State<_RiveMemoryWidget> {
  final List<RiveAnimationController> _animations = [];
  late Artboard _artboard;
  @override
  void initState() {
    super.initState();
    final file = RiveFile.import(
      ByteData.sublistView(base64.decode(widget.rive)),
    );
    if (widget.artboard == null) {
      _artboard = file.mainArtboard;
    } else {
      _artboard = file.artboardByName(widget.artboard!)!;
    }
    if (widget.animations?.isNotEmpty == true) {
      for (var name in widget.animations!) {
        final controller = SimpleAnimation(name);
        _artboard.addController(controller);
        _animations.add(controller);
      }
    } else {
      final controller = SimpleAnimation(_artboard.animations.first.name);
      _artboard.addController(controller);
      _animations.add(controller);
    }
  }
  @override
  void dispose() {
    super.dispose();
    for (var controller in _animations) {
      controller.dispose();
    }
  }
  @override
  Widget build(BuildContext context) => Rive(
    artboard: _artboard,
    alignment: widget.alignment,
    antialiasing: widget.antialiasing ?? true,
    fit: widget.fit,
  );
}

[NiclasLeichsenring]

I also have this problem.

Setting the language-version to latest fixed it for me, but this is just a workaround

[FMorschel]

CC @munificent

[jpeiffer]

@NiclasLeichsenring : to see if I can test that workaround (and maybe use it myself), where / how did you set language-version?

I set the environment to sdk: '>=3.7.0' but that didn't seem to help.

[NicolaVerbeeck]

Happening here as well (windows vs linux). In this case I managed to solve the inconsistency because the offending package in a mono-repo was not in the workspace definition. Putting it there did give me consistent results again

[ChunhThanhDe]

I had the same issue and reported it on Flutter, hope it will be fixed soon

flutter/flutter#163827

[munificent]

I suspect you might be running into dart-lang/dart_style#1597. Is your GitHub action running dart pub get before it runs the formatter? With Dart 3.7.0, the formatter needs to know the language version of each file it formats. It gets that from the .dart_tool/package_config.json file, which is created by dart pub get.

[jpeiffer]

The action that I reported this issue against tests to see if the repo is Flutter based or Dart based by looking for the Flutter SDK in the pubspec.yaml file.

If Flutter based, it runs flutter pub get. If Dart based, it runs dart pub get.

Then it uses the appropriate flutter / dart commands to check the format, run analysis, and run the tests.

In the specific case that I reported above, it was a Flutter based repo, but the format command it ran was still: dart format --set-exit-if-changed lib test.

  if grep -q flutter: "pubspec.yaml"; then 
    flutter packages get
    if test "true" = "true"; then
      dart run build_runner build --delete-conflicting-outputs -v
      if test -d "example"; then
        cd example
        if grep -q build_runner: "pubspec.yaml"; then 
          dart run build_runner build --delete-conflicting-outputs -v
        fi
        cd ..
      fi
    fi
    dart format --set-exit-if-changed lib test
    flutter analyze
    flutter test
  else
    dart pub get
    if test "true" = "true"; then
      dart run build_runner build --delete-conflicting-outputs -v
      if test -d "example"; then
        cd example
        if grep -q build_runner: "pubspec.yaml"; then 
          dart run build_runner build --delete-conflicting-outputs -v
        fi
        cd ..
      fi
    fi
    dart format --set-exit-if-changed lib test
    dart analyze
    dart test
  fi