DataverseAnalyzer 1.0.11

Dataverse Analyzer

A Roslyn analyzer enforcing coding standards for Dataverse/.NET projects.

Rules Overview

Style Rules

CT0001: Braceless Control Flow

Control flow statements without braces can only contain: return, throw, continue, break, or yield break.

// Allowed
if (condition)
    return;

// Not allowed - triggers CT0001
if (condition)
    DoSomething();

CT0003: Object Initialization Parentheses

Remove empty parentheses when using object initializers.

// Allowed
var account = new Account { Name = "Test" };

// Not allowed - triggers CT0003
var account = new Account() { Name = "Test" };

CT0004: Braced Control Flow

Remove braces when a block contains only a single control flow statement.

// Allowed
if (condition)
    return;

// Not allowed - triggers CT0004
if (condition)
{
    return;
}

Usage Rules

CT0002: Enum Assignment

Enum properties should use enum values, not literals.

// Allowed
AccountCategoryCode = AccountCategoryCode.Standard;

// Not allowed - triggers CT0002
AccountCategoryCode = 1;

CT0005: Duplicate DI Parameters

Constructors shouldn't have multiple parameters of the same DI type (Service, Repository, Handler, Provider, Factory, Manager, Client).

// Not allowed - triggers CT0005
public MyClass(IUserService userService, IUserService adminService) { }

CT0007: Entity Contains

Use type-safe ContainsAttributes instead of string-based Contains on Entity types.

// Allowed
if (account.ContainsAttributes(x => x.Name))

// Not allowed - triggers CT0007
if (account.Contains("name"))

CT0008-CT0010: Plugin Step Configuration

These rules prevent invalid plugin step configurations in Dataverse:

// Not allowed - triggers CT0008
RegisterPluginStep<Account>(EventOperation.Create)
    .AddFilteredAttributes(a => a.Name);

// Not allowed - triggers CT0009
RegisterPluginStep<Account>(EventOperation.Create)
    .AddImage(ImageType.PreImage);

// Not allowed - triggers CT0010
RegisterPluginStep<Account>(EventOperation.Delete)
    .AddImage(ImageType.PostImage);

Documentation Rules

CT0006: Plugin Documentation

Classes implementing IPlugin must have XML documentation.

// Allowed
/// <summary>Updates account name on create.</summary>
public class UpdateAccountPlugin : IPlugin { }

// Not allowed - triggers CT0006
public class UpdateAccountPlugin : IPlugin { }

Usage

Building

dotnet build src\DataverseAnalyzer\DataverseAnalyzer.csproj --configuration Release

Integration

Reference the analyzer in your project:

<ItemGroup>
  <Analyzer Include="path\to\DataverseAnalyzer.dll" />
</ItemGroup>