GeorgeWall1991/CancelCop.Analyzerv1.1.2
.NET Std2.0
A surgical Roslyn analyzer focused on CancellationToken propagation and honoring across public APIs, handlers, EF Core, HTTP calls, and Minimal APIs, with comprehensive code fixes.
Get Started
$ dotnet add package CancelCop.AnalyzerReadme
CancelCop Analyzer
A surgical Roslyn analyzer focused on CancellationToken propagation and honoring across public APIs, handlers, EF Core, HTTP calls, and Minimal APIs, with comprehensive automatic code fixes.
Why CancelCop?
CancelCop helps you build responsive, cancellable .NET applications by ensuring CancellationToken is properly used throughout your codebase. It detects missing tokens and provides automatic fixes with a single click.
Features
8 Comprehensive Analyzers
| Rule | Description | Severity |
|---|---|---|
| CC001 | Public async methods must have CancellationToken parameter | Warning |
| CC002 | CancellationToken must be propagated to async calls | Warning |
| CC003 | EF Core queries must pass CancellationToken | Warning |
| CC004 | HttpClient methods must pass CancellationToken | Warning |
| CC005A | MediatR handlers must accept CancellationToken | Warning |
| CC005B | Controller actions must accept CancellationToken | Warning |
| CC005C | Minimal API endpoints must accept CancellationToken | Warning |
| CC006 | CancellationToken should be the last parameter | Info |
Automatic Code Fixes
- ✅ Adds CancellationToken parameters to method signatures
- ✅ Propagates tokens to inner async calls
- ✅ Handles lambda expressions (Minimal APIs)
- ✅ Smart using directive management
- ✅ Preserves code formatting
Quick Start
Installation
dotnet add package CancelCop.Analyzer
Usage
Once installed, the analyzer runs automatically during build. It will:
- Detect CancellationToken issues in your code
- Show warnings in your IDE with clear descriptions
- Offer code fixes - just click the lightbulb 💡
Example
// ❌ Before (CC001 warning)
public async Task ProcessDataAsync()
{
await Task.Delay(100);
}
// ✅ After (automatic fix applied)
public async Task ProcessDataAsync(CancellationToken cancellationToken = default)
{
await Task.Delay(100, cancellationToken);
}