feat(repo): Move code snippets into a separate package (#34)

xsahil03x · web-flow · commit 29ac8911a7c3 · 2025-09-16T17:14:57.000+02:00
diff --git a/docs/analysis_options.yaml b/docs/analysis_options.yaml
@@ -0,0 +1,10 @@
+include: ../analysis_options.yaml
+
+analyzer:
+  errors:
+    unused_local_variable: ignore
+
+linter:
+  rules:
+    file_names: false
+    avoid_redundant_argument_values: false
diff --git a/docs/code_snippets/01_01_quickstart.dart b/docs/code_snippets/01_01_quickstart.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: prefer_const_constructors, unused_local_variable, file_names, depend_on_referenced_packages
-
 import 'package:flutter/widgets.dart';
 import 'package:flutter_state_notifier/flutter_state_notifier.dart';
 import 'package:stream_feed/stream_feed.dart';
@@ -14,7 +12,7 @@ Future<void> gettingStarted() async {
   // Initialize the client
   final client = StreamFeedsClient(
     apiKey: '<your_api_key>',
-    user: User(id: 'john'),
+    user: const User(id: 'john'),
     tokenProvider: TokenProvider.static(UserToken('<user_token>')),
   );
   await client.connect();
@@ -25,7 +23,10 @@ Future<void> gettingStarted() async {
 
   // Add activity
   final activity = await feed.addActivity(
-    request: FeedAddActivityRequest(type: 'post', text: 'Hello, Stream Feeds!'),
+    request: const FeedAddActivityRequest(
+      type: 'post',
+      text: 'Hello, Stream Feeds!',
+    ),
   );
 }
 
@@ -37,12 +38,12 @@ Future<void> socialMediaFeed() async {
   // Add a reaction to activity
   await timeline.addReaction(
     activityId: 'activity_123',
-    request: AddReactionRequest(type: 'like'),
+    request: const AddReactionRequest(type: 'like'),
   );
 
   // Add a comment to activity
   await timeline.addComment(
-    request: ActivityAddCommentRequest(
+    request: const ActivityAddCommentRequest(
       comment: 'Great post!',
       activityId: 'activity_123',
     ),
@@ -51,12 +52,12 @@ Future<void> socialMediaFeed() async {
   // Add a reaction to comment
   final activity = client.activity(
     activityId: 'activity_123',
-    fid: FeedId(group: 'timeline', id: 'john'),
+    fid: const FeedId(group: 'timeline', id: 'john'),
   );
 
   await activity.addCommentReaction(
     commentId: 'commentId',
-    request: AddCommentReactionRequest(type: 'like'),
+    request: const AddCommentReactionRequest(type: 'like'),
   );
 }
 
@@ -67,18 +68,18 @@ Future<void> notificationFeed() async {
 
   // Mark notifications as read
   await notifications.markActivity(
-    request: MarkActivityRequest(markAllRead: true),
+    request: const MarkActivityRequest(markAllRead: true),
   );
 }
 
 Future<void> polls() async {
   // Create a poll
-  final feedId = FeedId(group: 'timeline', id: 'john');
+  const feedId = FeedId(group: 'timeline', id: 'john');
   final feed = client.feedFromId(feedId);
   final result = await feed.createPoll(
-    request: CreatePollRequest(
+    request: const CreatePollRequest(
       name: "What's your favorite color?",
-      options: const [
+      options: [
         PollOptionInput(text: 'Red'),
         PollOptionInput(text: 'Blue'),
         PollOptionInput(text: 'Green'),
@@ -91,13 +92,13 @@ Future<void> polls() async {
   final activityData = result.getOrThrow();
   final activity = client.activity(activityId: activityData.id, fid: feedId);
   await activity.castPollVote(
-    CastPollVoteRequest(vote: VoteData(optionId: 'option_456')),
+    const CastPollVoteRequest(vote: VoteData(optionId: 'option_456')),
   );
 }
 
 Future<void> customActivityTypes() async {
   final workoutActivity = await feed.addActivity(
-    request: FeedAddActivityRequest(
+    request: const FeedAddActivityRequest(
       text: 'Just finished my run',
       custom: {'distance': 5.2, 'duration': 1800, 'calories': 450},
       type: 'workout',
diff --git a/docs/code_snippets/03_01_activities.dart b/docs/code_snippets/03_01_activities.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: unused_local_variable, file_names, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/03_02_querying_activities.dart b/docs/code_snippets/03_02_querying_activities.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: unused_local_variable, file_names, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/03_03_file_uploads.dart b/docs/code_snippets/03_03_file_uploads.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: unused_local_variable, file_names, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/04_01_feeds.dart b/docs/code_snippets/04_01_feeds.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: file_names, unused_local_variable, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/04_02_feeds_and_activity_visibility.dart b/docs/code_snippets/04_02_feeds_and_activity_visibility.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: file_names, unused_local_variable, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/04_03_follows.dart b/docs/code_snippets/04_03_follows.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: file_names, unused_local_variable, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/05_01_intro_defaults.dart b/docs/code_snippets/05_01_intro_defaults.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: file_names, unused_local_variable, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/05_02_feed_views.dart b/docs/code_snippets/05_02_feed_views.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: file_names, unused_local_variable, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/05_06_notification_feeds.dart b/docs/code_snippets/05_06_notification_feeds.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: file_names, unused_local_variable, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/05_07_processors.dart b/docs/code_snippets/05_07_processors.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: file_names, unused_local_variable, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/06_01_reactions.dart b/docs/code_snippets/06_01_reactions.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: file_names, unused_local_variable, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/06_02_bookmarks.dart b/docs/code_snippets/06_02_bookmarks.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: file_names, unused_local_variable, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/06_03_comments.dart b/docs/code_snippets/06_03_comments.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: file_names, unused_local_variable, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/06_04_pins.dart b/docs/code_snippets/06_04_pins.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: file_names, unused_local_variable, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/07_01_state_layer.dart b/docs/code_snippets/07_01_state_layer.dart
diff --git a/docs/code_snippets/08_01_events.dart b/docs/code_snippets/08_01_events.dart
diff --git a/docs/code_snippets/09_01_polls.dart b/docs/code_snippets/09_01_polls.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: file_names, unused_local_variable, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/code_snippets/10_01_push_notifications.dart b/docs/code_snippets/10_01_push_notifications.dart
diff --git a/docs/code_snippets/11_01_moderation.dart b/docs/code_snippets/11_01_moderation.dart
@@ -1,5 +1,3 @@
-// ignore_for_file: file_names, unused_local_variable, avoid_redundant_argument_values
-
 import 'package:stream_feed/stream_feed.dart';
 
 late StreamFeedsClient client;
diff --git a/docs/pubspec.yaml b/docs/pubspec.yaml
@@ -0,0 +1,10 @@
+name: docs
+
+environment:
+  sdk: ^3.6.2
+
+dev_dependencies:
+  flutter:
+    sdk: flutter
+  flutter_state_notifier: ^1.0.0
+  stream_feed: ^0.7.0
diff --git a/melos.yaml b/melos.yaml
@@ -5,6 +5,7 @@ versioning:
   mode: independent
 
 packages:
+  - docs
   - sample_app
   - packages/*
   - packages/*/example
diff --git a/pubspec.lock b/pubspec.lock
diff --git a/pubspec.yaml b/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-// ignore_for_file: unused_local_variable, file_names, avoid_redundant_argument_values`
`2`		`-`
`3`	`1`	`import 'package:stream_feed/stream_feed.dart';`
`4`	`2`
`5`	`3`	`late StreamFeedsClient client;`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-// ignore_for_file: file_names, unused_local_variable, avoid_redundant_argument_values`
`2`		`-`
`3`	`1`	`import 'package:stream_feed/stream_feed.dart';`
`4`	`2`
`5`	`3`	`late StreamFeedsClient client;`