Skip to content

chaowlert/PrimaryConstructor

Repository files navigation

PrimaryConstructor

Generate primary constructor from readonly fields & properties

NuGet

image

Get it

PM> Install-Package PrimaryConstructor

Prerequisites

Visual Studio version 16.8 and above is required as its first version to support source generators.

Usage

Declare class with partial, and annotate with [PrimaryConstructor].
And then you can declare your dependencies with readonly fields.

[PrimaryConstructor]
public partial class MyService
{
    private readonly MyDependency _myDependency;

    ...
}

When compile, following source will be injected.

partial class MyService
{
    public MyService(MyDependency myDependency)
    {
        this._myDependency = myDependency;
    }
}

Rules

  1. readonly fields & properties without initializer will be automatically injected.
  2. if the service has based type, based type must also annotated with PrimaryConstructor in order to inject members from based type.
  3. you can exclude members from injection by annotated with IgnorePrimaryConstructor.
  4. you can include members to injection by annotated with IncludePrimaryConstructor.

Emit generated files

Visual Studio still not fully support source generator, it sometimes shows error marker on symbols referred to the generated code. Emitting the generated files will allow you to see the code, and also solve Visual Studio error marker problem.

To emit generated files, add following code to your csproj file.

<PropertyGroup>
  <CompilerGeneratedFilesOutputPath>$(MSBuildProjectDirectory)/generated</CompilerGeneratedFilesOutputPath>
  <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
</PropertyGroup>

<Target Name="ExcludeGenerated" BeforeTargets="AssignTargetPaths">
  <ItemGroup>
    <Generated Include="generated/**/*.g.cs" />
    <Compile Remove="@(Generated)" />
  </ItemGroup>
  <Delete Files="@(Generated)" />
</Target>

Please check PrimaryConstructor.Sample.csproj for sample.