Merge with master

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,34 @@
+## Related Issues
+
+fixes #your-issue-number
+
+<!--
+  Update to link the issue that is going to be fixed by this.
+  Unless this concerns documentation, make sure to create an issue first
+  before raising a PR.
+
+  You do not need to describe what this PR is doing, as this should
+  already be covered by the associated issue.
+  If the linked issue isn't enough, then chances are a new issue
+  is needed.
+
+  Don't hesitate to create many issues! This can avoid working
+  on something, only to have your PR closed or have to be rewritten
+  due to a disagreement/misunderstanding.
+ -->
+
+## Checklist
+
+Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (`[x]`).
+
+- [ ] I have updated the `CHANGELOG.md` of the relevant packages.
+      Changelog files must be edited under the form:
+
+  ```md
+  ## Unreleased fix/major/minor
+
+  - Description of your change. (thanks to @yourGithubId)
+  ```
+
+- [ ] If this contains new features or behavior changes,
+      I have updated the documentation to match those changes.

CONTRIBUTING.md

@@ -68,7 +68,7 @@ Finally, head to `localhost:3000`
 ### Adding new language
 
 Riverpod supports multiple languages.  
-To add new languages, it is recommended to follow the [i18n](https://docusaurus.io/fr/docs/i18n/introduction)
+To add new languages, it is recommended to follow the [i18n](https://docusaurus.io/docs/i18n/introduction)
 documentation of Docusaurus.
 
 The English documentation is hosted in [`/website/docs`](https://github.com/rrousselGit/riverpod/tree/master/website/docs).  
@@ -119,4 +119,4 @@ your code snippets should support those.
 This is done by having a separate `.dart` file for each possible scenario.  
 Again, look at the [Getting Started] for an example.
 
-[Getting Started]: https://github.com/rrousselGit/riverpod/blob/rework-flow/website/docs/introduction/getting_started.mdx
+[Getting Started]: https://github.com/rrousselGit/riverpod/blob/master/website/docs/introduction/getting_started.mdx

all_lint_rules.yaml

@@ -7,6 +7,7 @@ linter:
     - always_specify_types
     - always_use_package_imports
     - annotate_overrides
+    - annotate_redeclares
     - avoid_annotating_with_dynamic
     - avoid_bool_literals_in_conditional_expressions
     - avoid_catches_without_on_clauses
@@ -44,6 +45,7 @@ linter:
     - avoid_types_as_parameter_names
     - avoid_types_on_closure_parameters
     - avoid_unnecessary_containers
+    - avoid_unstable_final_fields
     - avoid_unused_constructor_parameters
     - avoid_void_async
     - avoid_web_libraries_in_flutter

examples/counter/README.md

@@ -1,6 +1,6 @@
 The standard Flutter Counter example built with [Riverpod]
 
-This uses `ProvidedScope`.
+This uses `ProviderScope`.
 
 
 [riverpod]: https://github.com/rrousselGit/riverpod

examples/counter/pubspec.yaml

@@ -24,7 +24,7 @@ dependencies:
 
 dev_dependencies:
   build_runner: ^2.3.3
-  custom_lint: ^0.5.2
+  custom_lint: ^0.6.0
   flutter_test:
     sdk: flutter
   freezed: ^2.3.2

examples/marvel/lib/src/configuration.freezed.dart

@@ -12,7 +12,7 @@ part of 'configuration.dart';
 T _$identity<T>(T value) => value;
 
 final _privateConstructorUsedError = UnsupportedError(
-    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods');
+    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models');
 
 Configuration _$ConfigurationFromJson(Map<String, dynamic> json) {
   return _Configuration.fromJson(json);
@@ -125,7 +125,7 @@ class _$ConfigurationImpl implements _Configuration {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$ConfigurationImpl &&

examples/marvel/lib/src/marvel.freezed.dart

@@ -12,7 +12,7 @@ part of 'marvel.dart';
 T _$identity<T>(T value) => value;
 
 final _privateConstructorUsedError = UnsupportedError(
-    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods');
+    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models');
 
 /// @nodoc
 mixin _$MarvelListCharactersResponse {
@@ -130,7 +130,7 @@ class _$MarvelListCharactersResponseImpl
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$MarvelListCharactersResponseImpl &&
@@ -307,7 +307,7 @@ class _$CharacterImpl implements _Character {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$CharacterImpl &&
@@ -465,7 +465,7 @@ class _$ThumbnailImpl extends _Thumbnail {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$ThumbnailImpl &&
@@ -621,7 +621,7 @@ class _$MarvelResponseImpl implements _MarvelResponse {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$MarvelResponseImpl &&
@@ -778,7 +778,7 @@ class _$MarvelDataImpl implements _MarvelData {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$MarvelDataImpl &&

examples/marvel/lib/src/result.freezed.dart

@@ -12,7 +12,7 @@ part of 'result.dart';
 T _$identity<T>(T value) => value;
 
 final _privateConstructorUsedError = UnsupportedError(
-    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods');
+    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models');
 
 /// @nodoc
 mixin _$Result<T> {
@@ -118,7 +118,7 @@ class _$ResultDataImpl<T> extends _ResultData<T> {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$ResultDataImpl<T> &&
@@ -257,7 +257,7 @@ class _$ResultErrorImpl<T> extends _ResultError<T> {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$ResultErrorImpl<T> &&

examples/marvel/lib/src/screens/home.dart

@@ -92,7 +92,12 @@ class Home extends HookConsumerWidget {
             return Scaffold(
               appBar: AppBar(title: const Text('Error')),
               body: Center(
-                child: Text('$err'),
+                child: Text(
+                  switch (err) {
+                    DioException() => err.message ?? '$err',
+                    _ => '$err',
+                  },
+                ),
               ),
             );
           },

examples/marvel/lib/src/screens/home.freezed.dart

@@ -12,7 +12,7 @@ part of 'home.dart';
 T _$identity<T>(T value) => value;
 
 final _privateConstructorUsedError = UnsupportedError(
-    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods');
+    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models');
 
 /// @nodoc
 mixin _$CharacterPagination {
@@ -116,7 +116,7 @@ class _$CharacterPaginationImpl implements _CharacterPagination {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$CharacterPaginationImpl &&
@@ -252,7 +252,7 @@ class _$CharacterOffsetImpl implements _CharacterOffset {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$CharacterOffsetImpl &&

examples/marvel/pubspec.yaml

@@ -3,7 +3,7 @@ description: A new Flutter project.
 publish_to: "none"
 
 environment:
-  sdk: ">=3.0.0-0.0-dev <4.0.0"
+  sdk: ">=3.0.0 <4.0.0"
   flutter: ">=1.17.0"
 
 dependencies:

examples/pub/lib/pub_repository.freezed.dart

@@ -12,7 +12,7 @@ part of 'pub_repository.dart';
 T _$identity<T>(T value) => value;
 
 final _privateConstructorUsedError = UnsupportedError(
-    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods');
+    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models');
 
 PackageMetricsScore _$PackageMetricsScoreFromJson(Map<String, dynamic> json) {
   return _PackageMetricsScore.fromJson(json);
@@ -198,7 +198,7 @@ class _$PackageMetricsScoreImpl
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$PackageMetricsScoreImpl &&
@@ -385,7 +385,7 @@ class _$PackageMetricsResponseImpl
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$PackageMetricsResponseImpl &&
@@ -547,7 +547,7 @@ class _$PackageDetailsImpl
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$PackageDetailsImpl &&
@@ -721,7 +721,7 @@ class _$PackageImpl with DiagnosticableTreeMixin implements _Package {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$PackageImpl &&
@@ -883,7 +883,7 @@ class _$LikedPackageImpl with DiagnosticableTreeMixin implements _LikedPackage {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$LikedPackageImpl &&
@@ -1044,7 +1044,7 @@ class _$LikesPackagesResponseImpl
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$LikesPackagesResponseImpl &&
@@ -1201,7 +1201,7 @@ class _$PubPackagesResponseImpl
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$PubPackagesResponseImpl &&
@@ -1350,7 +1350,7 @@ class _$SearchPackageImpl
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$SearchPackageImpl &&
@@ -1502,7 +1502,7 @@ class _$PubSearchResponseImpl
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$PubSearchResponseImpl &&

examples/stackoverflow/lib/question.freezed.dart

@@ -12,7 +12,7 @@ part of 'question.dart';
 T _$identity<T>(T value) => value;
 
 final _privateConstructorUsedError = UnsupportedError(
-    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods');
+    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models');
 
 QuestionsResponse _$QuestionsResponseFromJson(Map<String, dynamic> json) {
   return _QuestionsResponse.fromJson(json);
@@ -132,7 +132,7 @@ class _$QuestionsResponseImpl implements _QuestionsResponse {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$QuestionsResponseImpl &&
@@ -476,7 +476,7 @@ class _$QuestionImpl implements _Question {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$QuestionImpl &&
@@ -683,7 +683,7 @@ class _$QuestionThemeImpl implements _QuestionTheme {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$QuestionThemeImpl &&

examples/stackoverflow/lib/tag.freezed.dart

@@ -12,7 +12,7 @@ part of 'tag.dart';
 T _$identity<T>(T value) => value;
 
 final _privateConstructorUsedError = UnsupportedError(
-    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods');
+    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models');
 
 /// @nodoc
 mixin _$TagTheme {
@@ -153,7 +153,7 @@ class _$TagThemeImpl implements _TagTheme {
   }
 
   @override
-  bool operator ==(dynamic other) {
+  bool operator ==(Object other) {
     return identical(this, other) ||
         (other.runtimeType == runtimeType &&
             other is _$TagThemeImpl &&