Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xsahil03x merged 1 commit into from
Sep 16, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/analysis_options.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
include: ../analysis_options.yaml

analyzer:
errors:
unused_local_variable: ignore

linter:
rules:
file_names: false
avoid_redundant_argument_values: false
29 changes: 15 additions & 14 deletions docs_code_snippets/01_01_quickstart.dart → docs/code_snippets/01_01_quickstart.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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';
Expand All @@ -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();
Expand All @@ -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!',
),
);
}

Expand All @@ -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',
),
Expand All @@ -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'),
);
}

Expand All @@ -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'),
Expand All @@ -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',
Expand Down
2 changes: 0 additions & 2 deletions docs_code_snippets/03_01_activities.dart → docs/code_snippets/03_01_activities.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 0 additions & 2 deletions ...e_snippets/03_02_querying_activities.dart → ...e_snippets/03_02_querying_activities.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 0 additions & 2 deletions docs_code_snippets/03_03_file_uploads.dart → docs/code_snippets/03_03_file_uploads.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 0 additions & 2 deletions docs_code_snippets/04_01_feeds.dart → docs/code_snippets/04_01_feeds.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 0 additions & 2 deletions .../04_02_feeds_and_activity_visibility.dart → .../04_02_feeds_and_activity_visibility.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 0 additions & 2 deletions docs_code_snippets/04_03_follows.dart → docs/code_snippets/04_03_follows.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 0 additions & 2 deletions docs_code_snippets/05_01_intro_defaults.dart → docs/code_snippets/05_01_intro_defaults.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 0 additions & 2 deletions docs_code_snippets/05_02_feed_views.dart → docs/code_snippets/05_02_feed_views.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 0 additions & 2 deletions ...de_snippets/05_06_notification_feeds.dart → ...de_snippets/05_06_notification_feeds.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 0 additions & 2 deletions docs_code_snippets/05_07_processors.dart → docs/code_snippets/05_07_processors.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 0 additions & 2 deletions docs_code_snippets/06_01_reactions.dart → docs/code_snippets/06_01_reactions.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 0 additions & 2 deletions docs_code_snippets/06_02_bookmarks.dart → docs/code_snippets/06_02_bookmarks.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 0 additions & 2 deletions docs_code_snippets/06_03_comments.dart → docs/code_snippets/06_03_comments.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 0 additions & 2 deletions docs_code_snippets/06_04_pins.dart → docs/code_snippets/06_04_pins.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
0 docs_code_snippets/07_01_state_layer.dart → docs/code_snippets/07_01_state_layer.dart
View file
Open in desktop
File renamed without changes.
0 docs_code_snippets/08_01_events.dart → docs/code_snippets/08_01_events.dart
View file
Open in desktop
File renamed without changes.
2 changes: 0 additions & 2 deletions docs_code_snippets/09_01_polls.dart → docs/code_snippets/09_01_polls.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
0 ...de_snippets/10_01_push_notifications.dart → ...de_snippets/10_01_push_notifications.dart
View file
Open in desktop
File renamed without changes.
2 changes: 0 additions & 2 deletions docs_code_snippets/11_01_moderation.dart → docs/code_snippets/11_01_moderation.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
10 changes: 10 additions & 0 deletions docs/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions melos.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ versioning:
mode: independent

packages:
- docs
- sample_app
- packages/*
- packages/*/example
Expand Down
Loading