C3D.Extensions.Aspire.Node 0.1.2

.NET 8.0

dotnet add package C3D.Extensions.Aspire.Node --version 0.1.2

NuGet\Install-Package C3D.Extensions.Aspire.Node -Version 0.1.2

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="C3D.Extensions.Aspire.Node" Version="0.1.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="C3D.Extensions.Aspire.Node" Version="0.1.2" />
                    

                            Directory.Packages.props

<PackageReference Include="C3D.Extensions.Aspire.Node" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add C3D.Extensions.Aspire.Node --version 0.1.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: C3D.Extensions.Aspire.Node, 0.1.2"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package C3D.Extensions.Aspire.Node@0.1.2

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=C3D.Extensions.Aspire.Node&version=0.1.2
                    

                            Install as a Cake Addin

#tool nuget:?package=C3D.Extensions.Aspire.Node&version=0.1.2
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

C3D.Extensions.Aspire.Node

A way to reference and execute an Node based project (.eproj) using Aspire. Connects to the instance of VisualStudio running the AprireHost and attaches the debugger to the Node instance so that the project can be debugged as normal. Adds a healthcheck to the Node resource to show whether the debugger has been attached. A future option would be to send the initial request to spin up the site once the debugger is attached.

Utilizes C3D.Extensions.Aspire.OutputWatcher under the hood to watch for debug connection strings in the output.

Example

var webapp = builder.AddNodeApp<Projects.ExpressProject>("webapp")
    .WithHttpEndpoint(env: "PORT")
    .WithOtlpExporter()
    .WithWatch()
    .WithDebugger()
    .WithHttpHealthCheck("/alive");

Methods

AddNodeApp<T> Adds a referenced project as a Node app. Uses the project directory to launch node.
WithWatch() Injects the --watch option in the node arguments
WithDebugger() Sets up the logic to attach the debugger using the V8 Inspection protocol and watch for the debugger connection string.

Known Issues

This doesn't work with npm at the moment, as the debugger options get confused between the npm runner and it's child processes.

Product	Compatible and additional computed target framework versions.
.NET	net8.0-windows7.0 is compatible. net9.0-windows was computed. net9.0-windows7.0 is compatible. net10.0-windows was computed. net10.0-windows7.0 is compatible.