Skip to main content

How to Add New Analyzer

Discuss the Idea​

It is recommended to create issue where you can describe and discuss the idea and if it is accepted by the maintainers you can start with a development.

Choose Project/Package​

Analyzers​

Suitable for analyzers that do no fit into any of the following packages. ID prefix for these analyzers is RCS1.

Formatting.Analyzers​

Suitable for analyzers that reports invalid formatting. Code fix for these analyzers usually only manipulates with whitespace. ID prefix for these analyzers is RCS0.

CodeAnalysis.Analyzers​

Suitable for analyzers that analyze types from Roslyn API (Microsoft.CodeAnalysis* packages). ID prefix for these analyzers is RCS9.

note

It's rare, but it's possible to introduce new project/package.

Add Metadata​

Add new analyzer metadata to Analyzers.xml file. It's possible to use a template.

See metadata reference for further information.

Generate Code​

Run script tools/generate_code.ps1.

Another option is to launch project CodeGenerator from Visual Studio.

Implement Analyzer​

Add class that derives from BaseDiagnosticAnalyzer or possibly use some already existing analyzer class.

Implement Code Fix​

info

It's strongly recommended to implement code fix for the analyzer.

Add class that derives from BaseCodeFixProvider or possibly use some already existing code fix provider class.

Add Tests​

  • Add new file to a folder Analyzers.Tests. Convention is to name the file [Id][Identifier]Tests.cs.
tip

When writing a test code, tokens [| and |] represents start and end of a selected text respectively.

Update Changelog​

CHANGELOG.md
### Added

- Add analyzer "ANALYZER_TITLE" ([ANALYZER_ID](https://josefpihrt.github.io/docs/roslynator/analyzers/ANALYZER_ID)) ([#PR_ID](https://github.com/josefpihrt/roslynator/pull/PR_ID))
  - Add some description if necessary ...