Skip to content

Commit bc302c5

Browse files
committed
refactor: feeds client
1 parent 9effdcd commit bc302c5

File tree

658 files changed

+13213
-7662
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

658 files changed

+13213
-7662
lines changed

.cursor/rules/patterns/documentation-style.mdc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,26 @@ class Box {
115115
#### PREFER brevity
116116
Be clear and precise, but also terse. Avoid verbose explanations.
117117

118+
#### DO separate return documentation with a blank line
119+
Always place return documentation on a separate line with a blank line before it for better readability and consistency.
120+
121+
```dart
122+
/// Creates a new activity.
123+
///
124+
/// Creates a new activity using the provided [request] data.
125+
///
126+
/// Returns a [Result] containing the created [ActivityData] or an error.
127+
Future<Result<ActivityData>> addActivity(AddActivityRequest request) async { ... }
128+
129+
/// Deletes an activity.
130+
///
131+
/// Removes the activity with the specified [activityId]. When [hardDelete]
132+
/// is true, permanently deletes the activity; otherwise marks it as deleted.
133+
///
134+
/// Returns a [Result] containing void or an error.
135+
Future<Result<void>> deleteActivity(String activityId, {bool hardDelete = false}) { ... }
136+
```
137+
118138
### Common Anti-Patterns to Avoid
119139

120140
```dart
@@ -720,6 +740,7 @@ When documenting SDK components, ensure:
720740
- [ ] Avoided redundancy with surrounding context
721741
- [ ] Used "this" instead of "the" for member's instance
722742
- [ ] Maintained brevity while being precise
743+
- [ ] Separated return documentation with a blank line
723744

724745
### SDK-Specific Patterns
725746
- [ ] Used appropriate class documentation pattern (Feed vs List vs State vs Notifier)

analysis_options.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ linter:
2626

2727
always_put_control_body_on_new_line: false
2828

29+
# Not always necessary, especially for interfaces.
30+
one_member_abstracts: false
31+
2932
# Does not always make code more readable.
3033
cascade_invocations: false
3134

melos.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ command:
2121
auto_route: ^10.0.0
2222
cached_network_image: ^3.4.1
2323
collection: ^1.18.0
24+
dio: ^5.9.0
2425
equatable: ^2.0.5
2526
flutter_state_notifier: ^1.0.0
2627
freezed_annotation: ^3.0.0
@@ -29,6 +30,7 @@ command:
2930
intl: ">=0.18.1 <=0.21.0"
3031
json_annotation: ^4.9.0
3132
meta: ^1.9.1
33+
retrofit: ^4.6.0
3234
rxdart: ^0.28.0
3335
shared_preferences: ^2.5.3
3436
state_notifier: ^1.0.0
@@ -44,6 +46,7 @@ command:
4446
freezed: ^3.0.0
4547
json_serializable: ^6.9.5
4648
mocktail: ^1.0.4
49+
retrofit_generator: ^9.6.0
4750
test: ^1.26.3
4851

4952
scripts:

packages/stream_feeds/build.yaml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,12 @@ targets:
1111
when: false
1212
equal: true
1313
copy_with: true
14-
to_string_override: true
14+
to_string_override: true
15+
16+
global_options:
17+
freezed:
18+
runs_before:
19+
- json_serializable
20+
json_serializable:
21+
runs_before:
22+
- retrofit_generator

packages/stream_feeds/lib/src/core/utils/endpoint_config.dart renamed to packages/stream_feeds/lib/src/client/endpoint_config.dart

File renamed without changes.

0 commit comments

Comments
 (0)