Oakrey.CodeAnalyzers

The Oakrey.CodeAnalyzers package provides a collection of Roslyn-based code analyzers designed to help .NET developers enforce best practices, improve code quality, and catch common issues early in the development process. These analyzers target a range of code patterns, from async usage to exception handling and code maintainability.

1. Features

• Async and Task Usage

  • Detects and warns against the use of async void methods (AsyncVoidAnalyzer).
  • Ensures that methods accepting cancellation should use CancellationToken (MissingCancellationTokenAnalyzer).

• Exception Handling

  • Flags general catch blocks that may hide errors (GeneralCatchAnalyzer).
  • Detects silent catch blocks that swallow exceptions without handling or logging (SilentCatchAnalyzer).

• Code Maintainability

  • Identifies files containing multiple class declarations (MultipleClassesInOneFileAnalyzer).
  • Highlights the use of Thread.Sleep which can block threads and degrade performance (ThreadSleepAnalyzer).
  • Detects TODO and FIXME comments to help track technical debt (TodoFixMeAnalyzer).

• Security and Reliability

  • Flags potential PII (Personally Identifiable Information) data patterns in code (PIIDataPatternAnalyzer).
  • Ensures regular expressions have timeouts to prevent ReDoS vulnerabilities (RegexTimeoutAnalyzer).

2. Installation

You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.

NuGet Package Manager

1. Open your project in Visual Studio.
2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
3. Search for Oakrey.CodeAnalyzers and click Install.

.NET CLI

Run the following command in your terminal:

dotnet add package Oakrey.CodeAnalyzers

Package Manager Console

Run the following command in your Package Manager Console:

Install-Package Oakrey.CodeAnalyzers

3. Requirements

• .NET 8 or higher

4. Project Information

• Author: Oakrey
• Company: Oakrey (Website Link)
• License: MIT
• Repository: Git Repository
• Project URL: Project Website

5. Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.

6. License

This project is licensed under the MIT License. See the LICENSE file for details.