installation_and_usage.md

Installation and Usage

Installation

The easiest way to include webpack and its plugins is through NPM and save it to your devDependencies:

npm install -D webpack ts-loader html-webpack-plugin eslint-webpack-plugin

Setup and Usage

The most common way to use webpack is through the CLI. By default, running the command executes webpack.config.js which is the configuration file for your webpack setup.

Bundle

The core concept of webpack is the bundle. A bundle is simply a collection of modules, where we define the boundaries for how they are separated. In this project, we have two bundles:

• app for our application-specific client-side logic
• vendor for third party libraries

In webpack, bundles are configured through entry points. Webpack goes through each entry point one by one. It maps out a dependency graph by going through each module's references. All the dependencies that it encounters are then packaged into that bundle.

Packages installed through NPM are referenced using CommonJS module resolution. In a JavaScript file, this would look like:

  const app = require('./src/index.ts');

or TypeScript/ES6 file:

  import { Component } from '@angular/core';

We will use those string values as the module names we pass to webpack.

Let's look at the entry points we have defined in our sample app:

{
  ...
  entry: {
    app: './src/index.ts',
    vendor: [
      '@angular/core',
      '@angular/compiler',
      '@angular/common',
      '@angular/http',
      '@angular/platform-browser',
      '@angular/platform-browser-dynamic',
      '@angular/router',
      'es6-shim',
      'reflect-metadata',
      'ng2-redux',
      'zone.js',
    ]
  }
  ...
}

The entry point for app, ./src/index.ts, is the base file of our Angular application. If we've defined the dependencies of each module correctly, those references should connect all the parts of our application from here. The entry point for vendor is a list of modules that we need for our application code to work correctly. Even if these files are referenced by some module in our app bundle, we want to separate these resources in a bundle just for third party code.

Output Configuration

In most cases we don't just want to configure how webpack generates bundles - we also want to configure how those bundles are output.

• Often, we will want to re-route where files are saved. For example into a bin or dist folder. This is because we want to optimize our builds for production.
• Webpack transforms the code when bundling our modules and outputting them. We want to have a way of connecting the code that's been generated by webpack and the code that we've written.
• Server routes can be configured in many different ways. We probably want some way of configuring webpack to take our server routing setup into consideration.

All of these configuration options are handled by the config's output property. Let's look at how we've set up our config to address these issues:

{
  ...
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: '[name].[hash].js',
    publicPath: "/",
    sourceMapFilename: '[name].[hash].js.map'
  }
  ...
}

Some options have words wrapped in square brackets. Webpack has the ability to parse parameters for these properties, with each property having a different set of parameters available for substitution. Here, we're using name (the name of the bundle) and hash (a hash value of the bundle's content).

To save bundled files in a different folder, we use the path property. Here, path tells webpack that all of the output files must be saved to path.resolve(__dirname, 'dist'). In our case, we save each bundle into a separate file. The name of this file is specified by the filename property.

Linking these bundled files and the files we've actually coded is done using what's known as source maps. There are different ways to configure source maps. What we want is to save these source maps in a separate file specified by the sourceMapFilename property. The way the server accesses the files might not directly follow the filesystem tree. For us, we want to use the files saved under dist as the root folder for our server. To let webpack know this, we've set the publicPath property to /.