feat: keepAliveRiverpod shorthand

packages/riverpod_annotation/CHANGELOG.md

@@ -1,6 +1,7 @@
 ## Unreleased patch
 
 - Improved `@Riverpod(dependencies: [...])` documentation.
+- Introduces `@keepAliveRiverpod` shorthand.
 
 ## 2.3.3 - 2023-11-27
 

packages/riverpod_annotation/lib/src/riverpod_annotation.dart

@@ -46,6 +46,10 @@ class Riverpod {
   /// // By not specifying "dependencies", we are saying that this provider is never scoped
   /// @riverpod
   /// Foo root(RootRef ref) => Foo();
+  /// 
+  /// @keepAliveRiverpod
+  /// Foo root(RootRef ref) => Foo();
+  /// 
   /// // By specifying "dependencies" (even if the list is empty),
   /// // we are saying that this provider is potentially scoped
   /// @Riverpod(dependencies: [])
@@ -63,6 +67,13 @@ class Riverpod {
   ///   // as such "dependencies" is optional
   /// }
   ///
+  /// @keepAliveRiverpod
+  /// Object? dependent(DependentRef ref) {
+  ///   ref.watch(rootProvider);
+  ///   // This provider (with keepAlive set to true) does not depend on any scoped provider,
+  ///   // as such "dependencies" is optional
+  /// }
+  ///
   /// @Riverpod(dependencies: [])
   /// Object? dependent(DependentRef ref) {
   ///   ref.watch(rootProvider);
@@ -105,6 +116,10 @@ class Riverpod {
 @Target({TargetKind.classType, TargetKind.function})
 const riverpod = Riverpod();
 
+/// {@macro riverpod_annotation.provider}
+@Target({TargetKind.classType, TargetKind.function})
+const keepAliveRiverpod = Riverpod(keepAlive: true);
+
 /// An annotation used to help the linter find the user-defined element from
 /// the generated provider.
 ///