Disable format (#1160)

Author: rrousselGit

packages/freezed/CHANGELOG.md

@@ -1,10 +1,5 @@
 ## Unreleased 3.0.0
 
-### Breaking changes:
-
-- **Breaking**: Removed `map/when` and variants. These have been discouraged since Dart got pattern matching.
-- **Breaking**: Freezed classes should now either be `abstract`, `sealed`, or manually implements `_$MyClass`.
-
 ### New: Mixed mode
 
 Freezed 3.0 is about supporting a "mixed mode". 
@@ -161,18 +156,21 @@ This feature offers fine-grained control over every parts of your models.
 Unfortunately, it is kind of required to "extend" the parent class (so here `extends Result<T>`). This is because Dart doesn't support `sealed mixin class`, so you can't do
 `with Result<T>` instead.
 
-### New: private unions
-
-It is now possible to have a private constructor for unions:
+### Other changes:
 
-```dart
-@freezed
-sealed class Result<T> with _$Result {
- // It wasn't possible to write _data before, but now is.
- factory Result._data(T data) = ResultData;
- factory Result.error(Object error) = ResultError;
-}
-```
+- **Breaking**: Removed `map/when` and variants. These have been discouraged since Dart got pattern matching.
+- **Breaking**: Freezed classes should now either be `abstract`, `sealed`, or manually implements `_$MyClass`.
+- When formatting is disabled (default), Freezed now generates `// dart format off`. This
+ prevents having to exclude generated file from formatting check in the CI.
+- It is now possible to have a private constructor for unions:
+ ```dart
+ @freezed
+ sealed class Result<T> with _$Result {
+ // It wasn't possible to write _data before, but now is.
+ factory Result._data(T data) = ResultData;
+ factory Result.error(Object error) = ResultError;
+ }
+ ```
 
 ## 2.5.8 - 2025-01-06
 

packages/freezed/build.yaml

@@ -10,6 +10,8 @@ targets:
  include:
  - test/*
  - test/**/*
+ options:
+ format: true
  source_gen|combining_builder:
  options:
  ignore_for_file:

packages/freezed/lib/builder.dart

@@ -1,5 +1,4 @@
 import 'package:build/build.dart';
-import 'package:dart_style/dart_style.dart';
 import 'package:freezed_annotation/freezed_annotation.dart';
 import 'package:source_gen/source_gen.dart';
 
@@ -8,12 +7,12 @@ import 'src/freezed_generator.dart';
 /// Builds generators for `build_runner` to run
 Builder freezed(BuilderOptions options) {
  return PartBuilder(
- [FreezedGenerator(Freezed.fromJson(options.config))],
- formatOutput: (str, version) {
- if (options.config['format'] == false) return str;
-
- return DartFormatter(languageVersion: version).format(str);
- },
+ [
+  FreezedGenerator(
+  Freezed.fromJson(options.config),
+ format: options.config['format'] as bool? ?? false,
+ ),
+ ],
  '.freezed.dart',
  header: '''
 // coverage:ignore-file

packages/freezed/lib/src/ast.dart

@@ -5,9 +5,11 @@ extension AstX on AstNode {
  String? get documentation {
  final builder = StringBuffer();
 
- for (Token? token = beginToken.precedingComments;
- token != null;
- token = token.next) {
+ for (
+ Token? token = beginToken.precedingComments;
+ token != null;
+ token = token.next
+ ) {
  builder.writeln(token);
  }
 
@@ -25,7 +27,7 @@ extension ClassX on ClassDeclaration {
  element,
  ...element.allSupertypes
  .where((e) => !e.isDartCoreObject)
- .map((e) => e.element)
+ .map((e) => e.element),
  ]) {
  for (final method in type.methods) {
  if (method.name == 'toString') {
@@ -44,7 +46,7 @@ extension ClassX on ClassDeclaration {
  element,
  ...element.allSupertypes
  .where((e) => !e.isDartCoreObject)
- .map((e) => e.element)
+ .map((e) => e.element),
  ]) {
  for (final method in type.methods.where((e) => e.isOperator)) {
  if (method.name == '==') {
@@ -61,8 +63,9 @@ extension ConstructorX on ConstructorDeclaration {
  // ignore: deprecated_member_use, latest analyzer with enclosingElement3 not available in stable channel
  final classElement = declaredElement!.enclosingElement3;
 
- var generics =
- classElement.typeParameters.map((e) => '\$${e.name}').join(', ');
+ var generics = classElement.typeParameters
+ .map((e) => '\$${e.name}')
+ .join(', ');
  if (generics.isNotEmpty) {
  generics = '<$generics>';
  }
@@ -77,8 +80,9 @@ extension ConstructorX on ConstructorDeclaration {
  // ignore: deprecated_member_use, latest analyzer with enclosingElement3 not available in stable channel
  final classElement = declaredElement!.enclosingElement3;
 
- var generics =
- classElement.typeParameters.map((e) => '\$${e.name}').join(', ');
+ var generics = classElement.typeParameters
+ .map((e) => '\$${e.name}')
+ .join(', ');
  if (generics.isNotEmpty) {
  generics = '<$generics>';
  }

packages/freezed/lib/src/freezed_generator.dart

@@ -19,24 +19,27 @@ extension StringX on String {
 
 @immutable
 class FreezedGenerator extends ParserGenerator<Freezed> {
- FreezedGenerator(this._buildYamlConfigs);
+ FreezedGenerator(this._buildYamlConfigs, {required this.format});
 
  final Freezed _buildYamlConfigs;
+ final bool format;
 
  Iterable<DeepCloneableProperty> _getCommonDeepCloneableProperties(
  List<ConstructorDetails> constructors,
  PropertyList commonProperties,
  ) sync* {
  for (final commonProperty in commonProperties.cloneableProperties) {
- final commonGetter = commonProperties.readableProperties
- .firstWhereOrNull((e) => e.name == commonProperty.name);
+ final commonGetter = commonProperties.readableProperties.firstWhereOrNull(
+ (e) => e.name == commonProperty.name,
+ );
  final deepCopyProperty = constructors.firstOrNull?.deepCloneableProperties
  .firstWhereOrNull((e) => e.name == commonProperty.name);
 
  if (deepCopyProperty == null || commonGetter == null) continue;
 
  yield deepCopyProperty.copyWith(
- nullable: deepCopyProperty.nullable ||
+ nullable:
+ deepCopyProperty.nullable ||
  commonProperty.isNullable ||
  commonGetter.isNullable,
  );
@@ -54,6 +57,8 @@ class FreezedGenerator extends ParserGenerator<Freezed> {
  ) sync* {
  if (annotations.isEmpty) return;
 
+ if (!format) yield '// dart format off';
+
  final library = Library.from(units);
  for (final value in _generateForAll(library)) {
  yield value;
@@ -71,30 +76,31 @@ class FreezedGenerator extends ParserGenerator<Freezed> {
  yield value;
  }
  }
+
+ if (!format) yield '// dart format on';
  }
 
- Iterable<Object> _generateForData(
- Library globalData,
- Class data,
- ) sync* {
+ Iterable<Object> _generateForData(Library globalData, Class data) sync* {
  if (data.options.fromJson) yield FromJson(data);
 
- final commonCopyWith = data.options.annotation.copyWith ??
- data.properties.cloneableProperties.isNotEmpty
- ? CopyWith(
- parents: data.parents,
- clonedClassName: data.name,
- readableProperties: data.properties.readableProperties,
- cloneableProperties: data.properties.cloneableProperties,
- deepCloneableProperties: _getCommonDeepCloneableProperties(
- data.constructors,
- data.properties,
- ).toList(),
- genericsDefinition: data.genericsDefinitionTemplate,
- genericsParameter: data.genericsParameterTemplate,
- data: data,
- )
- : null;
+ final commonCopyWith =
+ data.options.annotation.copyWith ??
+ data.properties.cloneableProperties.isNotEmpty
+ ? CopyWith(
+ parents: data.parents,
+ clonedClassName: data.name,
+ readableProperties: data.properties.readableProperties,
+ cloneableProperties: data.properties.cloneableProperties,
+ deepCloneableProperties:
+ _getCommonDeepCloneableProperties(
+ data.constructors,
+ data.properties,
+ ).toList(),
+ genericsDefinition: data.genericsDefinitionTemplate,
+ genericsParameter: data.genericsParameterTemplate,
+ data: data,
+ )
+ : null;
 
  yield Abstract(
  data: data,
@@ -109,21 +115,24 @@ class FreezedGenerator extends ParserGenerator<Freezed> {
  constructor: constructor,
  commonProperties: data.properties.readableProperties,
  globalData: globalData,
- copyWith: data.options.annotation.copyWith ??
- constructor.parameters.allParameters.isNotEmpty
- ? CopyWith(
- parents: [],
- clonedClassName: constructor.redirectedName,
- cloneableProperties: constructor.properties.toList(),
- readableProperties:
- constructor.properties.where((e) => e.isSynthetic).toList(),
- deepCloneableProperties: constructor.deepCloneableProperties,
- genericsDefinition: data.genericsDefinitionTemplate,
- genericsParameter: data.genericsParameterTemplate,
- data: data,
- parent: commonCopyWith,
- )
- : null,
+ copyWith:
+ data.options.annotation.copyWith ??
+ constructor.parameters.allParameters.isNotEmpty
+ ? CopyWith(
+ parents: [],
+ clonedClassName: constructor.redirectedName,
+ cloneableProperties: constructor.properties.toList(),
+ readableProperties:
+ constructor.properties
+ .where((e) => e.isSynthetic)
+ .toList(),
+ deepCloneableProperties: constructor.deepCloneableProperties,
+ genericsDefinition: data.genericsDefinitionTemplate,
+ genericsParameter: data.genericsParameterTemplate,
+ data: data,
+ parent: commonCopyWith,
+ )
+ : null,
  );
  }
  }