PrimaryConstructor - GitLite

KO | EN

gitlite — search

#javascript #python #react #go #android #rust #deep-learning #macos #nodejs #java #windows #kubernetes #awesome-list #mcp

PrimaryConstructor

(★ 108)

Generate primary constructor from readonly fields

파일 탐색기

최종 버전 다운로드 (.zip)

- IgnorePrimaryConstructorAttribute.cs
- IncludePrimaryConstructorAttribute.cs
- PrimaryConstructor.csproj
- PrimaryConstructorAttribute.cs
- PrimaryConstructorGenerator.cs
- SyntaxReceiver.cs
- PrimaryConstructor.Sample.csproj
- Program.cs
.editorconfig
.gitignore
LICENSE
PrimaryConstructor.sln
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/chaowlert/PrimaryConstructor

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd PrimaryConstructor

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. .NET

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
.NET SDK dotnet 명령어를 쓰기 위한 SDK입니다.

cd PrimaryConstructor.Sample

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

dotnet restore

프로젝트에 필요한 패키지를 내려받습니다.

dotnet run

프로젝트를 빌드하고 바로 실행합니다.

✅ dotnet run 실행 후 터미널에 나타나는 안내 메시지나 주소를 확인하세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PrimaryConstructor
Generate primary constructor from readonly fields & properties

[![NuGet](https://img.shields.io/nuget/v/PrimaryConstructor.svg)](https://www.nuget.org/packages/PrimaryConstructor)

![image](https://user-images.githubusercontent.com/5763993/97197488-4b65ad80-17e0-11eb-9eef-305ce284eb78.png)

### 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.

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

...
}
```

When compile, following source will be injected.

```csharp
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.

```xml
<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](https://github.com/chaowlert/PrimaryConstructor/blob/main/PrimaryConstructor.Sample/PrimaryConstructor.Sample.csproj) for sample.