Cake Addin Analyzer (Cake.Addin.Analyzer)

Analyzer for cake addins to detect if there are any recommended or required changes that can be done.

Table of Contents

• Background
• Install
• Usage
• Maintainers
• Contributing
• License

Background

This analyzer came into the created because I wanted to get some conformaty with Cake addins by reporting recommended/required changes that are expected for every Cake addin.

Install

You can simply make use of this analyzer by running the following command in the directory of each project you wish the analyzer to run on.

dotnet add package Cake.Addin.Analyzer

Usage

There is nothing specifically that needs to be done to use the analyzer. It will automatically run when calling dotnet build, or when opening a file in Visual Studio.

You can configure the severity of each rule using a editorconfig file (see each rule for details on how here: https://wormiecorp.github.io/Cake.Addin.Analyzer/rules).

Maintainers

@AdmiringWorm

Contributing

See the contributing file!

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Kim J. Nordmo 🚧

Pascal Berger 🐛

Gary Ewan Park 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT © 2020-2021 Kim J. Nordmo