freezed

Freezed is now stable

This release also:

• reverted an involuntary change of how union types were de/serialized, breaking existing code.
• fixed an issue with generic typedefs (thanks to @SunlightBro #552)
• fixed a potential null exception

• Fixed a bug where the generated code for serializable unions with a base class was invalid

• The union key is no longer passed json_serializable when deserializing avoid the case of being an unrecognized_key in some cases.
• Updated dependencies
• Increased minimum Dart SDK required to 2.14.0
• Fixed an issue where classes with a $ in their name could cause Freezed to fail (Thanks to @comigor #542)
• When using typedefs, the generated code now tries to use the typedef too if possible, instead of the aliased type (Thanks to @Norbert515 #536).
• Added support for custom ==/hashCode implementation (Thanks to @casvanluijtelaa #526)
• When writing a custom toJson function, it will now always take precedence over the default implementation generated by Freezed.

Fixed the generated hashCode not compiling for objects with a large number of properties. (#531)

• Breaking Changed the syntax for @With and @Implements to use a generic annotation. Before:

  @With(MyClass)
  @With.fromString('Generic<int>')
  

  After:

  @With<MyClass>()
  @With<Generic<int>>()
  

• Fixed an issue with fromJson tear-offs not allowing Object? as map value. (#520)

• Optimized the generated implementation of hashCode and ==

• Fixed an issue when MyClass<Object>() and MyClass<int>() could be considered equal

• Require Dart SDK >=2.14.0.

• fixed a bug when using alias imports, potentially using the prefix on every variables.
• When @Freezed(fallback: '...') is specified and using fromJson, now support cases where the JSON does not contain the "key".

• Now supports types coming from import '...' as alias;
• generated .freezed.dart are now excluded from code coverage reports.
• if toString is overridden, Freezed no-longer applies Diagnosticable which would break the toString (fixes #221)
• Add union.whenOrNull and union.mapOrNull, similar to maybeWhen and maybeMap but instead of an orElse they return null.

• Upgraded to support json_serializable 5.0.0
• fromJson now throws CheckedFromJsonException if it fails to deserialize an object.
• fixed an issue where optional dynamic keys were not allowed.

• Added the ability to specify a fallback constructor when deserializing unions (thanks to @Brazol)

• Fixed issues with recursive Freezed classes that could cause the parameter type to be inferred as dynamic (see #399)
• Updated build and other similar dependencies to latest

Fixed examples in the README

Upgrade dependencies

• Added the ability to customize the JSON value of a union. See https://github.com/rrousselGit/freezed#fromjson---classes-with-multiple-constructors for more information (Thanks to @ookami-kb)

• Fix an issue where Freezed would not generate code properly if freezed_annotation was indirectly imported (by importing a library that exports freezed_annotation) (Thanks to @ookami-kb)

• fix sort_unnamed_constructors_first and cast_nullable_to_non_nullable in the generated code (Thanks to @gaetschwartz #372)

• Fix @Assert no-longer working
• Fixed an issue where a factory using the => syntax (so not managed by Freezed) with default values could break code-generation.

• Stable null-safety release

• Upgraded analyzer to support latest versions

• Freezed classes no-longer need to be abstract.
  Before:

  @freezed
  abstract class Example with _$Example {
    factory Example(int value) = _Example;
  }
  

  after:

  @freezed
  class Example with _$Example {
    factory Example(int value) = _Example;
  }
  

  This leads to better error messages when a Freezed class uses interfaces/mixins but the class is missing a specific property.

• It is now allowed to add unimplemented getter to Freezed classes. This can be useful to guarantee that union-types all have a common property:

  @freezed
  class Union with _$Union {
    const factory Union.left(int value) = _Left;
    const factory Union.right(int value) = _Left;
  
    @override
    int get value; // adding this forces all union cases to possess a `value` property
  }
  

• Excluded getters and late variables from the generated toString as they could potentially cause a StackOverflow

• Fixed a bug causing properties with annotations to generate the annotations before the `required keyword, leading to a compilation error (see #351).

• Upgraded analyzer to support latest versions

• Freezed classes no-longer need to be abstract.
  Before:

  @freezed
  abstract class Example with _$Example {
    factory Example(int value) = _Example;
  }
  

  after:

  @freezed
  class Example with _$Example {
    factory Example(int value) = _Example;
  }
  

  This leads to better error messages when a Freezed class uses interfaces/mixins but the class is missing a specific property.

• It is now allowed to add unimplemented getter to Freezed classes. This can be useful to guarantee that union-types all have a common property:

  @freezed
  class Union with _$Union {
    const factory Union.left(int value) = _Left;
    const factory Union.right(int value) = _Left;
  
    @override
    int get value; // adding this forces all union cases to possess a `value` property
  }
  

• Excluded getters and late variables from the generated toString as they could potentially cause a StackOverflow

• Fixed a bug causing properties with annotations to generate the annotations before the `required keyword, leading to a compilation error (see #351).

Migrated to null safety

• fixed a bug where /// above a constructor could cause the generation to stop working (see also https://github.com/rrousselGit/freezed/issues/326)

• Fix Freezed generating code from constructors that do not rely on Freezed (https://github.com/rrousselGit/freezed/issues/323)

• Fixes a bug where comments on named parameters could break generation (https://github.com/rrousselGit/freezed/issues/317)

• fixed a bug that caused the code-generation to never complete (https://github.com/rrousselGit/freezed/issues/312)

• Renamed Result in generated code to TResult to avoid naming conflicts
• Fixes InconsistentAnalysisException sometimes being thrown (https://github.com/rrousselGit/freezed/issues/294)

• Renamed Result in generated code to TResult to avoid naming conflicts
• Fixes InconsistentAnalysisException sometimes being thrown (https://github.com/rrousselGit/freezed/issues/294)

• Upgrade the dependencies (analyzer, build_runner)
• fixed a bug where a custom fromJson constructor still generated the fromJson constructor with json_serializable (see also https://github.com/rrousselGit/freezed/issues/280)
• fixed a generation issue when unionKey contains special characters (see also https://github.com/rrousselGit/freezed/issues/274)

• Removed dependency on _fe_analyzer_shared

• Added /// @nodoc on objects generated by Freezed that starts with $ to not pollute dartdoc.

• Added support for documenting properties, by documenting the constructor parameters:

  @freezed
  abstract class Example with _$Example {
    const factory Example(
      /// Some documentation
      String parameter,
    ) = Person;
  }
  

• Added Assert decorator to generate assert(...) statements on Freezed classes:

  @freezed
  abstract class Person with _$Person {
    @Assert('name.trim().isNotEmpty', 'name cannot be empty')
    @Assert('age >= 0')
    factory Person({
      String name,
      int age,
    }) = _Person;
  }
  

• Now generates a constructor tear-off for fromJson too:

  @freezed
  abstract class Person with _$Person {
    factory Person({ String name, int age}) = _Person;
  
    factory Person.fromJson(Map<String, dynamic> json) => _$PersonFromJson(json);
  }
  
  List<Map<String, dynamic>> list;
  
  List<MyClass> persons = list.map($Person.fromJson).toList();
  

• Added a way to customize the de/serialization of union types using the @Freezed(unionKey: 'my-key') decorator.

  See also https://github.com/rrousselGit/freezed#fromjson---classes-with-multiple-constructors

• Fixed a bug where deep-copy did not work properly for recursive classes (https://github.com/rrousselGit/freezed/issues/213)

• Fixed a situation where @late properties could trigger a RangeError (https://github.com/rrousselGit/freezed/issues/219)

• Fixed a bug in which case Freezed generated an invalid copyWith implementation

• No-longer generate when/... for private constructors.

• Fixed a bug where the generated class incorrectly used Diagnosticable event if package:flutter/foundation wasn't imported. (Thanks to @avbk)

• Generate when/map/... even for classes with a single constructors (thanks @andrzejchm)

• Further improve the parsing of recursive freezed class to avoid dynamics

• Added @With and @Implements decorators to allow only a specific constructor of a union type to implement an interface:

  @freezed
  abstract class Example with _$Example {
    const factory Example.person(String name, int age) = Person;
  
    @Implements(GeographicArea)
    const factory Example.city(String name, int population) = City;
  }
  

  Thanks to @long1eu

• Fixed a bug where a recursive freezed class may generate a property as dynamic (thanks to @maks)

• Improved the readme (Thanks to @scopendo and @Matsue)

• Fixes a bug where code-generation could end-up in a Stack Overflow if a class depends on itself

• Fix code-generation issue for deep-copy of generic objects (https://github.com/rrousselGit/freezed/issues/128)

• Fixes a bug where classes with both getters and consts constructors caused an exception. (https://github.com/rrousselGit/freezed/issues/142)

• do not create @required annotation for positional arguments on when/map functions (thanks to @hpoul)
• Fix == returning false for classes with "other" prop (thanks to @mhmdanas)

Fixes classes with getters and a private MyClass._() constructor not properly generating.

Fixed Freezed trying to generate code for factory constructors with a complex body.

• Fixes Freezed trying to generate code for files that don't use it

• Fixes a bug where deep copy did not compile if the class definitions were spread on multiple files.

• Fixed a stack-overflow during generation on recursive classes
• Fixed invalid generated code for classes with a concrete constructor + using Diagnosticable

• Consider optional parameters with a default value as non-nullable
• Add deep-copy support
• Allow the class to define methods/getters
• Do not override toString if the user-defined class already overrides toString

Fixes parsing of recursive classes

Support enum and static const default values

Support class-level decorators (see https://github.com/rrousselGit/freezed/issues/50)

Generated file now ignores invalid_override_different_default_values_named

Now also generate constructor tear-off.

Fixes @Default generating invalid code if the default value explicitly used const.