dotnet new에 대한 사용자 지정 템플릿

.NET SDK에는 이미 설치되어 있고 사용할 준비가 된 많은 템플릿이 함께 제공됩니다. 이dotnet new 명령은 템플릿을 사용하는 방법뿐만 아니라 템플릿을 설치하고 제거하는 방법도 제공합니다. 앱, 서비스, 도구 또는 클래스 라이브러리와 같은 모든 유형의 프로젝트에 대한 사용자 지정 템플릿을 만들 수 있습니다. 구성 파일과 같은 하나 이상의 독립 파일을 출력하는 템플릿을 만들 수도 있습니다.

NuGet . nupkg 파일을 직접 참조하거나 템플릿이 포함된 파일 시스템 디렉터리를 지정하여 NuGet 패키지의 사용자 지정 템플릿을 NuGet 피드에 설치할 수 있습니다. 템플릿 엔진은 템플릿을 사용할 때 값을 바꾸고, 파일을 포함 및 제외하고, 사용자 지정 처리 작업을 실행할 수 있는 기능을 제공합니다.

템플릿 엔진은 오픈 소스이며 온라인 코드 리포지토리는 GitHub의 dotnet/templating 에 있습니다. 타사의 템플릿을 포함하여 더 많은 템플릿을 사용하여 dotnet new search찾을 수 있습니다. 사용자 지정 템플릿을 만들고 사용하는 방법에 대한 자세한 내용은 dotnet new 및 dotnet/templating GitHub 리포지토리 Wiki에 대한 고유한 템플릿을 만드는 방법을 참조하세요.

연습을 수행하고 템플릿을 만들려면 dotnet 새 자습서에 대한 사용자 지정 템플릿 만들기 를 참조하세요.

.NET 기본 템플릿

.NET SDK를 설치하면 콘솔 앱, 클래스 라이브러리, 단위 테스트 프로젝트, ASP.NET Core 앱(Angular 및 React 프로젝트 포함), 구성 파일을 비롯한 여러 프로젝트와 파일을 만들 수 있는 12개 이상의 기본 제공 템플릿이 제공됩니다. 기본 제공 템플릿을 나열하려면 dotnet new list 명령을 실행합니다.

dotnet new list

구성 / 설정

템플릿은 다음 부분으로 구성됩니다.

• 원본 파일 및 폴더.
• 구성 파일(template.json)입니다.

원본 파일 및 폴더

템플릿 엔진이 명령 dotnet new <TEMPLATE>을 실행할 때 사용할 파일 및 폴더에는 원본 파일과 폴더가 포함됩니다. 템플릿 엔진은 실행 가능한 프로젝트를 소스 코드로 사용하여 프로젝트를 생성하도록 설계되었습니다. 여기에는 여러 가지 이점이 있습니다.

• 템플릿 엔진은 프로젝트의 소스 코드에 특수 토큰을 삽입할 필요가 없습니다.
• 코드 파일은 특별한 파일이 아니거나 템플릿 엔진으로 작업하기 위해 어떤 방식으로든 수정되지 않습니다. 따라서 프로젝트 작업 시 일반적으로 사용하는 도구도 템플릿 콘텐츠로 작동합니다.
• 다른 프로젝트와 마찬가지로 템플릿 프로젝트를 빌드, 실행 및 디버그합니다.
• ./.template.config/template.json 구성 파일을 프로젝트에 추가하여 기존 프로젝트에서 템플릿을 빠르게 만들 수 있습니다.

템플릿에 저장된 파일 및 폴더는 공식적인 .NET 프로젝트 형식으로 제한되지 않습니다. 원본 파일 및 폴더는 템플릿 엔진이 하나의 파일만 출력으로 생성하는 경우에도 템플릿을 사용할 때 만들려는 콘텐츠로 구성됩니다.

템플릿에서 생성된 파일은 template.json 구성 파일에서 제공한 논리 및 설정에 따라 수정할 수 있습니다. 사용자는 dotnet new <TEMPLATE> 명령에 옵션을 전달하여 이러한 설정을 재정의할 수 있습니다. 사용자 지정 논리의 일반적인 예는 템플릿에 의해 배포된 코드 파일에서 클래스 또는 변수의 이름을 제공하는 것입니다.

template.json

template.json 파일은 템플릿의 루트 디렉터리에 있는 .template.config 폴더에 배치됩니다. 파일은 템플릿 엔진에 구성 정보를 제공합니다. 최소 구성을 사용하려면 다음 표에 나와 있는 멤버가 필요하며, 이는 기능 템플릿을 만들기에 충분합니다.

template.json 파일의 전체 스키마는 JSON 스키마 저장소에 있습니다. template.json 파일에 대한 자세한 내용은 dotnet templating wiki를 참조하세요. Visual Studio에서 템플릿을 표시하는 방법에 대한 자세한 예제 및 정보는 Sayed Hashimi에서 만든 리소스를 확인하세요.

예시

예를 들어 console.cs 및 readme.txt 두 개의 콘텐츠 파일이 포함된 템플릿 폴더가 있습니다. .template.config라는 필수 폴더에는 template.json 파일이 포함되어 있습니다.

└───mytemplate
    │   console.cs
    │   readme.txt
    │
    └───.template.config
            template.json

template.json 파일은 다음과 같습니다.

{
  "$schema": "http://json.schemastore.org/template",
  "author": "Travis Chau",
  "classifications": [ "Common", "Console" ],
  "identity": "AdatumCorporation.ConsoleTemplate.CSharp",
  "name": "Adatum Corporation Console Application",
  "shortName": "adatumconsole"
}

mytemplate 폴더는 설치 가능한 템플릿 패키지입니다. 패키지가 설치되면 shortName 명령과 함께 dotnet new 사용할 수 있습니다. 예를 들어 dotnet new adatumconsole 현재 폴더에 console.cs 파일 및 readme.txt 파일을 출력합니다.

템플릿 지역화

.NET 템플릿은 지역화할 수 있습니다. 템플릿이 현재 로캘과 일치하는 언어로 지역화된 경우 해당 요소는 CLI와 동일한 언어로 표시됩니다. 지역화는 새 템플릿을 만들 때 선택 사항입니다.

템플릿에서 지역화할 수 있는 요소는 다음과 같습니다.

• 이름
• 작성자
• 설명
• 기호
  • 설명
  • 표시 이름
  • 선택 매개 변수에 대한 선택 항목의 설명 및 표시 이름
• 게시 작업
  • 설명
  • 수동 지침

지역화 파일은 JSON 형식이며 문화권당 하나의 파일만 존재해야 합니다. 명명 규칙은 templatestrings.<lang code>.json 옵션 중 하나에 해당하는 값 lang code 입니다. 모든 지역화 파일은 폴더 내에 .template-config\localize 있어야 합니다.

지역화 JSON은 키 값 쌍으로 구성됩니다.

• 키는 template.json 요소를 지역화하기 위한 참조입니다. 요소가 자식인 경우 구분 기호가 있는 / 전체 경로를 사용합니다.
• 값은 키가 지정한 요소의 지역화 문자열입니다.

템플릿 지역화에 대한 자세한 내용은 dotnet templating wiki의 지역화 페이지를 참조하세요.

예시

예를 들어 지역화 가능한 필드가 있는 template.json 파일은 다음과 같습니다.

{
  "$schema": "http://json.schemastore.org/template",
  "author": "Microsoft",
  "classifications": "Config",
  "name": "EditorConfig file",
  "description": "Creates an .editorconfig file for configuring code style preferences.",
  "symbols": {
    "Empty": {
      "type": "parameter",
      "datatype": "bool",
      "defaultValue": "false",
      "displayName": "Empty",
      "description": "Creates empty .editorconfig instead of the defaults for .NET."
    }
  }
}

그리고 일부 필드는 브라질 포르투갈어로 지역화되어야합니다. 파일 이름은 문화권 templatestrings.pt-BR.json 과 일치하며 다음과 같습니다.

{
  "author": "Microsoft",
  "name": "Arquivo EditorConfig",
  "description": "Cria um arquivo .editorconfig para configurar as preferências de estilo de código.",
  "symbols/Empty/displayName": "Vazio",
  "symbols/Empty/description": "Cria .editorconfig vazio em vez dos padrões para .NET."
}

NuGet 패키지에 템플릿 압축(nupkg 파일)

사용자 지정 템플릿은 dotnet pack 명령 및 .csproj 파일로 압축됩니다. 또는 NuGet을 .nuspec 파일과 함께 nuget pack 명령과 함께 사용할 수 있습니다. 그러나 NuGet에는 Windows의 .NET Framework와 Linux 및 macOS의 Mono 가 필요합니다.

.csproj 파일은 기존의 코드 프로젝트 .csproj 파일과 약간 다릅니다. 다음 설정을 확인합니다.

1. 설정이 <PackageType>에 추가되고 Template로 설정됩니다.
2. 설정이 <PackageVersion> 추가되고 유효한 NuGet 버전 번호로 설정됩니다.
3. <PackageId> 설정이 추가되고 고유 식별자로 설정됩니다. 이 식별자는 템플릿 팩을 제거하는 데 사용되며 NuGet 피드에서 템플릿 팩을 등록하는 데 사용됩니다.
4. 일반 메타데이터 설정은 <Title>, <Authors>, <Description> 및 <PackageTags>로 설정해야 합니다.
5. 템플릿 프로세스에서 생성된 바이너리가 사용되지 않더라도 <TargetFramework> 설정을 해야 합니다. 아래 예제에서는 .로 설정됩니다 netstandard2.0.

.nupkg NuGet 패키지 형식의 템플릿 패키지는 모든 템플릿을 패키지 내의 콘텐츠 폴더에 저장해야 합니다. 생성된 .nupkg를 템플릿 팩으로 설치할 수 있도록 .csproj 파일에 추가할 몇 가지 설정이 더 있습니다.

1. NuGet <IncludeContentInPack> 패키지에서 프로젝트가 true로 설정한 모든 파일을 포함하도록 설정됩니다.
2. NuGet 패키지에서 컴파일러가 생성한 모든 바이너리를 제외하도록 <IncludeBuildOutput> 설정이 false으로 설정됩니다.
3. <ContentTargetFolders> 설정이 content로 설정됩니다. 이렇게 하면 콘텐츠 로 설정된 파일이 NuGet 패키지의 콘텐츠 폴더에 저장됩니다. NuGet 패키지의 이 폴더는 닷넷 템플릿 시스템에 의해 구문 분석됩니다.

템플릿 프로젝트에서 모든 코드 파일을 컴파일하지 않도록 제외하는 쉬운 방법은 프로젝트 파일의 <Compile Remove="**\*" /> 요소 내부에 있는 <ItemGroup> 항목을 사용하는 것입니다.

템플릿 팩을 구성하는 쉬운 방법은 모든 템플릿을 개별 폴더에 배치한 다음 각 템플릿 폴더를 .csproj 파일과 동일한 디렉터리에 있는 템플릿 폴더 내에 배치하는 것입니다. 이렇게 하면 단일 프로젝트 항목을 사용하여 템플릿의 모든 파일과 폴더를 콘텐츠로 포함할 수 있습니다. <ItemGroup> 요소 내에 <Content Include="templates\**\*" Exclude="templates\**\bin\**;templates\**\obj\**" /> 항목을 만듭니다.

다음은 이러한 모든 지침을 따르는 .csproj 파일의 예입니다. 템플릿 자식 폴더 를콘텐츠 패키지 폴더에 압축하고 코드 파일이 컴파일되지 않도록 제외합니다.

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <PackageType>Template</PackageType>
    <PackageVersion>1.0</PackageVersion>
    <PackageId>AdatumCorporation.Utility.Templates</PackageId>
    <Title>AdatumCorporation Templates</Title>
    <Authors>Me</Authors>
    <Description>Templates to use when creating an application for Adatum Corporation.</Description>
    <PackageTags>dotnet-new;templates;contoso</PackageTags>
    <TargetFramework>netstandard2.0</TargetFramework>

    <IncludeContentInPack>true</IncludeContentInPack>
    <IncludeBuildOutput>false</IncludeBuildOutput>
    <ContentTargetFolders>content</ContentTargetFolders>
  </PropertyGroup>

  <ItemGroup>
    <Content Include="templates\**\*" Exclude="templates\**\bin\**;templates\**\obj\**" />
    <Compile Remove="**\*" />
  </ItemGroup>

</Project>

다음 예제에서는 .csproj 를 사용하여 템플릿 패키지를 만드는 파일 및 폴더 구조를 보여 줍니다. MyDotnetTemplates.csproj 파일 및 템플릿 폴더는 모두 project_folder 디렉터리의 루트에 있습니다. 템플릿 폴더에는 mytemplate1과 mytemplate2의 두 가지 템플릿이 포함되어 있습니다. 각 템플릿에는 콘텐츠 파일과 template.json 구성 파일이 있는 .template.config 폴더가 있습니다.

project_folder
│   MyDotnetTemplates.csproj
│
└───templates
    ├───mytemplate1
    │   │   console.cs
    │   │   readme.txt
    │   │
    │   └───.template.config
    │           template.json
    │
    └───mytemplate2
        │   otherfile.cs
        │
        └───.template.config
                template.json

템플릿 패키지 설치

dotnet new install 명령을 사용하여 템플릿 패키지를 설치합니다.

nuget.org 저장된 NuGet 패키지에서 템플릿 패키지를 설치하려면

NuGet 패키지 식별자를 사용하여 템플릿 패키지를 설치합니다.

dotnet new install <NUGET_PACKAGE_ID>

사용자 지정 NuGet 원본에서 템플릿 패키지를 설치하려면

사용자 지정 NuGet 원본(예: https://api.my-custom-nuget.com/v3/index.json)을 제공합니다.

dotnet new install <NUGET_PACKAGE_ID> --nuget-source <SOURCE>

로컬 nupkg 파일에서 템플릿 패키지를 설치하려면

.nupkg NuGet 패키지 파일의 경로를 제공합니다.

dotnet new install <PATH_TO_NUPKG_FILE>

파일 시스템 디렉터리에서 템플릿 패키지를 설치하려면

이전 예제의 mytemplate1 폴더와 같은 템플릿 폴더에서 템플릿을 설치할 수 있습니다. .template.config 폴더의 폴더 경로를 지정합니다. 템플릿 디렉터리의 경로는 절대 경로일 필요가 없습니다.

dotnet new install <FILE_SYSTEM_DIRECTORY>

설치된 템플릿 패키지 목록 가져오기

제거 명령은 다른 매개 변수 없이 설치된 모든 템플릿 패키지와 포함된 템플릿을 나열합니다.

dotnet new uninstall

이 명령은 다음 출력과 유사한 항목을 반환합니다.

Currently installed items:
   Microsoft.Azure.WebJobs.ProjectTemplates
      Version: 4.0.1942
      Details:
         Author: Microsoft
         NuGetSource: https://api.nuget.org/v3/index.json
      Templates:
         Azure Functions (func) C#
         Azure Functions (func) F#
      Uninstall Command:
         dotnet new uninstall Microsoft.Azure.WebJobs.ProjectTemplates
...

다음 Currently installed items: 항목의 첫 번째 수준은 템플릿 패키지를 제거하는 데 사용되는 식별자입니다. 그리고 이전 예제에서는 Microsoft.Azure.WebJobs.ProjectTemplates 나열됩니다. 파일 시스템 경로를 사용하여 템플릿 패키지를 설치한 경우 이 식별자는 .template.config 폴더의 폴더 경로입니다. 통해 dotnet new install 설치된 템플릿 패키지만 목록에 표시됩니다. .NET SDK에 기본 제공되는 템플릿 패키지는 표시되지 않습니다.

템플릿 패키지 제거

dotnet new uninstall 명령을 사용하여 템플릿 패키지를 제거합니다.

NuGet 피드 또는 .nupkg 파일을 통해 패키지를 직접 설치한 경우 식별자를 제공합니다.

dotnet new uninstall <NUGET_PACKAGE_ID>

.template.config 폴더의 경로를 지정하여 패키지를 설치한 경우 해당 경로를 사용하여 패키지를 제거합니다. 명령에서 제공하는 dotnet new uninstall 출력에서 템플릿 패키지의 절대 경로를 볼 수 있습니다. 자세한 내용은 설치된 템플릿 목록 가져오기 섹션을 참조하세요 .

dotnet new uninstall <FILE_SYSTEM_DIRECTORY>

사용자 지정 템플릿을 사용하여 프로젝트 만들기

템플릿이 설치되면 미리 설치된 다른 템플릿과 마찬가지로 명령을 실행하여 dotnet new <TEMPLATE> 템플릿을 사용합니다. 명령에 대해 템플릿 설정에서 구성한 템플릿별 옵션을 포함하여 dotnet new 옵션을 지정할 수도 있습니다. 템플릿의 짧은 이름을 명령에 직접 제공합니다.

dotnet new <TEMPLATE>

참고하십시오

• dotnet new에 대한 사용자 지정 템플릿 만들기(자습서)
• dotnet/templating GitHub 리포지토리 Wiki
• 템플릿 샘플
• dotnet new에 대한 고유한 템플릿을 만드는 방법
• JSON 스키마 저장소에서의 스키마 template.json