SdkTemplateHost

Definition

Assembly: CloudNimble.EasyAF.Tools.dll Namespace: CloudNimble.EasyAF.Tools.Scaffolding Inheritance: System.Object

Syntax

CloudNimble.EasyAF.Tools.Scaffolding.SdkTemplateHost

Summary

Instantiates the .NET SDK’s built-in C# project templates (classlib, web, console) in-process through Microsoft.TemplateEngine, without spawning dotnet new.

Remarks

Template packages are discovered the same way the SDK’s own BuiltInTemplatePackageProvider finds them: {dotnetRoot}/templates/{version}/*.nupkg, where {version} is the highest folder whose major version matches the requested target framework. Template post-actions (such as restore) are not executed.

Constructors

.ctor

Initializes a new instance of the SdkTemplateHost class.

Syntax

public SdkTemplateHost(string templatesRoot, string targetFramework)

Parameters

Name	Type	Description
`templatesRoot`	`string`	The folder containing versioned template package folders.
`targetFramework`	`string`	The target framework moniker projects will be created for.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

SdkVersion

Gets the version of the SDK that supplied the templates in SdkTemplateHost.TemplateFolder (for example, 10.0.401), or null when it can’t be determined.

Syntax

public string SdkVersion { get; }

Property Value

Type: string

Remarks

The SDK installs its common project templates as microsoft.dotnet.common.projecttemplates.{Major}.{Minor}.{SdkVersion}.nupkg, so the version is read from that package name.

TargetFramework

Gets the target framework moniker projects are created for (for example, net10.0).

Syntax

public string TargetFramework { get; }

Property Value

Type: string

TemplateFolder

Gets the resolved template version folder (for example, C:\Program Files\dotnet\templates\10.0.12), or null when SdkTemplateHost.TemplatesRoot has no folder for the target framework’s major version.

Syntax

public string TemplateFolder { get; }

Property Value

Type: string

TemplatesRoot

Gets the folder containing versioned template package folders (normally {dotnetRoot}/templates).

Syntax

public string TemplatesRoot { get; }

Property Value

Type: string

Methods

CreateProjectAsync

Creates a project from an SDK template.

Syntax

public System.Threading.Tasks.Task<string> CreateProjectAsync(string shortName, string projectName, string outputDirectory, bool overwrite = false, System.Threading.CancellationToken cancellationToken = null)

Parameters

Name	Type	Description
`shortName`	`string`	The template short name: `classlib`, `web`, or `console`.
`projectName`	`string`	The project name, which becomes the .csproj file name and default namespace.
`outputDirectory`	`string`	The directory the project is written to. It must not exist or must be empty unless overwrite is set.
`overwrite`	`bool`	When `true`, files already in outputDirectory may be replaced. The caller is expected to have asked the user first.
`cancellationToken`	`System.Threading.CancellationToken`	A token to cancel the operation.

Returns

Type: System.Threading.Tasks.Task<string> The full path of the created .csproj file.

Exceptions

Exception	Description
`TemplateNotFoundException`	Thrown when no matching C# project template exists on the machine.
`InvalidOperationException`	Thrown when outputDirectory already contains files and overwrite is `false`, or when the template engine reports a failure.

Dispose

Syntax

public void Dispose()

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

FindDotnetRoot

Finds the .NET installation root that owns the dotnet host, checking DOTNET_ROOT, then DOTNET_HOST_PATH, then dotnet on the PATH.

Syntax

public static string FindDotnetRoot()

Returns

Type: string The .NET installation root.

Exceptions

Exception	Description
`DirectoryNotFoundException`	Thrown when no installation root can be found.

FindTemplatesRoot

Finds the templates folder of the .NET installation returned by SdkTemplateHost.FindDotnetRoot.

Syntax

public static string FindTemplatesRoot()

Returns

Type: string The full path of the templates folder.

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetMajorVersion

Gets the major version of a target framework moniker (for example, 10 for net10.0).

Syntax

public static int GetMajorVersion(string targetFramework)

Parameters

Name	Type	Description
`targetFramework`	`string`	The target framework moniker.

Returns

Type: int The major version.

Exceptions

Exception	Description
`ArgumentException`	Thrown when the moniker is not in the form `netX.Y`.

GetMissingTemplatesAsync

Finds which of the given C# project templates are not available, so a caller can fail before creating anything.

Syntax

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>> GetMissingTemplatesAsync(System.Collections.Generic.IEnumerable<string> shortNames, System.Threading.CancellationToken cancellationToken = null)

Parameters

Name	Type	Description
`shortNames`	`System.Collections.Generic.IEnumerable<string>`	The template short names to look for, such as `classlib`, `web`, and `console`.
`cancellationToken`	`System.Threading.CancellationToken`	A token to cancel the operation.

Returns

Type: System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>> The short names with no matching C# project template, in the order given. Empty when all are available.

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

System.IDisposable

​Definition

​Syntax

​Summary

​Remarks

​Constructors

​ .ctor

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​Properties

​ SdkVersion

​Syntax

​Property Value

​Remarks

​ TargetFramework

​Syntax

​Property Value

​ TemplateFolder

​Syntax

​Property Value

​ TemplatesRoot

​Syntax

​Property Value

​Methods

​ CreateProjectAsync

​Syntax

​Parameters

​Returns

​Exceptions

​ Dispose

​Syntax

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ FindDotnetRoot

​Syntax

​Returns

​Exceptions

​ FindTemplatesRoot

​Syntax

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetMajorVersion

​Syntax

​Parameters

​Returns

​Exceptions

​ GetMissingTemplatesAsync

​Syntax

​Parameters

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

​Related APIs

Definition

Syntax

Summary

Remarks

Constructors

.ctor

Syntax

Parameters

.ctor Inherited

Syntax

Properties

SdkVersion

Syntax

Property Value

Remarks

TargetFramework

Syntax

Property Value

TemplateFolder

Syntax

Property Value

TemplatesRoot

Syntax

Property Value

Methods

CreateProjectAsync

Syntax

Parameters

Returns

Exceptions

Dispose

Syntax

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

FindDotnetRoot

Syntax

Returns

Exceptions

FindTemplatesRoot

Syntax

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetMajorVersion

Syntax

Parameters

Returns

Exceptions

GetMissingTemplatesAsync

Syntax

Parameters

Returns

GetType Inherited

Syntax

Returns

MemberwiseClone Inherited

Syntax

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns

Related APIs