MintPlayer.AspNetCore.NodeServices 10.3.0

MintPlayer.AspNetCore.NodeServices

This package provides Node.js integration for ASP.NET Core applications, enabling server-side execution of JavaScript code. It is a core dependency for SPA prerendering functionality.

Installation

NuGet Package Manager

Install-Package MintPlayer.AspNetCore.NodeServices

.NET CLI

dotnet add package MintPlayer.AspNetCore.NodeServices

MSBuild Integration

This package automatically configures your project with MSBuild props and targets for SPA development. These are applied transitively to all projects that reference this package.

Properties

The following MSBuild properties are automatically configured (can be overridden in your .csproj):

Build Targets

File Exclusions

The package automatically configures your project to:

• Exclude SPA source files from compilation
• Exclude node_modules from the project
• Show SPA files in Solution Explorer without including them in build output

Disabling SPA Builder

If your project references this package (directly or transitively) but doesn't have a SPA, you can disable all build automation:

<PropertyGroup>
  <EnableSpaBuilder>false</EnableSpaBuilder>
</PropertyGroup>

This will:

• Skip the DebugEnsureNodeEnv target
• Skip the PublishRunWebpack target
• Skip SPA file exclusion rules

Customizing SPA Root

If your SPA is in a different folder than ClientApp, override the SpaRoot property:

<PropertyGroup>
  <SpaRoot>src\frontend\</SpaRoot>
</PropertyGroup>

Client-Only Builds

To build only the client bundle (without SSR) during publish:

<PropertyGroup>
  <BuildServerSideRenderer>false</BuildServerSideRenderer>
</PropertyGroup>

SPA Build Caching

By default, this package caches SPA builds to avoid unnecessary rebuilds. It computes a hash of your SPA folder contents and only runs npm run build when the hash changes.

How It Works

1. Before each publish, the package computes a SHA-256 hash of your ClientApp folder
2. The hash is compared against the previously stored hash (in obj/spa-folder.hash)
3. If the hash is unchanged and dist/ exists, the build is skipped
4. If the hash changed or it's the first build, npm run build is executed

Build Command Selection

The build command is selected based on the BuildServerSideRenderer property:

Default Ignore Patterns

By default, a .hasherignore file is automatically created in your ClientApp folder (if it doesn't exist) with these patterns:

This ensures that large folders like node_modules and transient files don't slow down hash computation or cause unnecessary rebuilds.

Customizing .hasherignore

You can customize the .hasherignore file to add or remove patterns. The syntax is similar to .gitignore:

# Build outputs (don't trigger rebuild when these change)
dist/
dist-server/
.angular/

# Dependencies
node_modules/

# IDE files
.idea/
.vscode/

# Test artifacts
coverage/

To prevent automatic creation of .hasherignore:

<PropertyGroup>
  <CreateDefaultHasherIgnore>false</CreateDefaultHasherIgnore>
</PropertyGroup>

To customize the default patterns (before the file is created):

<ItemGroup>
  <SpaHashDefaultIgnorePattern Include="my-custom-folder/" />
</ItemGroup>

Disabling Build Caching

To disable build caching and always rebuild:

<PropertyGroup>
  <EnableSpaBuildCaching>false</EnableSpaBuildCaching>
</PropertyGroup>

Forcing a Rebuild

To force a rebuild even when the hash hasn't changed:

<PropertyGroup>
  <ForceSpaBuild>true</ForceSpaBuild>
</PropertyGroup>

Or use the command line:

dotnet publish -p:ForceSpaBuild=true

Related Packages

• MintPlayer.AspNetCore.SpaServices - Core SPA services
• MintPlayer.AspNetCore.SpaServices.Prerendering - Prerendering support
• MintPlayer.AspNetCore.SpaServices.Routing - SPA route integration

License

This project is licensed under the Apache 2.0 License.