autoequal_gen 0.7.1

Code generator which can simplify work with 'equatable'. It will generate 'List<Object?> props' private extensions for all annotated classes.

Provides Dart Build System builder for generating List<Object?> _$props private extensions for classes annotated with autoequal.

Usage

In your pubspec.yaml file

• Add autoequal to your dependencies
• Add autoequal_gen to your dev_dependencies
• Add build_runner to your dev_dependencies

Annotate your class with @autoequal annotation

import 'package:autoequal/autoequal.dart';
import 'package:equatable/equatable.dart';

part 'some_class.g.dart';

@autoequal
class SomeClass extends Equatable {
  const SomeClass({this.id, this.random});

  final String id;

  @override
  List<Object?> get props => _$props; //_$props will be generated
}

Make sure that you set the part file as in the example above part 'your_file_name.g.dart';.

Launch code generation

flutter pub run build_runner build

The extension will be generated

// GENERATED CODE - DO NOT MODIFY BY HAND

part of 'some_class.dart';

// **************************************************************************
// AutoequalGenerator
// **************************************************************************

extension _$SomeClassAutoequal on SomeClass {
  List<Object> get _$props => [id];
}

---

Alternative usage

The @autoequal is smart enough to handle the EquatableMixin mixin automatically.

Instead of extending Equatable, you can add it as a mixin, along with the generated autoequal mixin

@autoequal
class SomeClass with EquatableMixin, _$SomeClassAutoequalMixin {
  const SomeClass({this.id});

  final String id;
}

If you'd like to not write the List<Object?> get props getter, you can use the @autoequalMixin annotation while extending Equatable:

@autoequalMixin
class SomeClass extends Equatable with _$SomeClassAutoequalMixin {
  const SomeClass({this.id});

  final String id;
}

The two approaches will generate the same code.

mixin _$SomeClassAutoequalMixin on Equatable {
  @override
  List<Object?> get props => _$SomeClassAutoequal(this)._$props;
}

---

Inheritance

If your class extends another class that uses Equatable, you can use the @autoequal annotation to generate the props without having to extend Equatable or use the mixin EquatableMixin.

@autoequal
class BaseClass extends Equatable {
  const BaseClass({this.id});

  final String id;

  @override
  List<Object?> get props => _$props;
}

@autoequal
class SubClass extends BaseClass {
  const SubClass({required this.name, required super.id});

  final String name;


  @override
  List<Object?> get props => [
    ...super.props, // make sure to include the super props!
    ..._$props,
  ];
}

// --- OR ---

@autoequalMixin
class SubClass extends BaseClass with _$SubClassAutoequalMixin {
  const SubClass({required this.name, required super.id});

  final String name;
}

// generated code
extension _$SubClassAutoequal on SubClass {
  List<Object?> get _$props => [name];
}

mixin _$SubClassAutoequalMixin on Equatable {
  @override
  List<Object?> get props => [
    ...super.props,
    ..._$SubClassAutoequal(this as SubClass)._$props,
  ];
}

---

Field/Getter annotations

Ignore

You can include fields or getter methods in props by annotating them with @ignoreAutoequal.

@ignoreAutoequal
final int random;

Include

You can include fields or getter methods in props by annotating them with @includeAutoequal.

@includeAutoequal
String get id => _id;

Build.yaml options

By default, the builder will ignore all getter methods in props, but you can change this behavior by adding the following to your build.yaml file:

targets:
  $default:
    builders:

      autoequal_gen:
        enabled: true
        options:
          include_getters: true # default is false

---