chore: Fix typos (#4065)

Author: spydon

packages/flutter_riverpod/test/future_provider_test.dart

@@ -77,7 +77,7 @@ void main() {
     expect(whenStack, isNotNull);
   });
 
-  testWidgets("future completes after unmount does't crash", (tester) async {
+  testWidgets("future completes after unmount doesn't crash", (tester) async {
     final completer = Completer<int>();
     final futureProvider = FutureProvider((s) => completer.future);
 
@@ -101,7 +101,7 @@ void main() {
     await Future<void>.value();
   });
 
-  testWidgets("future fails after unmount does't crash", (tester) async {
+  testWidgets("future fails after unmount doesn't crash", (tester) async {
     final completer = Completer<int>();
     final futureProvider = FutureProvider((s) => completer.future);
 

packages/riverpod/lib/src/core/element.dart

@@ -958,7 +958,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu
   void onDispose(void Function() listener) {
     _assertNotOutdated();
     if (!_mounted) {
-      throw StateError('Cannot call onDispose after a provider was dispose');
+      throw StateError('Cannot call onDispose after a provider was disposed');
     }
     _onDisposeListeners ??= [];
     _onDisposeListeners!.add(listener);

packages/riverpod/lib/src/core/ref.dart

@@ -59,7 +59,8 @@ abstract class Ref<State extends Object?> {
   /// But if a provider is not listened to, the rebuild may be delayed until
   /// the provider is listened to again.
   ///
-  /// Calling [invalidate] multiple times will cause a single recomputation of the state.
+  /// Calling [invalidate] multiple times will cause a single recomputation of
+  /// the state.
   ///
   /// If used on a provider which is not initialized or disposed,
   /// this method will have no effect.

packages/riverpod/test/old/framework/provider_container_test.dart

@@ -502,7 +502,7 @@ void main() {
       });
 
       test(
-          'list only elements associated with the container (ignoring inherited and descendent elements)',
+          'list only elements associated with the container (ignoring inherited and descendant elements)',
           () {
         final provider = Provider((ref) => 0);
         final provider2 = Provider((ref) => 0);

packages/riverpod/test/old/framework/provider_element_test.dart

@@ -1167,7 +1167,7 @@ void main() {
 
     // schedules `dep` and `dependent` to rebuild
     // Will build `dependent` before `dep` because `dependent` doesn't depend on `dep` yet
-    // And since nothing is watchin `dep` at the moment, then `dependent` will
+    // And since nothing is watching `dep` at the moment, then `dependent` will
     // rebuild before `dep` even though `dep` is its ancestor.
     // This is fine since nothing is listening to `dep` yet, but it should
     // not cause certain assertions to trigger

packages/riverpod/test/src/providers/async_notifier_test.dart

@@ -458,11 +458,11 @@ void main() {
 
           final sub = container.listen(provider.notifier, (previous, next) {});
 
-          // ignore: prefer_const_constructors, not using `const` as we voluntarility break identity to test `identical`
+          // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical`
           final newState = AsyncData(84);
-          // ignore: prefer_const_constructors, not using `const` as we voluntarility break identity to test `identical`
+          // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical`
           final newLoading = AsyncLoading<int>();
-          // ignore: prefer_const_constructors, not using `const` as we voluntarility break identity to test `identical`
+          // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical`
           final newError = AsyncError<int>(84, StackTrace.empty);
 
           sub.read().state = newState;
@@ -704,7 +704,7 @@ void main() {
           await expectLater(sub.read().future, completion(1));
         });
 
-        test('retuns a Future identical to that of .future', () {
+        test('returns a Future identical to that of .future', () {
           final listener = OnBuildMock();
           final dep = StateProvider((ref) => 0);
           final provider = factory.simpleTestProvider<int>(
@@ -806,7 +806,7 @@ void main() {
         );
       });
 
-      group('AsyncNotifer.update', () {
+      group('AsyncNotifier.update', () {
         test('passes in the latest state', () async {
           final container = ProviderContainer.test();
           final provider = factory.simpleTestProvider<int>(
@@ -870,8 +870,7 @@ void main() {
           expect(container.read(provider), const AsyncData(21));
         });
 
-        test(
-            'executes immediately with current state if a state is avalailable',
+        test('executes immediately with current state if a state is available',
             () async {
           final container = ProviderContainer.test();
           final provider = factory.simpleTestProvider<int>((ref) => 1);
@@ -887,8 +886,7 @@ void main() {
           expect(container.read(provider), const AsyncData(2));
         });
 
-        test(
-            'executes immediately with current state if an error is avalailable',
+        test('executes immediately with current state if an error is available',
             () async {
           final container = ProviderContainer.test();
           final provider = factory.simpleTestProvider<int>(

packages/riverpod/test/src/providers/notifier_test.dart

@@ -295,7 +295,7 @@ void main() {
       });
 
       test(
-          'Reading the state inside the notifier rethrows initilization error, if any',
+          'Reading the state inside the notifier rethrows initialization error, if any',
           () {
         final provider = factory
             .simpleTestProvider<int>((ref) => throw UnimplementedError());

packages/riverpod/test/src/providers/stream_notifier_test.dart

@@ -359,11 +359,11 @@ void main() {
           final sub = container.listen(provider.notifier, (previous, next) {});
           await container.read(provider.future);
 
-          // ignore: prefer_const_constructors, not using `const` as we voluntarility break identity to test `identical`
+          // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical`
           final newState = AsyncData(84);
-          // ignore: prefer_const_constructors, not using `const` as we voluntarility break identity to test `identical`
+          // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical`
           final newLoading = AsyncLoading<int>();
-          // ignore: prefer_const_constructors, not using `const` as we voluntarility break identity to test `identical`
+          // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical`
           final newError = AsyncError<int>(84, StackTrace.empty);
 
           sub.read().state = newState;
@@ -721,7 +721,7 @@ void main() {
         );
       });
 
-      group('AsyncNotifer.update', () {
+      group('AsyncNotifier.update', () {
         test('passes in the latest state', () async {
           final container = ProviderContainer.test();
           final provider = factory.simpleTestProvider<int>(

packages/riverpod_analyzer_utils/lib/src/riverpod_ast/visitor.dart

@@ -756,7 +756,7 @@ class RiverpodAstRegistry {
   }
 }
 
-// Voluntarily not extenting RiverpodAstVisitor to trigger a compilation error
+// Voluntarily not extending RiverpodAstVisitor to trigger a compilation error
 // when new nodes are added.
 class _RiverpodAstRegistryVisitor extends RiverpodAstVisitor {
   _RiverpodAstRegistryVisitor(this._registry);

packages/riverpod_generator/lib/src/riverpod_generator.dart

@@ -48,7 +48,7 @@ class RiverpodInvalidGenerationSourceError
 
   final AstNode? astNode;
 
-  // TODO overrride toString to render AST nodes.
+  // TODO override toString to render AST nodes.
 }
 
 @immutable

packages/riverpod_generator/test/integration/split.dart

@@ -1,4 +1,4 @@
-// Regresion test for https://github.com/rrousselGit/riverpod/issues/2175
+// Regression test for https://github.com/rrousselGit/riverpod/issues/2175
 import 'package:riverpod/riverpod.dart';
 import 'package:riverpod_annotation/riverpod_annotation.dart';
 

packages/riverpod_lint/CHANGELOG.md

@@ -93,7 +93,7 @@ Bump custom_lint
 
 ## 2.3.0 - 2023-10-06
 
-- Added `async_value_nullable_patttern` lint, to warn against using `AsyncValue(:final value?)` in pattern match when `value` is possibly nullable.
+- Added `async_value_nullable_pattern` lint, to warn against using `AsyncValue(:final value?)` in pattern match when `value` is possibly nullable.
 - Added `protected_notifier_state` lint, which warns against using the `Notifier.state`
   property of a notifier different than the current one.
   Aka a Notifier "A" should not directly access the `state` if a Notifier "B".

packages/riverpod_lint/README.md

@@ -52,7 +52,7 @@ Riverpod_lint adds various warnings with quick fixes and refactoring options, su
   - [notifier\_extends (riverpod\_generator only)](#notifier_extends-riverpod_generator-only)
   - [avoid\_ref\_inside\_state\_dispose](#avoid_ref_inside_state_dispose)
   - [notifier\_build (riverpod\_generator only)](#notifier_build-riverpod_generator-only)
-  - [async\_value\_nullable\_patttern](#async_value_nullable_patttern)
+  - [async\_value\_nullable\_pattern](#async_value_nullable_pattern)
 - [protected\_notifier\_properties](#protected_notifier_properties)
 - [All assists](#all-assists)
   - [Wrap widgets with a `Consumer`](#wrap-widgets-with-a-consumer)
@@ -611,7 +611,7 @@ class Example extends _$Example {
 class Example extends _$Example {}
 ```
 
-### async_value_nullable_patttern
+### async_value_nullable_pattern
 
 Warn if the pattern `AsyncValue(:final value?)` is used when the data
 is possibly nullable.

packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart

@@ -231,7 +231,7 @@ class $createdStateClassName extends $baseStateName<${widgetClass.name}> {
   }
 }
 
-// Original implemenation in
+// Original implementation in
 // package:analysis_server/lib/src/services/correction/dart/flutter_convert_to_stateful_widget.dart
 class _FieldFinder extends RecursiveAstVisitor<void> {
   Set<FieldElement> fieldsAssignedInConstructors = {};

packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart

@@ -275,7 +275,7 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist {
   }
 }
 
-// Original implemenation in
+// Original implementation in
 // package:analysis_server/lib/src/services/correction/dart/flutter_convert_to_stateless_widget.dart
 class _FieldFinder extends RecursiveAstVisitor<void> {
   final fieldsAssignedInConstructors = <FieldElement>{};

packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart

@@ -151,7 +151,7 @@ ClassDeclaration? findStateClass(ClassDeclaration widgetClass) {
   });
 }
 
-// Original implemenation in package:analyzer/lib/src/dart/ast/extensions.dart
+// Original implementation in package:analyzer/lib/src/dart/ast/extensions.dart
 extension IdentifierExtension on Identifier {
   Element? get writeOrReadElement {
     return _writeElement(this) ?? staticElement;

website/docs/concepts/about_hooks.mdx

@@ -49,7 +49,7 @@ such as [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEdit
 [AnimationController](https://api.flutter.dev/flutter/animation/AnimationController-class.html).  
 They can also serve as a replacement to the "builder" pattern, replacing widgets
 such as [FutureBuilder](https://api.flutter.dev/flutter/widgets/FutureBuilder-class.html)/[TweenAnimatedBuilder](https://api.flutter.dev/flutter/widgets/TweenAnimationBuilder-class.html)
-by an alterative that does not invole "nesting" – drastically improving readability.
+by an alternative that does not involve "nesting" – drastically improving readability.
 
 In general, hooks are helpful for:
 

website/docs/essentials/auto_dispose.mdx

@@ -121,7 +121,7 @@ Although in this case, this will always result in a new state being created.
 
 :::tip
 When trying to invalidate a provider which receives parameters,
-it is posible to either invalidate one specific parameter combination,
+it is possible to either invalidate one specific parameter combination,
 or all parameter combinations at once:
 
 <AutoSnippet {...invalidateFamilyExample} />

website/docs/essentials/first_request.mdx

@@ -309,7 +309,7 @@ Instead of writing a `StatelessWidget`/`StatefulWidget` returns a `Consumer`, we
 define a `ConsumerWidget`/`ConsumerStatefulWidget`.  
 `ConsumerWidget` and `ConsumerStatefulWidget` are effectively the fusion
 of a `StatelessWidget`/`StatefulWidget` and a `Consumer`. They behave the same
-as their original couterpart, but with the added benefit of offering a "ref".
+as their original counterpart, but with the added benefit of offering a "ref".
 
 We can rewrite the previous examples to use `ConsumerWidget` as followed:
 

website/docs/essentials/side_effects.mdx

@@ -194,7 +194,7 @@ This method should not be called directly.
 />
 </When>
 
-<!-- Some separation for good mesure -->
+<!-- Some separation for good measure -->
 
 <When codegen={true}>
 <Legend
@@ -386,7 +386,7 @@ This can be done by calling `ref.invalidateSelf()` after the _POST_ request:
 ### Updating the local cache manually
 
 Another option is to update the local cache manually.  
-This would involve trying to mimick the backend's behavior.
+This would involve trying to mimic the backend's behavior.
 For instance, we would need to know whether the backend inserts new items
 at the start or at the end.
 

website/docs/from_provider/motivation/motivation.mdx

@@ -22,11 +22,11 @@ In particular, this section should answer the following:
   - Can I migrate incrementally?
   - etc.
 
-By the end of this section you should be convinced that Riverpod is to be prefered over Provider. 
+By the end of this section you should be convinced that Riverpod is to be preferred over Provider.
 
 **Riverpod is indeed a more modern, recommended and reliable approach when compared to Provider**.
 
-Riverpod offers better State Management capabilities, better Caching strategies and a simplified Reactivty model.  
+Riverpod offers better State Management capabilities, better Caching strategies and a simplified Reactivity model.
 Whereas, Provider is currently lacking in many areas with no way forward.
 
 ## Provider's Limitations
@@ -73,7 +73,7 @@ has changed (e.g. such as when there's a GlobalKey involved in the widget tree).
 Nonetheless, Provider has an ad-hoc solution named `ProxyProvider`, but it's considered tedious and error-prone.
 
 Combining state is a core Riverpod mechanism, as we can combine and cache values reactively with zero overhead 
-with simple yet powerful utilites such as [ref.watch] and [ref.listen]:
+with simple yet powerful utilities such as [ref.watch] and [ref.listen]:
 
 <AutoSnippet language="dart" {...combine}></AutoSnippet>
 
@@ -121,7 +121,7 @@ Thus, obtaining a `.family` equivalent for Provider is fundamentally impossible
 To be able to write a test, you *have to* re-define providers inside each test.
 
 With Riverpod, providers are ready to use inside tests, by default. Furthermore, Riverpod exposes a 
-handy collection of "overriding" utilites that are crucial when mocking Providers.
+handy collection of "overriding" utilities that are crucial when mocking Providers.
 
 Testing the combined state snippet above would be as simple as the following:
 

website/docs/from_provider/quickstart.mdx

@@ -151,7 +151,7 @@ A full guide about eager initialization of pkg:Riverpod's providers [is availabl
 As a side note, chances are that when metaprogramming will be a thing, codegen will be default for Riverpod.
 
 Unluckily, `@riverpod` can't generate code for `ChangeNotifierProvider`.  
-To overcome this, you can use the following utility extesion method:
+To overcome this, you can use the following utility extension method:
 ```dart
 extension ChangeNotifierWithCodeGenExtension on Ref {
   T listenAndDisposeChangeNotifier<T extends ChangeNotifier>(T notifier) {

website/docs/migration/from_change_notifier.mdx

@@ -18,9 +18,9 @@ pkg:provider.
 If you've just started a migration to pkg:riverpod, make sure you read the dedicated guide
 (see <Link documentID="from_provider/quickstart" />).
 This article is meant for folks that already transitioned to riverpod, but want to move away from
-`ChangeNotifier` definetively.
+`ChangeNotifier`.
 
-All in all, migrating from `ChangeNotifier` to `AsyncNotifer` requires a
+All in all, migrating from `ChangeNotifier` to `AsyncNotifier` requires a
 paradigm shift, but it brings great simplification with the resulting migrated
 code. See also <Link documentID="concepts/why_immutability" />.
 
@@ -30,14 +30,14 @@ Take this (faulty) example:
 This implementation shows several weak design choices such as:
 - The usage of `isLoading` and `hasError` to handle different asynchronous cases
 - The need to carefully handle requests with tedious `try`/`catch`/`finally` expressions
-- The need to inkove `notifyListeners` at the right times to make this implementation work
+- The need to invoke `notifyListeners` at the right times to make this implementation work
 - The presence of inconsistent or possibly undesirable states, e.g. initialization with an empty list
 
 Note how this example has been crafted to show how `ChangeNotifier` can lead to faulty design choices
 for newbie developers; also, another takeaway is that mutable state might be way harder than it
 initially promises.
 
-`Notifier`/`AsyncNotifer`, in combination with immutable state, can lead to better design choices
+`Notifier`/`AsyncNotifier`, in combination with immutable state, can lead to better design choices
 and less errors.
 
 Let's see how to migrate the above snippet, one step at a time, towards the newest APIs.
@@ -94,7 +94,7 @@ to smooth out the migration at first.
 
 
 ### Initialization
-Initalizing a notifier is easy: just write initialization logic inside `build`.  
+Initializing a notifier is easy: just write initialization logic inside `build`.
 We can now get rid of the old `_init` function.
 
 <AutoSnippet language="dart" {...initialization}></AutoSnippet>