https://github.com/maroontress/stylechecker
StyleChecker is another code style checking and refactoring tool similar to NetAnalyzers, StyleCop Analyzers, SonarLint, Roslynator, etc.
https://github.com/maroontress/stylechecker
csharp csharp12 roslyn roslyn-analyzer roslyn-codefix stylechecker visual-studio
Last synced: 3 months ago
JSON representation
StyleChecker is another code style checking and refactoring tool similar to NetAnalyzers, StyleCop Analyzers, SonarLint, Roslynator, etc.
- Host: GitHub
- URL: https://github.com/maroontress/stylechecker
- Owner: maroontress
- License: other
- Created: 2018-08-13T20:25:16.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2025-06-12T06:04:22.000Z (4 months ago)
- Last Synced: 2025-06-12T06:06:38.854Z (4 months ago)
- Topics: csharp, csharp12, roslyn, roslyn-analyzer, roslyn-codefix, stylechecker, visual-studio
- Language: C#
- Homepage: https://maroontress.github.io/StyleChecker/
- Size: 1.09 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# StyleChecker
StyleChecker is another code style checking and refactoring tool similar to
[NetAnalyzers][netanalyzers], [StyleCop Analyzers][stylecopanalyzers],
[SonarLint][sonarlint], [Roslynator][roslynator], etc. It uses the
[.NET Compiler Platform ("Roslyn")][roslyn] to analyze the C# source code of
.NET projects and outputs diagnostics of rule violations. And when used with
IDEs such as Visual Studio, it provides as many code fixes as possible. Note
that you should use this tool with other Roslyn analyzers, as it contains only
complementary or niche analyzers.
## Get started
StyleChecker is available as [the ![NuGet-logo][nuget-logo] NuGet
package][nuget-stylechecker].
### Install StyleChecker to your project with Visual Studio
1. Open Package Manager Console. (Open your project with Visual Studio, and
select Tools ➜ NuGet Package Manager ➜ Package Manager
Console.)
2. Enter the command `Install-Package StyleChecker` in the Package Manager
Console.
### Install StyleChecker to your project with .NET CLI
- Enter the command `dotnet add package StyleChecker` with the console.
## Diagnostics
See [the list of diagnostics](doc/rules).
## Customize configuration
You can customize some analyzers to change their behaviors by placing the
configuration file `StyleChecker.xml` at the project root. The XML Schema
Definition file `config.v1.xsd` of the configuration file and a sample of the
configuration file are available in the directory
`StyleChecker/StyleChecker/nuget/samples/` of the source tree (or in
`~/.nuget/packages/stylechecker/VERSION/samples/` if you installed StyleChecker
with the NuGet package). Note that StyleChecker does not use the XML Schema
Definition file. But it helps you edit `StyleChecker.xml` with the text editor
that can validate XML documents (for example, Visual Studio IDE, Visual Studio
Code, and so on).
Create your own `StyleChecker.xml` file, place it at your project root, and add
the `AdditionalFiles` element to the `.csproj` file in your project as follows:
```xml
```
Alternatively, in Visual Studio, you can set the value "C# analyzer additional
file" to the Build Action property. You can change this property from Solution
Explorer ➜ Right Click on the `StyleChecker.xml` ➜ Properties
➜ Advanced ➜ Build Action.
[roslyn]: https://github.com/dotnet/roslyn
[netanalyzers]: https://www.nuget.org/packages/Microsoft.CodeAnalysis.NetAnalyzers
[stylecopanalyzers]: https://github.com/DotNetAnalyzers/StyleCopAnalyzers
[sonarlint]: https://github.com/SonarSource/sonarlint-visualstudio
[roslynator]: https://github.com/JosefPihrt/Roslynator
[nuget-stylechecker]: https://www.nuget.org/packages/StyleChecker/
[nuget-logo]: https://maroontress.github.io/images/NuGet-logo.png