Skip to content
Docs Try Aspire
Docs Try

RuntimeSpec Properties

Class Properties 12 members
Specifies the runtime execution configuration for a language.
CodeGenLanguage Section titled CodeGenLanguage string
Gets the code generation language identifier for the generateCode RPC.
public string CodeGenLanguage { get; init; }
DetectionPatterns Section titled DetectionPatterns string[]
Gets the file patterns used to detect this language (e.g., ["apphost.ts"]).
public string[] DetectionPatterns { get; init; }
DisplayName Section titled DisplayName string
Gets the display name for the language (e.g., "TypeScript (Node.js)").
public string DisplayName { get; init; }
Gets the command to execute the AppHost for run.
public CommandSpec Execute { get; init; }
ExtensionLaunchCapability Section titled ExtensionLaunchCapability nullable string?
Gets the extension capability required to launch this language via the VS Code extension. When set (e.g., "node"), the CLI will use the extension launcher if the extension reports this capability. When null, the CLI always uses the default process-based launcher.
public string? ExtensionLaunchCapability { get; init; }
Initialize Section titled Initialize nullable CommandSpec[]?
Gets the commands to initialize the project environment (e.g., create a virtual environment and install dependencies). Runs once during scaffolding. Null if no initialization is needed.
public CommandSpec[]? Initialize { get; init; }
Gets the command to install dependencies. Null if no dependencies to install.
public CommandSpec? InstallDependencies { get; init; }
Gets the language identifier (e.g., "TypeScript", "Python").
public string Language { get; init; }
MigrationFiles Section titled MigrationFiles nullable Dictionary<string, string>
Gets files that must exist in the project directory before execution. If a file in this dictionary is missing, the CLI will create it with the provided content. This supports upgrade scenarios where new runtime requirements are introduced.
public Dictionary<string, string>? MigrationFiles { get; init; }
PreExecute Section titled PreExecute nullable CommandSpec[]?
Gets the commands to run before executing or publishing the AppHost. Null if no pre-execution validation is needed. Watch-mode validation should be part of RuntimeSpec.WatchExecute when needed.
public CommandSpec[]? PreExecute { get; init; }
Gets the command to execute the AppHost for publish. Null to use Execute with args appended.
public CommandSpec? PublishExecute { get; init; }
Gets the command to execute the AppHost in watch mode. Null if watch mode not supported.
public CommandSpec? WatchExecute { get; init; }