Class BackendNeutralProjectScaffolder

Namespace

S1Interop.Core.Scaffolding

Assembly

S1Interop.Core.dll

Creates the same backend-neutral starter project structure used by the CLI.

BackendNeutralProjectScaffolder

BackendNeutralProjectScaffolder backs s1interop new.

Use CreatePlan to inspect the files that would be created, then Apply to write the solution, project file, local path example, starter source, and README for a backend-neutral mod project.

public sealed class BackendNeutralProjectScaffolder

Inheritance

object

BackendNeutralProjectScaffolder

Methods

Apply(NewProjectPlan)

Writes the files described by a backend-neutral project plan.

public void Apply(NewProjectPlan plan)

Parameters

plan NewProjectPlan

The project plan to write to disk.

Remarks

Existing files at the planned paths are overwritten. Call CreatePlan(string) first when callers need to review paths before writing.

CreatePlan(string)

Builds a file plan for a new backend-neutral Schedule One mod project.

public NewProjectPlan CreatePlan(string targetDirectory)

Parameters

targetDirectory string

The directory that should contain the generated project.

Returns

NewProjectPlan

The planned project paths and generated project name.

Exceptions

ArgumentException

Thrown when a valid project name cannot be inferred from targetDirectory.