CsEffect 0.15.0

CsEffect (Code Fixes)

Companion Roslyn code fixes for CsEffect that automatically add required effect annotations.

Overview

This package provides automated code fixes for CsEffect analyzer diagnostics. When the CsEffect analyzer detects that a method requires an effect attribute, this package offers one-click fixes to add the missing annotations automatically.

Features

Automatic Effect Addition

When you see a CSE001 diagnostic, use the IDE's quick actions (Ctrl+. in Visual Studio/VS Code) to automatically add the required effect attribute.

Before:

public void MyMethod() // CSE001: Member 'MyMethod' requires [ConsoleEffect]
{
    Console.WriteLine("Hello");
}

After applying fix:

[ConsoleEffect]
public void MyMethod()
{
    Console.WriteLine("Hello");
}

Interface Effect Synchronization

For CSE002 diagnostics (interface implementation mismatches), the code fix can add the missing effect attribute to the interface declaration.

Before:

public interface ILogger
{
    void Log(string message); // Missing [ConsoleEffect]
}

public class Logger : ILogger
{
    [ConsoleEffect] // CSE002: Interface doesn't declare this effect
    public void Log(string message)
    {
        Console.WriteLine(message);
    }
}

After applying "Add [ConsoleEffect] to interface" fix:

public interface ILogger
{
    [ConsoleEffect]
    void Log(string message);
}

public class Logger : ILogger
{
    [ConsoleEffect]
    public void Log(string message)
    {
        Console.WriteLine(message);
    }
}

Installation

This package is typically installed alongside the CsEffect analyzer:

<ItemGroup>
  <PackageReference Include="CsEffect" Version="0.2.0" OutputItemType="Analyzer" />
</ItemGroup>

The package includes both the analyzer and code fixes in a single package for convenience.

For separate installation:

<ItemGroup>
  <PackageReference Include="CsEffect.CodeFixes" Version="0.2.0" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
</ItemGroup>

Supported Diagnostics

How to Use

1. Build your project - The analyzer will identify methods that need effect annotations
2. Open the file with diagnostics in your IDE
3. Position cursor on the squiggly line or diagnostic
4. Press Ctrl+. (or Cmd+. on Mac) to open quick actions
5. Select the fix - e.g., "Add [ConsoleEffect]"
6. The attribute is added automatically with proper using statements if needed

Fix All Support

The code fix provider supports "Fix All" operations, allowing you to:

• Fix all instances in the current document
• Fix all instances in the current project
• Fix all instances in the solution

Access this through the screwdriver icon that appears when you hover over a diagnostic, or through the "Fix All" command in the error list.

Technical Details

Attribute Resolution

The code fix automatically:

• Resolves the correct attribute type from the diagnostic metadata
• Adds necessary using statements if the attribute namespace isn't imported
• Handles both simple names (e.g., ConsoleEffect) and fully qualified names

Interface Handling

For interface fixes, the code fix:

• Finds all interface methods implemented by the problematic method
• Adds the effect attribute to interface methods that don't already have it
• Works across multiple files and projects in the same solution

Performance

• Code fixes are only computed when requested (when you open quick actions)
• Bulk operations use efficient batch processing
• No impact on build performance

Requirements

• CsEffect.Analyzer: The analyzer package that generates the diagnostics
• Roslyn-compatible IDE: Visual Studio 2022+, VS Code with C# extension, or Rider
• .NET Standard 2.0+: Compatible with .NET Framework 4.7.2+ and .NET Core/5+

License

MIT