Try our conversational search powered by Generative AI!

Mads Storm Hansen
Nov 7, 2019
  1865
(6 votes)

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.

Nov 07, 2019

Comments

Petter Klang
Petter Klang Nov 7, 2019 08:50 AM

Nice!

Antti Alasvuo
Antti Alasvuo Nov 7, 2019 04:51 PM

Very nice Mads!

David Knipe
David Knipe Nov 8, 2019 07:20 AM

Very nice! 

Johan Björnfot
Johan Björnfot Nov 20, 2019 10:56 AM

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 ;-) ).

Mads Storm Hansen
Mads Storm Hansen Nov 20, 2019 11:44 AM

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.

Linus Ekström
Linus Ekström Nov 30, 2019 10:32 AM

Nice work Mads - very useful!

Please login to comment.
Latest blogs
Change the IP HTTP Header used for geo-lookup in Application Insights

.

Johan Kronberg | Jun 10, 2024 | Syndicated blog

Copying property values

In this article I’d like to show simple Edit Mode extension for copying property values to other language versions. In one of my previous blogposts...

Grzegorz Wiecheć | Jun 8, 2024 | Syndicated blog

Auto-translate with OpenAI GPT-4o in Optimizely CMS

Improvements for Episerver.Labs.LanguageManager! It's now possible to auto-translate both a page and its children at the same time! Additionally, m...

Tomas Hensrud Gulla | Jun 7, 2024 | Syndicated blog

Upgrade To Optimizely CMS 12 Issue: List item fields have become Required

There are many funny details to be aware of when upgrading from Episerver CMS 11 to Optimizely CMS 12. One of them that might feel a bit confusing ...

Allan Thraen | Jun 7, 2024 | Syndicated blog