ReferenceCop 0.0.3-alpha

ReferenceCop

ReferenceCop is a suite of tools (including a Roslyn analyzer and an MSBuild task) that work together to help .NET teams enforce agreed-upon dependency management rules at build time. Prevents discouraged or prohibited references from being added to projects, maintaining clean architecture as defined by your team.

Usage

To enable ReferenceCop in your project, follow the steps below:

1. Add ReferenceCop as a PackageReference to your project.

In case you are using Central Package Management, you can add ReferenceCop as a GlobalPackageReference in your Directory.Packages.Props file.

<ItemGroup>
    <GlobalPackageReference Include="ReferenceCop" Version="{LatestVersion}" />
</ItemGroup>

2. Add a ReferenceCop.config file to your project and define the repository root for ReferenceCop to use. Please make sure the add the respective ReferenceCopConfig Label node:

<ItemGroup>
    <AdditionalFiles Include="./ReferenceCop.config">
        <Label>ReferenceCopConfig</Label>
    </AdditionalFiles>
</ItemGroup>

3. Define the ReferenceCopRepositoryRoot property. This is used to define the root of the repository where the project is located. This is used to resolve the paths of the project references. The recommended value for ReferenceCopRepositoryRoot is $(MSBuildStartupDirectory) as this will typically be the root of the solution where the project is located. If this does not work for your project, you can set the value to a different path.

<PropertyGroup>
    <ReferenceCopRepositoryRoot>$(MSBuildStartupDirectory)</ReferenceCopRepositoryRoot>
</PropertyGroup>

4. Build the project. You will see a set of warnings or errors based on the violations that were detected. Here are the diagnostic descriptors returned:

Configuration

The ReferenceCop.config file defines a set of rules to be enforced. The config file should be added to the project as an AdditionalFile. This file will contain the rules you want to enforce. The contents of this configuration are explained in the section below.

Rule Properties

All rules have the following properties:

• Name - A unique name for the rule.
• Description - A description of the rule.
• Severity - The severity of the rule violation. Can be error or warning.

Besides the common properties, each rule can have the following properties depending on the type of rule:

AssemblyName

• Pattern - The pattern to search for in the name of a project or package reference. It can be either an exact reference AssemblyName, or a prefix pattern that ends with '*'. This can be either a project reference or a package reference.

ProjectPath

• Pattern - The pattern to search for in the path of a project references. The value should be relative to the path where the config file is located, and it can be either an exact path or a prefix pattern that ends with '*'.

ProjectTag

• Tag - The tag to search for in the project's csproj file that qualifies the project in some way. ReferenceCop will look for the ProjectTag node for this detection.
• For example, a tag can indicate the layer that the project belongs to: UI, Business, Data, etc.

Example

Here is an example of a ReferenceCop.config file:

<ReferenceCopConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/mfogliatto/ReferenceCop/main/ReferenceCopConfig.xsd">
    <Rules>
        <AssemblyName>
            <Name>XMustNotBeUsed</Name>
            <Description>Use of X is forbidden. Ensure that Y is used instead</Description>       
            <Severity>Error</Severity>
            <Pattern>X</Pattern>
        </AssemblyName>
        <AssemblyName>
			<Name>TryToAvoidLibraryX</Name>
			<Description>Consider using Y instead of X</Description>
			<Severity>Warning</Severity>
            <Pattern>X</Pattern>
        </AssemblyName>
        <ProjectTag>
            <Name>AbstractionsShouldNotReferenceImplementations</Name>
            <Description>Ensure Abstractions do not reference Implementations</Description>
            <Severity>Error</Severity>
            <FromProjectTag>Abstractions</FromProjectTag>
            <ToProjectTag>Implementations</ToProjectTag>
        </ProjectTag>
        <ProjectPath>
            <Name>AppShouldNotReferenceData</Name>
            <Description>Ensure UI projects do not reference Data projects</Description>
            <Severity>Error</Severity>
            <FromPath>src\UI</FromPath>
            <ToPath>src\data</ToPath>
        </ProjectPath>
    </Rules>
</ReferenceCopConfig>

Diagnostic Descriptors

Scaling Configuration

In case you'd like to enable ReferenceCop and apply the same configuration to multiple projects in a directory, you can do that in a Directory.Build.props file by Customizing the build by folder.

License

ReferenceCop is licensed under the MIT license. See LICENSE for more information.