Compiler Warning ASPIRETERMINAL001
Terminal types and members are for evaluation purposes only and are subject to change or removal in future updates. Suppress this diagnostic to proceed.
This diagnostic warning is reported when using experimental terminal APIs in Aspire, including AppHost-owned terminals, terminal interactions, and terminal automation. These include TerminalService, AspireTerminal, TerminalLaunchOptions, TerminalPlacement, TerminalOwner, AspireTerminalKey, PromptTerminalAsync, TerminalInteractionOptions, and TerminalContext.
Starting with Aspire 17.0, WithTerminalwithTerminalWithTerminal and TerminalOptions are no longer experimental and don’t report this diagnostic.
Example
Section titled “Example”The following code generates ASPIRETERMINAL001:
var builder = DistributedApplication.CreateBuilder(args);
var options = new TerminalLaunchOptions{ Title = "Local shell", Executable = "/bin/sh"};
builder.Build().Run();To correct this warning
Section titled “To correct this warning”Suppress the warning with one of the following methods:
-
Set the severity of the rule in the .editorconfig file.
.editorconfig [*.{cs,vb}]dotnet_diagnostic.ASPIRETERMINAL001.severity = noneFor more information about editor config files, see Configuration files for code analysis rules.
-
Add the following
PropertyGroupto your project file:C# project file <PropertyGroup><NoWarn>$(NoWarn);ASPIRETERMINAL001</NoWarn></PropertyGroup> -
Suppress in code with the
#pragma warning disable ASPIRETERMINAL001directive:Suppressing the warning #pragma warning disable ASPIRETERMINAL001builder.AddContainer("cache", "redis").WithTerminal();#pragma warning restore ASPIRETERMINAL001
See also
Section titled “See also”- Attach a terminal to a resource - Learn about
WithTerminal - Create AppHost-owned terminals
- Terminal interactions
- Dashboard terminal experiences