Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 2.08 KB

README.md

File metadata and controls

56 lines (39 loc) · 2.08 KB
Raw

NuGet Package: Escendit.Tools.CodeAnalysis.xUnitAnalyzers

This NuGet package leverages the power of xunit analyzers to enforce code quality standards that are tailored to the organization's specific needs. By default, the package uses a set of analyzer rules that have been configured to align with the organization's coding practices, ensuring that our code is always compliant and maintainable.

Key features:

  • Utilize xunit analyzers for powerful and customizable code analysis
  • Defaults suited to the organization's coding practices
  • Ensures code compliance and maintainability

Installation

To install this package, use the NuGet Package Manager Console:

PM> Install-Package Escendit.Tools.CodeAnalysis.xUnitAnalyzers

Or you can search for "Escendit.Tools.CodeAnalysis.xUnitAnalyzers" in the NuGet Package Manager UI and install it from there.

Usage

After installing the package, the MSBuild and .editorconfig properties will be set automatically.

  • You can modify the MSBuild properties by updating the values in your .csproj or .vbproj file.
  • You can modify the .editorconfig properties by creating .editorconfig file and overriding the default values.

Configuration

The NuGet package includes the following default rules and severity levels:

Currently, vendor provides the defaults.

To modify the severity level of a rule, you can add the following code to your .editorconfig file:

dotnet_diagnostic.<Rule>.severity = <Severity>

For example, to change the severity level of xUnit9999 to "error", add the following line to your .editorconfig file:

dotnet_diagnostic.xUnit9999.severity = error

Browse here for available rules.

Contributing

If you find a bug or have a feature request, please create an issue in the GitHub repository.

To contribute code, fork the repository and submit a pull request. Please ensure that your code follows the project's coding standards and is thoroughly tested.

License

This package is released under the MIT License. See the LICENSE.txt file for details.