Webpack Aspnet Middleware

Development file-server and hot-reload middleware for ASP.NET applications built with Webpack

Overview

WebpackAspnetMiddleware is an ASP.NET clone of the popular webpack-dev-middleware and webpack-hot-middleware NodeJS packages. It come in 3 parts: The WebpackService, the DevServer middleware and the HotReload middleware.

The WebpackService starts NodeJS using the JavaScriptServices package, and communicates with webpack using an accompanying npm package webpack-aspnet-middleware. This package sets up a two-way asynchronous communication channel which enables the WebpackService to send commands directly to webpack and receive notifications when new files are emitted.

The DevServer middleware serves up all the files produced by the webpack instance, and the HotReload middleware notifies the client when files change. In the browser the webpack-hot-middleware client library is used with no changes.

Instructions

1. Add the Redouble.AspNet.Webpack NuGet package to your project dependencies:

  <ItemGroup>
    <PackageReference Include="Microsoft.AspNetCore.App" Version="2.1.1" />
    <PackageReference Include="Redouble.AspNet.Webpack" Version="3.0.0" />
    ...

2. Install the webpack-aspnet-middleware NodeJS package:

  npm install webpack-aspnet-middleware --save-dev

3. Add the necessary services and middleware to your ASP.NET startup module:

  public void ConfigureServices(IServiceCollection services)
  {    
     /* these are the default values */   
     services.AddWebpack(
        configFile: "webpack.config.js",      // relative to project directory
        publicPath: "/webpack/",              // should match output.publicPath in your webpack config
        webRoot: "./wwwroot",                 // relative to project directory
        logLevel: WebpackLogLevel.Normal,     // None, ErrorsOnly, Minimal, Normal or Verbose
        envParam: null                        // the 'env' param passed to webpack.config.js,
                                              // if not set the current environment name is passed
     );       
  }

  public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
  {
     app.UseWebpackDevServer();               // necessary
     app.UseWebpackHotReload();               // optional

     app.UseStaticFiles();
     app.UseMvc(routes => routes.MapRoute(name: "default", template: "{controller=Home}/{action=Index}/{id?}"));
  }

4. Optional: configure hot-reloading in your webpack configuration file:

   a) Ensure Webpack mode is set to 'development' and add the hot reloading plugin:

     mode: 'development',
     plugins: [
        new webpack.HotModuleReplacementPlugin()
     ]

   b) Add the hot reloading client to the entry array:

     entry: [ 'webpack-aspnet-middleware/client', './index' ],

5. Start ASP.NET:

  $ dotnet run

Example

git clone https://github.com/frankwallis/WebpackAspnetMiddleware
cd WebpackAspnetMiddleware/Calculator
npm install
dotnet restore
dotnet run

Open up localhost:5000 in your browser and then try editing Calculator/Scripts/calculator.tsx.

Troubleshooting

First verify that webpack works when run from the command line.