mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-04 08:13:30 +08:00
feat: add C# and Dart language support
This commit is contained in:
321
skills/csharp-testing/SKILL.md
Normal file
321
skills/csharp-testing/SKILL.md
Normal file
@@ -0,0 +1,321 @@
|
||||
---
|
||||
name: csharp-testing
|
||||
description: C# and .NET testing patterns with xUnit, FluentAssertions, mocking, integration tests, and test organization best practices.
|
||||
origin: ECC
|
||||
---
|
||||
|
||||
# C# Testing Patterns
|
||||
|
||||
Comprehensive testing patterns for .NET applications using xUnit, FluentAssertions, and modern testing practices.
|
||||
|
||||
## When to Activate
|
||||
|
||||
- Writing new tests for C# code
|
||||
- Reviewing test quality and coverage
|
||||
- Setting up test infrastructure for .NET projects
|
||||
- Debugging flaky or slow tests
|
||||
|
||||
## Test Framework Stack
|
||||
|
||||
| Tool | Purpose |
|
||||
|---|---|
|
||||
| **xUnit** | Test framework (preferred for .NET) |
|
||||
| **FluentAssertions** | Readable assertion syntax |
|
||||
| **NSubstitute** or **Moq** | Mocking dependencies |
|
||||
| **Testcontainers** | Real infrastructure in integration tests |
|
||||
| **WebApplicationFactory** | ASP.NET Core integration tests |
|
||||
| **Bogus** | Realistic test data generation |
|
||||
|
||||
## Unit Test Structure
|
||||
|
||||
### Arrange-Act-Assert
|
||||
|
||||
```csharp
|
||||
public sealed class OrderServiceTests
|
||||
{
|
||||
private readonly IOrderRepository _repository = Substitute.For<IOrderRepository>();
|
||||
private readonly ILogger<OrderService> _logger = Substitute.For<ILogger<OrderService>>();
|
||||
private readonly OrderService _sut;
|
||||
|
||||
public OrderServiceTests()
|
||||
{
|
||||
_sut = new OrderService(_repository, _logger);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task PlaceOrderAsync_ReturnsSuccess_WhenRequestIsValid()
|
||||
{
|
||||
// Arrange
|
||||
var request = new CreateOrderRequest
|
||||
{
|
||||
CustomerId = "cust-123",
|
||||
Items = [new OrderItem("SKU-001", 2, 29.99m)]
|
||||
};
|
||||
|
||||
// Act
|
||||
var result = await _sut.PlaceOrderAsync(request, CancellationToken.None);
|
||||
|
||||
// Assert
|
||||
result.IsSuccess.Should().BeTrue();
|
||||
result.Value.Should().NotBeNull();
|
||||
result.Value!.CustomerId.Should().Be("cust-123");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task PlaceOrderAsync_ReturnsFailure_WhenNoItems()
|
||||
{
|
||||
// Arrange
|
||||
var request = new CreateOrderRequest
|
||||
{
|
||||
CustomerId = "cust-123",
|
||||
Items = []
|
||||
};
|
||||
|
||||
// Act
|
||||
var result = await _sut.PlaceOrderAsync(request, CancellationToken.None);
|
||||
|
||||
// Assert
|
||||
result.IsSuccess.Should().BeFalse();
|
||||
result.Error.Should().Contain("at least one item");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameterized Tests with Theory
|
||||
|
||||
```csharp
|
||||
[Theory]
|
||||
[InlineData("", false)]
|
||||
[InlineData("a", false)]
|
||||
[InlineData("ab@c.d", false)]
|
||||
[InlineData("user@example.com", true)]
|
||||
[InlineData("user+tag@example.co.uk", true)]
|
||||
public void IsValidEmail_ReturnsExpected(string email, bool expected)
|
||||
{
|
||||
EmailValidator.IsValid(email).Should().Be(expected);
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[MemberData(nameof(InvalidOrderCases))]
|
||||
public async Task PlaceOrderAsync_RejectsInvalidOrders(CreateOrderRequest request, string expectedError)
|
||||
{
|
||||
var result = await _sut.PlaceOrderAsync(request, CancellationToken.None);
|
||||
|
||||
result.IsSuccess.Should().BeFalse();
|
||||
result.Error.Should().Contain(expectedError);
|
||||
}
|
||||
|
||||
public static TheoryData<CreateOrderRequest, string> InvalidOrderCases => new()
|
||||
{
|
||||
{ new() { CustomerId = "", Items = [ValidItem()] }, "CustomerId" },
|
||||
{ new() { CustomerId = "c1", Items = [] }, "at least one item" },
|
||||
{ new() { CustomerId = "c1", Items = [new("", 1, 10m)] }, "SKU" },
|
||||
};
|
||||
```
|
||||
|
||||
## Mocking with NSubstitute
|
||||
|
||||
```csharp
|
||||
[Fact]
|
||||
public async Task GetOrderAsync_ReturnsNull_WhenNotFound()
|
||||
{
|
||||
// Arrange
|
||||
var orderId = Guid.NewGuid();
|
||||
_repository.FindByIdAsync(orderId, Arg.Any<CancellationToken>())
|
||||
.Returns((Order?)null);
|
||||
|
||||
// Act
|
||||
var result = await _sut.GetOrderAsync(orderId, CancellationToken.None);
|
||||
|
||||
// Assert
|
||||
result.Should().BeNull();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task PlaceOrderAsync_PersistsOrder()
|
||||
{
|
||||
// Arrange
|
||||
var request = ValidOrderRequest();
|
||||
|
||||
// Act
|
||||
await _sut.PlaceOrderAsync(request, CancellationToken.None);
|
||||
|
||||
// Assert — verify the repository was called
|
||||
await _repository.Received(1).AddAsync(
|
||||
Arg.Is<Order>(o => o.CustomerId == request.CustomerId),
|
||||
Arg.Any<CancellationToken>());
|
||||
}
|
||||
```
|
||||
|
||||
## ASP.NET Core Integration Tests
|
||||
|
||||
### WebApplicationFactory Setup
|
||||
|
||||
```csharp
|
||||
public sealed class OrderApiTests : IClassFixture<WebApplicationFactory<Program>>
|
||||
{
|
||||
private readonly HttpClient _client;
|
||||
|
||||
public OrderApiTests(WebApplicationFactory<Program> factory)
|
||||
{
|
||||
_client = factory.WithWebHostBuilder(builder =>
|
||||
{
|
||||
builder.ConfigureServices(services =>
|
||||
{
|
||||
// Replace real DB with in-memory for tests
|
||||
services.RemoveAll<DbContextOptions<AppDbContext>>();
|
||||
services.AddDbContext<AppDbContext>(options =>
|
||||
options.UseInMemoryDatabase("TestDb"));
|
||||
});
|
||||
}).CreateClient();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task GetOrder_Returns404_WhenNotFound()
|
||||
{
|
||||
var response = await _client.GetAsync($"/api/orders/{Guid.NewGuid()}");
|
||||
|
||||
response.StatusCode.Should().Be(HttpStatusCode.NotFound);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CreateOrder_Returns201_WithValidRequest()
|
||||
{
|
||||
var request = new CreateOrderRequest
|
||||
{
|
||||
CustomerId = "cust-1",
|
||||
Items = [new("SKU-001", 1, 19.99m)]
|
||||
};
|
||||
|
||||
var response = await _client.PostAsJsonAsync("/api/orders", request);
|
||||
|
||||
response.StatusCode.Should().Be(HttpStatusCode.Created);
|
||||
response.Headers.Location.Should().NotBeNull();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Testing with Testcontainers
|
||||
|
||||
```csharp
|
||||
public sealed class PostgresOrderRepositoryTests : IAsyncLifetime
|
||||
{
|
||||
private readonly PostgreSqlContainer _postgres = new PostgreSqlBuilder()
|
||||
.WithImage("postgres:16-alpine")
|
||||
.Build();
|
||||
|
||||
private AppDbContext _db = null!;
|
||||
|
||||
public async Task InitializeAsync()
|
||||
{
|
||||
await _postgres.StartAsync();
|
||||
var options = new DbContextOptionsBuilder<AppDbContext>()
|
||||
.UseNpgsql(_postgres.GetConnectionString())
|
||||
.Options;
|
||||
_db = new AppDbContext(options);
|
||||
await _db.Database.MigrateAsync();
|
||||
}
|
||||
|
||||
public async Task DisposeAsync()
|
||||
{
|
||||
await _db.DisposeAsync();
|
||||
await _postgres.DisposeAsync();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task AddAsync_PersistsOrder()
|
||||
{
|
||||
var repo = new SqlOrderRepository(_db);
|
||||
var order = Order.Create("cust-1", [new OrderItem("SKU-001", 2, 10m)]);
|
||||
|
||||
await repo.AddAsync(order, CancellationToken.None);
|
||||
|
||||
var found = await repo.FindByIdAsync(order.Id, CancellationToken.None);
|
||||
found.Should().NotBeNull();
|
||||
found!.Items.Should().HaveCount(1);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Test Organization
|
||||
|
||||
```
|
||||
tests/
|
||||
MyApp.UnitTests/
|
||||
Services/
|
||||
OrderServiceTests.cs
|
||||
PaymentServiceTests.cs
|
||||
Validators/
|
||||
EmailValidatorTests.cs
|
||||
MyApp.IntegrationTests/
|
||||
Api/
|
||||
OrderApiTests.cs
|
||||
Repositories/
|
||||
OrderRepositoryTests.cs
|
||||
MyApp.TestHelpers/
|
||||
Builders/
|
||||
OrderBuilder.cs
|
||||
Fixtures/
|
||||
DatabaseFixture.cs
|
||||
```
|
||||
|
||||
## Test Data Builders
|
||||
|
||||
```csharp
|
||||
public sealed class OrderBuilder
|
||||
{
|
||||
private string _customerId = "cust-default";
|
||||
private readonly List<OrderItem> _items = [new("SKU-001", 1, 10m)];
|
||||
|
||||
public OrderBuilder WithCustomer(string customerId)
|
||||
{
|
||||
_customerId = customerId;
|
||||
return this;
|
||||
}
|
||||
|
||||
public OrderBuilder WithItem(string sku, int quantity, decimal price)
|
||||
{
|
||||
_items.Add(new OrderItem(sku, quantity, price));
|
||||
return this;
|
||||
}
|
||||
|
||||
public Order Build() => Order.Create(_customerId, _items);
|
||||
}
|
||||
|
||||
// Usage in tests
|
||||
var order = new OrderBuilder()
|
||||
.WithCustomer("cust-vip")
|
||||
.WithItem("SKU-PREMIUM", 3, 99.99m)
|
||||
.Build();
|
||||
```
|
||||
|
||||
## Common Anti-Patterns
|
||||
|
||||
| Anti-Pattern | Fix |
|
||||
|---|---|
|
||||
| Testing implementation details | Test behavior and outcomes |
|
||||
| Shared mutable test state | Fresh instance per test (xUnit does this via constructors) |
|
||||
| `Thread.Sleep` in async tests | Use `Task.Delay` with timeout, or polling helpers |
|
||||
| Asserting on `ToString()` output | Assert on typed properties |
|
||||
| One giant assertion per test | One logical assertion per test |
|
||||
| Test names describing implementation | Name by behavior: `Method_ExpectedResult_WhenCondition` |
|
||||
| Ignoring `CancellationToken` | Always pass and verify cancellation |
|
||||
|
||||
## Running Tests
|
||||
|
||||
```bash
|
||||
# Run all tests
|
||||
dotnet test
|
||||
|
||||
# Run with coverage
|
||||
dotnet test --collect:"XPlat Code Coverage"
|
||||
|
||||
# Run specific project
|
||||
dotnet test tests/MyApp.UnitTests/
|
||||
|
||||
# Filter by test name
|
||||
dotnet test --filter "FullyQualifiedName~OrderService"
|
||||
|
||||
# Watch mode during development
|
||||
dotnet watch test --project tests/MyApp.UnitTests/
|
||||
```
|
||||
563
skills/dart-flutter-patterns/SKILL.md
Normal file
563
skills/dart-flutter-patterns/SKILL.md
Normal file
@@ -0,0 +1,563 @@
|
||||
---
|
||||
name: dart-flutter-patterns
|
||||
description: Production-ready Dart and Flutter patterns covering null safety, immutable state, async composition, widget architecture, popular state management frameworks (BLoC, Riverpod, Provider), GoRouter navigation, Dio networking, Freezed code generation, and clean architecture.
|
||||
origin: ECC
|
||||
---
|
||||
|
||||
# Dart/Flutter Patterns
|
||||
|
||||
## When to Use
|
||||
|
||||
Use this skill when:
|
||||
- Starting a new Flutter feature and need idiomatic patterns for state management, navigation, or data access
|
||||
- Reviewing or writing Dart code and need guidance on null safety, sealed types, or async composition
|
||||
- Setting up a new Flutter project and choosing between BLoC, Riverpod, or Provider
|
||||
- Implementing secure HTTP clients, WebView integration, or local storage
|
||||
- Writing tests for Flutter widgets, Cubits, or Riverpod providers
|
||||
- Wiring up GoRouter with authentication guards
|
||||
|
||||
## How It Works
|
||||
|
||||
This skill provides copy-paste-ready Dart/Flutter code patterns organized by concern:
|
||||
1. **Null safety** — avoid `!`, prefer `?.`/`??`/pattern matching
|
||||
2. **Immutable state** — sealed classes, `freezed`, `copyWith`
|
||||
3. **Async composition** — concurrent `Future.wait`, safe `BuildContext` after `await`
|
||||
4. **Widget architecture** — extract to classes (not methods), `const` propagation, scoped rebuilds
|
||||
5. **State management** — BLoC/Cubit events, Riverpod notifiers and derived providers
|
||||
6. **Navigation** — GoRouter with reactive auth guards via `refreshListenable`
|
||||
7. **Networking** — Dio with interceptors, token refresh with one-time retry guard
|
||||
8. **Error handling** — global capture, `ErrorWidget.builder`, crashlytics wiring
|
||||
9. **Testing** — unit (BLoC test), widget (ProviderScope overrides), fakes over mocks
|
||||
|
||||
## Examples
|
||||
|
||||
```dart
|
||||
// Sealed state — prevents impossible states
|
||||
sealed class AsyncState<T> {}
|
||||
final class Loading<T> extends AsyncState<T> {}
|
||||
final class Success<T> extends AsyncState<T> { final T data; const Success(this.data); }
|
||||
final class Failure<T> extends AsyncState<T> { final Object error; const Failure(this.error); }
|
||||
|
||||
// GoRouter with reactive auth redirect
|
||||
final router = GoRouter(
|
||||
refreshListenable: GoRouterRefreshStream(authCubit.stream),
|
||||
redirect: (context, state) {
|
||||
final authed = context.read<AuthCubit>().state is AuthAuthenticated;
|
||||
if (!authed && !state.matchedLocation.startsWith('/login')) return '/login';
|
||||
return null;
|
||||
},
|
||||
routes: [...],
|
||||
);
|
||||
|
||||
// Riverpod derived provider with safe firstWhereOrNull
|
||||
@riverpod
|
||||
double cartTotal(Ref ref) {
|
||||
final cart = ref.watch(cartNotifierProvider);
|
||||
final products = ref.watch(productsProvider).valueOrNull ?? [];
|
||||
return cart.fold(0.0, (total, item) {
|
||||
final product = products.firstWhereOrNull((p) => p.id == item.productId);
|
||||
return total + (product?.price ?? 0) * item.quantity;
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Practical, production-ready patterns for Dart and Flutter applications. Library-agnostic where possible, with explicit coverage of the most common ecosystem packages.
|
||||
|
||||
---
|
||||
|
||||
## 1. Null Safety Fundamentals
|
||||
|
||||
### Prefer Patterns Over Bang Operator
|
||||
|
||||
```dart
|
||||
// BAD — crashes at runtime if null
|
||||
final name = user!.name;
|
||||
|
||||
// GOOD — provide fallback
|
||||
final name = user?.name ?? 'Unknown';
|
||||
|
||||
// GOOD — Dart 3 pattern matching (preferred for complex cases)
|
||||
final display = switch (user) {
|
||||
User(:final name, :final email) => '$name <$email>',
|
||||
null => 'Guest',
|
||||
};
|
||||
|
||||
// GOOD — guard early return
|
||||
String getUserName(User? user) {
|
||||
if (user == null) return 'Unknown';
|
||||
return user.name; // promoted to non-null after check
|
||||
}
|
||||
```
|
||||
|
||||
### Avoid `late` Overuse
|
||||
|
||||
```dart
|
||||
// BAD — defers null error to runtime
|
||||
late String userId;
|
||||
|
||||
// GOOD — nullable with explicit initialization
|
||||
String? userId;
|
||||
|
||||
// OK — use late only when initialization is guaranteed before first access
|
||||
// (e.g., in initState() before any widget interaction)
|
||||
late final AnimationController _controller;
|
||||
|
||||
@override
|
||||
void initState() {
|
||||
super.initState();
|
||||
_controller = AnimationController(vsync: this, duration: const Duration(milliseconds: 300));
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. Immutable State
|
||||
|
||||
### Sealed Classes for State Hierarchies
|
||||
|
||||
```dart
|
||||
sealed class UserState {}
|
||||
|
||||
final class UserInitial extends UserState {}
|
||||
|
||||
final class UserLoading extends UserState {}
|
||||
|
||||
final class UserLoaded extends UserState {
|
||||
const UserLoaded(this.user);
|
||||
final User user;
|
||||
}
|
||||
|
||||
final class UserError extends UserState {
|
||||
const UserError(this.message);
|
||||
final String message;
|
||||
}
|
||||
|
||||
// Exhaustive switch — compiler enforces all branches
|
||||
Widget buildFrom(UserState state) => switch (state) {
|
||||
UserInitial() => const SizedBox.shrink(),
|
||||
UserLoading() => const CircularProgressIndicator(),
|
||||
UserLoaded(:final user) => UserCard(user: user),
|
||||
UserError(:final message) => ErrorText(message),
|
||||
};
|
||||
```
|
||||
|
||||
### Freezed for Boilerplate-Free Immutability
|
||||
|
||||
```dart
|
||||
import 'package:freezed_annotation/freezed_annotation.dart';
|
||||
|
||||
part 'user.freezed.dart';
|
||||
part 'user.g.dart';
|
||||
|
||||
@freezed
|
||||
class User with _$User {
|
||||
const factory User({
|
||||
required String id,
|
||||
required String name,
|
||||
required String email,
|
||||
@Default(false) bool isAdmin,
|
||||
}) = _User;
|
||||
|
||||
factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
|
||||
}
|
||||
|
||||
// Usage
|
||||
final user = User(id: '1', name: 'Alice', email: 'alice@example.com');
|
||||
final updated = user.copyWith(name: 'Alice Smith'); // immutable update
|
||||
final json = user.toJson();
|
||||
final fromJson = User.fromJson(json);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Async Composition
|
||||
|
||||
### Structured Concurrency with Future.wait
|
||||
|
||||
```dart
|
||||
Future<DashboardData> loadDashboard(UserRepository users, OrderRepository orders) async {
|
||||
// Run concurrently — don't await sequentially
|
||||
final (userList, orderList) = await (
|
||||
users.getAll(),
|
||||
orders.getRecent(),
|
||||
).wait; // Dart 3 record destructuring + Future.wait extension
|
||||
|
||||
return DashboardData(users: userList, orders: orderList);
|
||||
}
|
||||
```
|
||||
|
||||
### Stream Patterns
|
||||
|
||||
```dart
|
||||
// Repository exposes reactive streams for live data
|
||||
Stream<List<Item>> watchCartItems() => _db
|
||||
.watchTable('cart_items')
|
||||
.map((rows) => rows.map(Item.fromRow).toList());
|
||||
|
||||
// In widget layer — declarative, no manual subscription
|
||||
StreamBuilder<List<Item>>(
|
||||
stream: cartRepository.watchCartItems(),
|
||||
builder: (context, snapshot) => switch (snapshot) {
|
||||
AsyncSnapshot(connectionState: ConnectionState.waiting) =>
|
||||
const CircularProgressIndicator(),
|
||||
AsyncSnapshot(:final error?) => ErrorWidget(error.toString()),
|
||||
AsyncSnapshot(:final data?) => CartList(items: data),
|
||||
_ => const SizedBox.shrink(),
|
||||
},
|
||||
)
|
||||
```
|
||||
|
||||
### BuildContext After Await
|
||||
|
||||
```dart
|
||||
// CRITICAL — always check mounted after any await in StatefulWidget
|
||||
Future<void> _handleSubmit() async {
|
||||
setState(() => _isLoading = true);
|
||||
try {
|
||||
await authService.login(_email, _password);
|
||||
if (!mounted) return; // ← guard before using context
|
||||
context.go('/home');
|
||||
} on AuthException catch (e) {
|
||||
if (!mounted) return;
|
||||
ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text(e.message)));
|
||||
} finally {
|
||||
if (mounted) setState(() => _isLoading = false);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. Widget Architecture
|
||||
|
||||
### Extract to Classes, Not Methods
|
||||
|
||||
```dart
|
||||
// BAD — private method returning widget, prevents optimization
|
||||
Widget _buildHeader() {
|
||||
return Container(
|
||||
padding: const EdgeInsets.all(16),
|
||||
child: Text(title, style: Theme.of(context).textTheme.headlineMedium),
|
||||
);
|
||||
}
|
||||
|
||||
// GOOD — separate widget class, enables const, element reuse
|
||||
class _PageHeader extends StatelessWidget {
|
||||
const _PageHeader(this.title);
|
||||
final String title;
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return Container(
|
||||
padding: const EdgeInsets.all(16),
|
||||
child: Text(title, style: Theme.of(context).textTheme.headlineMedium),
|
||||
);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### const Propagation
|
||||
|
||||
```dart
|
||||
// BAD — new instances every rebuild
|
||||
child: Padding(
|
||||
padding: EdgeInsets.all(16.0), // not const
|
||||
child: Icon(Icons.home, size: 24.0), // not const
|
||||
)
|
||||
|
||||
// GOOD — const stops rebuild propagation
|
||||
child: const Padding(
|
||||
padding: EdgeInsets.all(16.0),
|
||||
child: Icon(Icons.home, size: 24.0),
|
||||
)
|
||||
```
|
||||
|
||||
### Scoped Rebuilds
|
||||
|
||||
```dart
|
||||
// BAD — entire page rebuilds on every counter change
|
||||
class CounterPage extends ConsumerWidget {
|
||||
@override
|
||||
Widget build(BuildContext context, WidgetRef ref) {
|
||||
final count = ref.watch(counterProvider); // rebuilds everything
|
||||
return Scaffold(
|
||||
body: Column(children: [
|
||||
const ExpensiveHeader(), // unnecessarily rebuilt
|
||||
Text('$count'),
|
||||
const ExpensiveFooter(), // unnecessarily rebuilt
|
||||
]),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// GOOD — isolate the rebuilding part
|
||||
class CounterPage extends StatelessWidget {
|
||||
const CounterPage({super.key});
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return const Scaffold(
|
||||
body: Column(children: [
|
||||
ExpensiveHeader(), // never rebuilt (const)
|
||||
_CounterDisplay(), // only this rebuilds
|
||||
ExpensiveFooter(), // never rebuilt (const)
|
||||
]),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
class _CounterDisplay extends ConsumerWidget {
|
||||
const _CounterDisplay();
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context, WidgetRef ref) {
|
||||
final count = ref.watch(counterProvider);
|
||||
return Text('$count');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. State Management: BLoC/Cubit
|
||||
|
||||
```dart
|
||||
// Cubit — synchronous or simple async state
|
||||
class AuthCubit extends Cubit<AuthState> {
|
||||
AuthCubit(this._authService) : super(const AuthState.initial());
|
||||
final AuthService _authService;
|
||||
|
||||
Future<void> login(String email, String password) async {
|
||||
emit(const AuthState.loading());
|
||||
try {
|
||||
final user = await _authService.login(email, password);
|
||||
emit(AuthState.authenticated(user));
|
||||
} on AuthException catch (e) {
|
||||
emit(AuthState.error(e.message));
|
||||
}
|
||||
}
|
||||
|
||||
void logout() {
|
||||
_authService.logout();
|
||||
emit(const AuthState.initial());
|
||||
}
|
||||
}
|
||||
|
||||
// In widget
|
||||
BlocBuilder<AuthCubit, AuthState>(
|
||||
builder: (context, state) => switch (state) {
|
||||
AuthInitial() => const LoginForm(),
|
||||
AuthLoading() => const CircularProgressIndicator(),
|
||||
AuthAuthenticated(:final user) => HomePage(user: user),
|
||||
AuthError(:final message) => ErrorView(message: message),
|
||||
},
|
||||
)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. State Management: Riverpod
|
||||
|
||||
```dart
|
||||
// Auto-dispose async provider
|
||||
@riverpod
|
||||
Future<List<Product>> products(Ref ref) async {
|
||||
final repo = ref.watch(productRepositoryProvider);
|
||||
return repo.getAll();
|
||||
}
|
||||
|
||||
// Notifier with complex mutations
|
||||
@riverpod
|
||||
class CartNotifier extends _$CartNotifier {
|
||||
@override
|
||||
List<CartItem> build() => [];
|
||||
|
||||
void add(Product product) {
|
||||
final existing = state.where((i) => i.productId == product.id).firstOrNull;
|
||||
if (existing != null) {
|
||||
state = [
|
||||
for (final item in state)
|
||||
if (item.productId == product.id) item.copyWith(quantity: item.quantity + 1)
|
||||
else item,
|
||||
];
|
||||
} else {
|
||||
state = [...state, CartItem(productId: product.id, quantity: 1)];
|
||||
}
|
||||
}
|
||||
|
||||
void remove(String productId) =>
|
||||
state = state.where((i) => i.productId != productId).toList();
|
||||
|
||||
void clear() => state = [];
|
||||
}
|
||||
|
||||
// Derived provider (selector pattern)
|
||||
@riverpod
|
||||
int cartCount(Ref ref) => ref.watch(cartNotifierProvider).length;
|
||||
|
||||
@riverpod
|
||||
double cartTotal(Ref ref) {
|
||||
final cart = ref.watch(cartNotifierProvider);
|
||||
final products = ref.watch(productsProvider).valueOrNull ?? [];
|
||||
return cart.fold(0.0, (total, item) {
|
||||
// firstWhereOrNull (from collection package) avoids StateError when product is missing
|
||||
final product = products.firstWhereOrNull((p) => p.id == item.productId);
|
||||
return total + (product?.price ?? 0) * item.quantity;
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 7. Navigation with GoRouter
|
||||
|
||||
```dart
|
||||
final router = GoRouter(
|
||||
initialLocation: '/',
|
||||
// refreshListenable re-evaluates redirect whenever auth state changes
|
||||
refreshListenable: GoRouterRefreshStream(authCubit.stream),
|
||||
redirect: (context, state) {
|
||||
final isLoggedIn = context.read<AuthCubit>().state is AuthAuthenticated;
|
||||
final isGoingToLogin = state.matchedLocation == '/login';
|
||||
if (!isLoggedIn && !isGoingToLogin) return '/login';
|
||||
if (isLoggedIn && isGoingToLogin) return '/';
|
||||
return null;
|
||||
},
|
||||
routes: [
|
||||
GoRoute(path: '/login', builder: (_, __) => const LoginPage()),
|
||||
ShellRoute(
|
||||
builder: (context, state, child) => AppShell(child: child),
|
||||
routes: [
|
||||
GoRoute(path: '/', builder: (_, __) => const HomePage()),
|
||||
GoRoute(
|
||||
path: '/products/:id',
|
||||
builder: (context, state) =>
|
||||
ProductDetailPage(id: state.pathParameters['id']!),
|
||||
),
|
||||
],
|
||||
),
|
||||
],
|
||||
);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 8. HTTP with Dio
|
||||
|
||||
```dart
|
||||
final dio = Dio(BaseOptions(
|
||||
baseUrl: const String.fromEnvironment('API_URL'),
|
||||
connectTimeout: const Duration(seconds: 10),
|
||||
receiveTimeout: const Duration(seconds: 30),
|
||||
headers: {'Content-Type': 'application/json'},
|
||||
));
|
||||
|
||||
// Add auth interceptor
|
||||
dio.interceptors.add(InterceptorsWrapper(
|
||||
onRequest: (options, handler) async {
|
||||
final token = await secureStorage.read(key: 'auth_token');
|
||||
if (token != null) options.headers['Authorization'] = 'Bearer $token';
|
||||
handler.next(options);
|
||||
},
|
||||
onError: (error, handler) async {
|
||||
// Guard against infinite retry loops: only attempt refresh once per request
|
||||
final isRetry = error.requestOptions.extra['_isRetry'] == true;
|
||||
if (!isRetry && error.response?.statusCode == 401) {
|
||||
final refreshed = await attemptTokenRefresh();
|
||||
if (refreshed) {
|
||||
error.requestOptions.extra['_isRetry'] = true;
|
||||
return handler.resolve(await dio.fetch(error.requestOptions));
|
||||
}
|
||||
}
|
||||
handler.next(error);
|
||||
},
|
||||
));
|
||||
|
||||
// Repository using Dio
|
||||
class UserApiDataSource {
|
||||
const UserApiDataSource(this._dio);
|
||||
final Dio _dio;
|
||||
|
||||
Future<User> getById(String id) async {
|
||||
final response = await _dio.get<Map<String, dynamic>>('/users/$id');
|
||||
return User.fromJson(response.data!);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 9. Error Handling Architecture
|
||||
|
||||
```dart
|
||||
// Global error capture — set up in main()
|
||||
void main() {
|
||||
FlutterError.onError = (details) {
|
||||
FlutterError.presentError(details);
|
||||
crashlytics.recordFlutterFatalError(details);
|
||||
};
|
||||
|
||||
PlatformDispatcher.instance.onError = (error, stack) {
|
||||
crashlytics.recordError(error, stack, fatal: true);
|
||||
return true;
|
||||
};
|
||||
|
||||
runApp(const App());
|
||||
}
|
||||
|
||||
// Custom ErrorWidget for production
|
||||
class App extends StatelessWidget {
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
ErrorWidget.builder = (details) => ProductionErrorWidget(details);
|
||||
return MaterialApp.router(routerConfig: router);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 10. Testing Quick Reference
|
||||
|
||||
```dart
|
||||
// Unit test — use case
|
||||
test('GetUserUseCase returns null for missing user', () async {
|
||||
final repo = FakeUserRepository();
|
||||
final useCase = GetUserUseCase(repo);
|
||||
expect(await useCase('missing-id'), isNull);
|
||||
});
|
||||
|
||||
// BLoC test
|
||||
blocTest<AuthCubit, AuthState>(
|
||||
'emits loading then error on failed login',
|
||||
build: () => AuthCubit(FakeAuthService(throwsOn: 'login')),
|
||||
act: (cubit) => cubit.login('user@test.com', 'wrong'),
|
||||
expect: () => [const AuthState.loading(), isA<AuthError>()],
|
||||
);
|
||||
|
||||
// Widget test
|
||||
testWidgets('CartBadge shows item count', (tester) async {
|
||||
await tester.pumpWidget(
|
||||
ProviderScope(
|
||||
overrides: [cartNotifierProvider.overrideWith(() => FakeCartNotifier(count: 3))],
|
||||
child: const MaterialApp(home: CartBadge()),
|
||||
),
|
||||
);
|
||||
expect(find.text('3'), findsOneWidget);
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## References
|
||||
|
||||
- [Effective Dart: Design](https://dart.dev/effective-dart/design)
|
||||
- [Flutter Performance Best Practices](https://docs.flutter.dev/perf/best-practices)
|
||||
- [Riverpod Documentation](https://riverpod.dev/)
|
||||
- [BLoC Library](https://bloclibrary.dev/)
|
||||
- [GoRouter](https://pub.dev/packages/go_router)
|
||||
- [Freezed](https://pub.dev/packages/freezed)
|
||||
- Skill: `flutter-dart-code-review` — comprehensive review checklist
|
||||
- Rules: `rules/dart/` — coding style, patterns, security, testing, hooks
|
||||
321
skills/dotnet-patterns/SKILL.md
Normal file
321
skills/dotnet-patterns/SKILL.md
Normal file
@@ -0,0 +1,321 @@
|
||||
---
|
||||
name: dotnet-patterns
|
||||
description: Idiomatic C# and .NET patterns, conventions, dependency injection, async/await, and best practices for building robust, maintainable .NET applications.
|
||||
origin: ECC
|
||||
---
|
||||
|
||||
# .NET Development Patterns
|
||||
|
||||
Idiomatic C# and .NET patterns for building robust, performant, and maintainable applications.
|
||||
|
||||
## When to Activate
|
||||
|
||||
- Writing new C# code
|
||||
- Reviewing C# code
|
||||
- Refactoring existing .NET applications
|
||||
- Designing service architectures with ASP.NET Core
|
||||
|
||||
## Core Principles
|
||||
|
||||
### 1. Prefer Immutability
|
||||
|
||||
Use records and init-only properties for data models. Mutability should be an explicit, justified choice.
|
||||
|
||||
```csharp
|
||||
// Good: Immutable value object
|
||||
public sealed record Money(decimal Amount, string Currency);
|
||||
|
||||
// Good: Immutable DTO with init setters
|
||||
public sealed class CreateOrderRequest
|
||||
{
|
||||
public required string CustomerId { get; init; }
|
||||
public required IReadOnlyList<OrderItem> Items { get; init; }
|
||||
}
|
||||
|
||||
// Bad: Mutable model with public setters
|
||||
public class Order
|
||||
{
|
||||
public string CustomerId { get; set; }
|
||||
public List<OrderItem> Items { get; set; }
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Explicit Over Implicit
|
||||
|
||||
Be clear about nullability, access modifiers, and intent.
|
||||
|
||||
```csharp
|
||||
// Good: Explicit access modifiers and nullability
|
||||
public sealed class UserService
|
||||
{
|
||||
private readonly IUserRepository _repository;
|
||||
private readonly ILogger<UserService> _logger;
|
||||
|
||||
public UserService(IUserRepository repository, ILogger<UserService> logger)
|
||||
{
|
||||
_repository = repository ?? throw new ArgumentNullException(nameof(repository));
|
||||
_logger = logger ?? throw new ArgumentNullException(nameof(logger));
|
||||
}
|
||||
|
||||
public async Task<User?> FindByIdAsync(Guid id, CancellationToken cancellationToken)
|
||||
{
|
||||
return await _repository.FindByIdAsync(id, cancellationToken);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Depend on Abstractions
|
||||
|
||||
Use interfaces for service boundaries. Register via DI container.
|
||||
|
||||
```csharp
|
||||
// Good: Interface-based dependency
|
||||
public interface IOrderRepository
|
||||
{
|
||||
Task<Order?> FindByIdAsync(Guid id, CancellationToken cancellationToken);
|
||||
Task<IReadOnlyList<Order>> FindByCustomerAsync(string customerId, CancellationToken cancellationToken);
|
||||
Task AddAsync(Order order, CancellationToken cancellationToken);
|
||||
}
|
||||
|
||||
// Registration
|
||||
builder.Services.AddScoped<IOrderRepository, SqlOrderRepository>();
|
||||
```
|
||||
|
||||
## Async/Await Patterns
|
||||
|
||||
### Proper Async Usage
|
||||
|
||||
```csharp
|
||||
// Good: Async all the way, with CancellationToken
|
||||
public async Task<OrderSummary> GetOrderSummaryAsync(
|
||||
Guid orderId,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
var order = await _repository.FindByIdAsync(orderId, cancellationToken)
|
||||
?? throw new NotFoundException($"Order {orderId} not found");
|
||||
|
||||
var customer = await _customerService.GetAsync(order.CustomerId, cancellationToken);
|
||||
|
||||
return new OrderSummary(order, customer);
|
||||
}
|
||||
|
||||
// Bad: Blocking on async
|
||||
public OrderSummary GetOrderSummary(Guid orderId)
|
||||
{
|
||||
var order = _repository.FindByIdAsync(orderId, CancellationToken.None).Result; // Deadlock risk
|
||||
return new OrderSummary(order);
|
||||
}
|
||||
```
|
||||
|
||||
### Parallel Async Operations
|
||||
|
||||
```csharp
|
||||
// Good: Concurrent independent operations
|
||||
public async Task<DashboardData> LoadDashboardAsync(CancellationToken cancellationToken)
|
||||
{
|
||||
var ordersTask = _orderService.GetRecentAsync(cancellationToken);
|
||||
var metricsTask = _metricsService.GetCurrentAsync(cancellationToken);
|
||||
var alertsTask = _alertService.GetActiveAsync(cancellationToken);
|
||||
|
||||
await Task.WhenAll(ordersTask, metricsTask, alertsTask);
|
||||
|
||||
return new DashboardData(
|
||||
Orders: await ordersTask,
|
||||
Metrics: await metricsTask,
|
||||
Alerts: await alertsTask);
|
||||
}
|
||||
```
|
||||
|
||||
## Options Pattern
|
||||
|
||||
Bind configuration sections to strongly-typed objects.
|
||||
|
||||
```csharp
|
||||
public sealed class SmtpOptions
|
||||
{
|
||||
public const string SectionName = "Smtp";
|
||||
|
||||
public required string Host { get; init; }
|
||||
public required int Port { get; init; }
|
||||
public required string Username { get; init; }
|
||||
public bool UseSsl { get; init; } = true;
|
||||
}
|
||||
|
||||
// Registration
|
||||
builder.Services.Configure<SmtpOptions>(
|
||||
builder.Configuration.GetSection(SmtpOptions.SectionName));
|
||||
|
||||
// Usage via injection
|
||||
public class EmailService(IOptions<SmtpOptions> options)
|
||||
{
|
||||
private readonly SmtpOptions _smtp = options.Value;
|
||||
}
|
||||
```
|
||||
|
||||
## Result Pattern
|
||||
|
||||
Return explicit success/failure instead of throwing for expected failures.
|
||||
|
||||
```csharp
|
||||
public sealed record Result<T>
|
||||
{
|
||||
public bool IsSuccess { get; }
|
||||
public T? Value { get; }
|
||||
public string? Error { get; }
|
||||
|
||||
private Result(T value) { IsSuccess = true; Value = value; }
|
||||
private Result(string error) { IsSuccess = false; Error = error; }
|
||||
|
||||
public static Result<T> Success(T value) => new(value);
|
||||
public static Result<T> Failure(string error) => new(error);
|
||||
}
|
||||
|
||||
// Usage
|
||||
public async Task<Result<Order>> PlaceOrderAsync(CreateOrderRequest request)
|
||||
{
|
||||
if (request.Items.Count == 0)
|
||||
return Result<Order>.Failure("Order must contain at least one item");
|
||||
|
||||
var order = Order.Create(request);
|
||||
await _repository.AddAsync(order, CancellationToken.None);
|
||||
return Result<Order>.Success(order);
|
||||
}
|
||||
```
|
||||
|
||||
## Repository Pattern with EF Core
|
||||
|
||||
```csharp
|
||||
public sealed class SqlOrderRepository : IOrderRepository
|
||||
{
|
||||
private readonly AppDbContext _db;
|
||||
|
||||
public SqlOrderRepository(AppDbContext db) => _db = db;
|
||||
|
||||
public async Task<Order?> FindByIdAsync(Guid id, CancellationToken cancellationToken)
|
||||
{
|
||||
return await _db.Orders
|
||||
.Include(o => o.Items)
|
||||
.AsNoTracking()
|
||||
.FirstOrDefaultAsync(o => o.Id == id, cancellationToken);
|
||||
}
|
||||
|
||||
public async Task<IReadOnlyList<Order>> FindByCustomerAsync(
|
||||
string customerId,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
return await _db.Orders
|
||||
.Where(o => o.CustomerId == customerId)
|
||||
.OrderByDescending(o => o.CreatedAt)
|
||||
.AsNoTracking()
|
||||
.ToListAsync(cancellationToken);
|
||||
}
|
||||
|
||||
public async Task AddAsync(Order order, CancellationToken cancellationToken)
|
||||
{
|
||||
_db.Orders.Add(order);
|
||||
await _db.SaveChangesAsync(cancellationToken);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Middleware and Pipeline
|
||||
|
||||
```csharp
|
||||
// Custom middleware
|
||||
public sealed class RequestTimingMiddleware
|
||||
{
|
||||
private readonly RequestDelegate _next;
|
||||
private readonly ILogger<RequestTimingMiddleware> _logger;
|
||||
|
||||
public RequestTimingMiddleware(RequestDelegate next, ILogger<RequestTimingMiddleware> logger)
|
||||
{
|
||||
_next = next;
|
||||
_logger = logger;
|
||||
}
|
||||
|
||||
public async Task InvokeAsync(HttpContext context)
|
||||
{
|
||||
var stopwatch = Stopwatch.StartNew();
|
||||
try
|
||||
{
|
||||
await _next(context);
|
||||
}
|
||||
finally
|
||||
{
|
||||
stopwatch.Stop();
|
||||
_logger.LogInformation(
|
||||
"Request {Method} {Path} completed in {ElapsedMs}ms with status {StatusCode}",
|
||||
context.Request.Method,
|
||||
context.Request.Path,
|
||||
stopwatch.ElapsedMilliseconds,
|
||||
context.Response.StatusCode);
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Minimal API Patterns
|
||||
|
||||
```csharp
|
||||
// Organized with route groups
|
||||
var orders = app.MapGroup("/api/orders")
|
||||
.RequireAuthorization()
|
||||
.WithTags("Orders");
|
||||
|
||||
orders.MapGet("/{id:guid}", async (
|
||||
Guid id,
|
||||
IOrderRepository repository,
|
||||
CancellationToken cancellationToken) =>
|
||||
{
|
||||
var order = await repository.FindByIdAsync(id, cancellationToken);
|
||||
return order is not null
|
||||
? TypedResults.Ok(order)
|
||||
: TypedResults.NotFound();
|
||||
});
|
||||
|
||||
orders.MapPost("/", async (
|
||||
CreateOrderRequest request,
|
||||
IOrderService service,
|
||||
CancellationToken cancellationToken) =>
|
||||
{
|
||||
var result = await service.PlaceOrderAsync(request, cancellationToken);
|
||||
return result.IsSuccess
|
||||
? TypedResults.Created($"/api/orders/{result.Value!.Id}", result.Value)
|
||||
: TypedResults.BadRequest(result.Error);
|
||||
});
|
||||
```
|
||||
|
||||
## Guard Clauses
|
||||
|
||||
```csharp
|
||||
// Good: Early returns with clear validation
|
||||
public async Task<ProcessResult> ProcessPaymentAsync(
|
||||
PaymentRequest request,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(request);
|
||||
|
||||
if (request.Amount <= 0)
|
||||
throw new ArgumentOutOfRangeException(nameof(request.Amount), "Amount must be positive");
|
||||
|
||||
if (string.IsNullOrWhiteSpace(request.Currency))
|
||||
throw new ArgumentException("Currency is required", nameof(request.Currency));
|
||||
|
||||
// Happy path continues here without nesting
|
||||
var gateway = _gatewayFactory.Create(request.Currency);
|
||||
return await gateway.ChargeAsync(request, cancellationToken);
|
||||
}
|
||||
```
|
||||
|
||||
## Anti-Patterns to Avoid
|
||||
|
||||
| Anti-Pattern | Fix |
|
||||
|---|---|
|
||||
| `async void` methods | Return `Task` (except event handlers) |
|
||||
| `.Result` or `.Wait()` | Use `await` |
|
||||
| `catch (Exception) { }` | Handle or rethrow with context |
|
||||
| `new Service()` in constructors | Use constructor injection |
|
||||
| `public` fields | Use properties with appropriate accessors |
|
||||
| `dynamic` in business logic | Use generics or explicit types |
|
||||
| Mutable `static` state | Use DI scoping or `ConcurrentDictionary` |
|
||||
| `string.Format` in loops | Use `StringBuilder` or interpolated string handlers |
|
||||
Reference in New Issue
Block a user