CSharp_IngeniousAnalyzer 3.4.2

CSharp_IngeniousAnalyzer (English)

A static analyzer designed to dramatically improve the code quality of your C# projects. It automatically detects issues such as insecure null checks, inefficient LINQ queries, and overly complex methods, helping you maintain a safe and clean codebase.

Feedback

Thank you very much for using this analyzer in your daily development. I created this tool based on my own professional needs, and I am committed to improving it to be more useful for your development workflows. Your feedback is very valuable to me. If you have any requests, suggestions for new rules, or encounter any issues, please feel free to reach out via the "Contact owners" link on the NuGet package page, or open an issue/discussion on our GitHub Repository. I would be honored to grow and refine this tool together with all of you.

How to use

This analyzer is fully integrated with Visual Studio's "Live Code Analysis." Simply open your project, and it will automatically analyze your code as you edit it, providing real-time warnings. If it does not run automatically, try rebuilding the project, restarting Visual Studio, or deleting the hidden .vs folder in your project root.

It also works the same way with dotnet build, VS Code (with the C# extension), and JetBrains Rider, since it's a standard Roslyn analyzer distributed as a NuGet package.

Coding Style

We use .editorconfig to enforce a unified code style and maintain high maintainability. We recommend ensuring the following settings are applied to maintain consistent code quality:

• Visual Studio: Supports .editorconfig by default.
• VS Code: Installing the EditorConfig for VS Code extension is recommended.

Customizing Rules

Default warning levels are set, but you can adjust them to fit your development environment or preferences. For example, to change a rule's severity from warning to info, modify your .editorconfig as follows:

Example: Changing COLL001 from 'warning' to 'info' dotnet_diagnostic.COLL001.severity = warning ↓ dotnet_diagnostic.COLL001.severity = info

CPX001 and CPX002 don't have a fix that rewrites the flagged method itself (a safe, 100%-accurate mechanical transformation can't be guaranteed). Instead, each provides a Quick Fix (light bulb) that inserts a // Ignore <RuleId> comment immediately before the target method (or right after the opening brace of its body), letting you intentionally suppress a specific occurrence (e.g. legacy code). You can also add this comment manually.

// Ignore CPX001
private void SomeComplexLegacyMethod() { ... }

ASYNC001 likewise doesn't provide a fix that appends .ConfigureAwait(false). Adding it changes where the code after the await runs (it no longer returns to the original SynchronizationContext), so code that touches UI elements (WinForms/WPF) or HttpContext.Current (ASP.NET Framework) after the await would break at runtime, and the analyzer alone can't determine this with 100% accuracy. Please add it manually after confirming that the code after the await doesn't depend on the context. For methods that intentionally need to return to the original context, a Quick Fix inserts // Ignore ASYNC001 at the start of the containing method's body (suppressing every await in that method, including those in lambdas and local functions). Awaits in async void methods/lambdas, static Main, and top-level statements are not flagged. If the rule is noisy in application or test projects, adjust its severity in .editorconfig.

UNI001 detects Unicode characters that can't be told apart visually. They sneak in easily when copying from web pages, AI chat output, or diff tools, and the code usually still compiles (C# treats a no-break space as whitespace, and zero-width characters are valid inside identifiers), so they are hard to notice. The following characters are flagged anywhere in the file (string literals, identifiers, whitespace, comments, and code disabled by #if):

The ideographic (full-width) space U+3000 is intentionally not flagged, as it is commonly used in Japanese text. Characters written as escape sequences (e.g. "\u00A0") are visible in the source and are not flagged either, so write intentional uses that way.

UNI001 doesn't provide a fix that rewrites the character. For example, whether a no-break space in a string should become a normal space, be removed, or is intentional can't be determined by the analyzer, and replacing it with \u00A0 would only hide the warning while leaving the bug in place. Please correct it manually. For intentional occurrences, a Quick Fix inserts // Ignore UNI001 immediately before the nearest statement or member declaration (field, method, class, etc.) containing the character. The comment also suppresses everything inside that statement/member, so placing it before a method or class suppresses the whole method or class.

Rule List

CSharp_IngeniousAnalyzer (日本語)

C#のコード品質を劇的に高める静的アナライザーです。 NULLチェックの型安全性欠如や、非効率なLINQ等を自動検知し、安全でクリーンなコードへの修正を支援します。

フィードバックについて

本アナライザーを日々ご利用いただき、誠にありがとうございます。 このツールは私自身が業務で「あったらいいな」と考えたものを形にしたものです。 至らぬ点もあるかと存じますが、より使いやすく、皆様の開発の助けとなるよう、継続的に改善を行っていきたいと考えています。 皆様からのご意見は大変貴重な財産です。 「ここをこうしてほしい」「このルールがあると嬉しい」といったご要望やフィードバックがございましたら、NuGetページ右下の「Contact owners」、または GitHubリポジトリのIssues/Discussions よりお気軽にご連絡ください。 皆様と一緒にこのツールを育てていけたら幸いです。

使い方

本アナライザーは Visual Studio の「Live Code Analysis」と完全に統合されています。 プロジェクトを開くだけで、コードの編集時に自動的に解析が実行され、問題がある場合はリアルタイムで警告が表示されます。 自動的に解析が実行されない場合は、リビルド、VS再起動、またはプロジェクトルートにある .vs フォルダー（隠しフォルダー）の削除を試してください。

標準的なRoslynアナライザーとしてNuGetパッケージ経由で配布しているため、dotnet build・VS Code（C#拡張機能）・JetBrains Riderでも同様に動作します。

コーディングスタイル

本プロジェクトでは、コードスタイルを統一し、保守性を維持するために .editorconfig を採用しています。

• Visual Studio: .editorconfig は標準でサポートされています。
• VS Code: EditorConfig for VS Code 拡張機能のインストールを推奨します。

ルールのカスタマイズ

デフォルトの警告レベルは設定済みですが、開発環境に合わせて .editorconfig で調整可能です。

例: COLL001の警告を info に変更する dotnet_diagnostic.COLL001.severity = warning ↓ dotnet_diagnostic.COLL001.severity = info

CPX001・CPX002は、警告対象のメソッド自体を書き換えるFixは提供していません（機械的に100%安全な変換を保証できないため）。代わりに、対象のメソッドの直前（またはメソッド本体の先頭）に // Ignore <ルールID> コメントを自動挿入するクイックフィックス（電球アイコン）を用意しているので、レガシーコード等の特定箇所を意図的に抑制できます。手動でコメントを追加しても構いません。

// Ignore CPX001
private void SomeComplexLegacyMethod() { ... }

ASYNC001も同様に、.ConfigureAwait(false) を追記するFixは提供していません。追記すると await 以降の処理が元の SynchronizationContext に戻らなくなるため、await の後でUI要素（WinForms/WPF）や HttpContext.Current（ASP.NET Framework）に触れているコードは実行時に動作しなくなります。アナライザー単体ではこれを100%判定できないため、await 以降の処理がコンテキストに依存していないことを確認のうえ、手動で追加してください。意図的に元のコンテキストへ戻す必要があるメソッドには、メソッド本体の先頭に // Ignore ASYNC001 を挿入するクイックフィックスを用意しています（ラムダ式・ローカル関数を含め、そのメソッド内のすべての await が抑制されます）。なお、async void のメソッド・ラムダ式、static Main、トップレベルステートメント内の await は検知対象外です。アプリケーションやテストプロジェクトでノイズになる場合は、.editorconfig でseverityを調整してください。

UNI001は、目視で判別できないUnicode文字を検知します。Webページ・生成AIのチャット出力・差分ツール等からのコピー＆ペーストで混入しやすく、多くの場合そのままコンパイルが通る（C#はノーブレークスペースを空白として扱い、ゼロ幅文字は識別子の一部として有効）ため、気付くのが困難です。ファイル内のあらゆる場所（文字列リテラル・識別子・空白・コメント・#if で無効化されたコード）にある以下の文字を検知します。

全角スペース（U+3000）は日本語の文字列・コメントで意図的に使われることが多いため、対象外としています。また、エスケープシーケンス（"\u00A0" 等）で記述された文字はソース上で目視できるため検知しません。意図的に使う場合はエスケープシーケンスで記述してください。

UNI001は、文字を書き換えるFixは提供していません。例えば文字列内のノーブレークスペースは、半角スペースにすべきか・削除すべきか・意図的なのかをアナライザーが判断できず、\u00A0 への置き換えは不具合を残したまま警告だけを消してしまうためです。手動で修正してください。意図的な箇所には、その文字を含む直近の文またはメンバー宣言（フィールド・メソッド・クラス等）の直前に // Ignore UNI001 を挿入するクイックフィックスを用意しています。このコメントはその文・メンバーの内側すべてに効くため、メソッドやクラスの直前に書けば、そのメソッド・クラス全体を抑制できます。

Rule List (ルール一覧)