Introducing Code analyzers for Episerver
Code analyzers for Episerver is a new Roslyn-based plugin that analyzes your Episerver code as you type. It can help you avoid some problems with editor experience and code maintainability.
The plugin will show live warnings ("squiggles") in Visual Studio while you are typing.
Analyzers
Inspired by a recent blog post, Code analyzers for Episerver looks for the correct use of content type and property attributes to ensure a good experience for your editors.
The analyzer rules can be configured individually and phased in gradually in a larger codebase.
Code analyzers for Episerver also looks for the use of known legacy types and 'Internal' namespaces that should be avoided in your code.
Configuration
Each analyzer rule severity can be configured in a ruleset file similar to Visual Studios built-in code analysis.
Installation
Code analyzers for Episerver is installed per-project as a NuGet package from the Episerver feed.
Visual Studio automatically detects and executes the analyzers. Build servers will also execute the analyzer rules on every build.
Compatibility
Code analyzers for Episerver is compatible with the compilers in Visual Studio 2019 and Visual Studio 2017 (15.5+).
If your project references an old version of the Microsoft.Net.Compilers package you may need to upgrade this to 2.6.1+ for compatibility with Code analyzers for Episerver.
Nice!
Very nice Mads!
Very nice!
Nice! A nice addition would be an analyzer that detects if you use types from internal namespaces (I have a prototype of such an analyzer in some closet somewhere ;-) ).
Thanks Johan. It already detects types from Internal Episerver/Mediachase namespaces.
Latest addition (v1.1) is detecting use of older concrete Order classes (Cart, LineItem etc.) where interfaces are preferred.
Nice work Mads - very useful!