angular-cn/public/docs/ts/latest/guide/webpack.jade

include ../_util-fns

// The docs standard h4 style uppercases, making code terms unreadable. Override it.
style.
  h4 {font-size: 17px !important; text-transform: none !important;}
  .syntax { font-family: Consolas, 'Lucida Sans', Courier, sans-serif; color: black; font-size: 85%; }

:marked
  [**Webpack**](https://webpack.github.io/) is a popular module bundler,
  a tool for bundling application source code in convenient _chunks_
  and for loading that code from a server into a browser.

  It's an excellent alternative to the *SystemJS* approach used elsewhere in the documentation.
  This guide offers a taste of Webpack and explains how to use it with Angular applications.

  <a id="top"></a>
  # Contents

  * [What is Webpack?](#what-is-webpack)

    * [Entries and outputs](#entries-outputs)
    * [Multiple bundles](#multiple-bundles)
    * [Loaders](#loaders)
    * [Plugins](#plugins)

  * [Configuring Webpack](#configure-webpack)

    * [Polyfills](#polyfills)
    * [Common configuration](#common-configuration)
    * [Inside `webpack.common.js`](#inside-webpack-commonjs)

      * [entry](#common-entries)
      * [resolve extension-less imports](#common-resolves)
      * [`module.rules`](#common-rules)
      * [Plugins](#plugins)
      * [`CommonsChunkPlugin`](#commons-chunk-plugin)
      * [`HtmlWebpackPlugin`](#html-webpack-plugin)

    * [Environment specific configuration](#environment-configuration)
    * [Development configuration](#development-configuration)
    * [Production configuration](#production-configuration)
    * [Test configuration](#test-configuration)
    
  * [Trying it out](#try)
  * [Highlights](#highlights)
  * [Conclusion](#conclusion)

  You can also <a href="/resources/zips/webpack/webpack.zip">download the final result.</a>

.l-main-section
<a id="what-is-webpack"></a>
:marked
  ## What is Webpack?

  Webpack is a powerful module bundler.
  A _bundle_ is a JavaScript file that incorporates _assets_ that *belong* together and
  should be served to the client in a response to a single file request.
  A bundle can include JavaScript, CSS styles, HTML, and almost any other kind of file.

  Webpack roams over your application source code,
  looking for `import` statements, building a dependency graph, and emitting one or more _bundles_.
  With plugins and rules, Webpack can preprocess and minify different non-JavaScript files such as TypeScript, SASS, and LESS files.

  You determine what Webpack does and how it does it with a JavaScript configuration file, `webpack.config.js`.

a(id="entries-outputs")
.l-main-section
:marked
  ### Entries and outputs

  You supply Webpack with one or more *entry* files and let it find and incorporate the dependencies that radiate from those entries.
  The one entry point file in this example is the application's root file, `src/main.ts`:

+makeExample('webpack/ts/config/webpack.common.js', 'one-entry', 'webpack.config.js (single entry)')(format=".")

:marked
  Webpack inspects that file and traverses its `import` dependencies recursively.

+makeExample('webpack/ts/src/app/app.component.ts', 'component', 'src/main.ts')(format=".")

:marked
  It sees that you're importing `@angular/core` so it adds that to its dependency list for potential inclusion in the bundle.
  It opens the `@angular/core` file and follows _its_ network of `import` statements until it has built the complete dependency graph from `main.ts` down.

  Then it **outputs** these files to the `app.js` _bundle file_ designated in configuration:

.code-example
  code-example(name="webpack.config.js (single output)" language="javascript").
    output: {
      filename: 'app.js'
    }

:marked
  This `app.js` output bundle is a single JavaScript file that contains the application source and its dependencies.
  You'll load it later with a `<script>` tag in the `index.html`.

a#multiple-bundles
:marked
  #### Multiple bundles
  You probably don't want one giant bundle of everything.
  It's preferable to separate the volatile application app code from comparatively stable vendor code modules.

  Change the configuration so that it has two entry points, `main.ts` and `vendor.ts`:

.code-example
  code-example(language="javascript").
    entry: {
      app: 'src/app.ts',
      vendor: 'src/vendor.ts'
    },

    output: {
      filename: '[name].js'
    }

:marked
  Webpack constructs two separate dependency graphs
  and emits *two* bundle files, one called `app.js` containing only the application code and
  another called `vendor.js` with all the vendor dependencies.

.l-sub-section
  :marked
    The `[name]` in the output name is a *placeholder* that a Webpack plugin replaces with the entry names,
    `app` and `vendor`. Plugins are [covered later](#commons-chunk-plugin) in the guide.

:marked
  To tell Webpack what belongs in the vendor bundle,
  add a `vendor.ts` file that only imports the application's third-party modules:
+makeExample('webpack/ts/src/vendor.ts', null,'src/vendor.ts')(format=".")


a(id="loaders")
.l-main-section
:marked
  ### Loaders

  Webpack can bundle any kind of file: JavaScript, TypeScript, CSS, SASS, LESS, images, HTML, fonts, whatever.
  Webpack _itself_ only understands JavaScript files.
  Teach it to transform non-JavaScript file into their JavaScript equivalents with *loaders*.
  Configure loaders for TypeScript and CSS as follows.

.code-example
  code-example(language="javascript").
    rules: [
      {
        test: /\.ts$/,
        loader: 'awesome-typescript-loader'
      },
      {
        test: /\.css$/,
        loaders: 'style-loader!css-loader'
      }
    ]

:marked
  When Webpack encounters `import` statements like the following, 
  it applies the `test` RegEx patterns. 

.code-example
  code-example(language="typescript").
    import { AppComponent } from './app.component.ts';

    import 'uiframework/dist/uiframework.css';

:marked
  When a pattern matches the filename, Webpack processes the file with the associated loader.

  The first `import` file matches the `.ts` pattern so Webpack processes it with the `awesome-typescript-loader`.
  The imported file doesn't match the second pattern so its loader is ignored.

  The second `import` matches the second `.css` pattern for which you have *two* loaders chained by the (!) character.
  Webpack applies chained loaders *right to left*. So it applies
  the `css` loader first to flatten CSS `@import` and `url(...)` statements. 
  Then it applies the `style` loader to append the css inside `<style>` elements on the page.

a(id="plugins")
.l-main-section
:marked
  ### Plugins

  Webpack has a build pipeline with well-defined phases.
  Tap into that pipeline with plugins such as the `uglify` minification plugin:

.code-example
  code-example(language="javascript").
    plugins: [
      new webpack.optimize.UglifyJsPlugin()
    ]

a(id="configure-webpack")
.l-main-section
:marked
  ## Configuring Webpack

  After that brief orientation, you are ready to build your own Webpack configuration for Angular apps.

  Begin by setting up the development environment.

  Create a new project folder.
code-example(language="sh" class="code-shell").
  mkdir angular-webpack
  cd    angular-webpack

:marked
  Add these files:

+makeTabs(
  `webpack/ts/package.webpack.json,
  webpack/ts/src/tsconfig.1.json,
  webpack/ts/webpack.config.js,
  webpack/ts/karma.webpack.conf.js,
  webpack/ts/config/helpers.js`,
  null,
  `package.json,
  src/tsconfig.json,
  webpack.config.js,
  karma.conf.js,
  config/helpers.js`
)
.l-sub-section
  :marked
    Many of these files should be familiar from other Angular documentation guides,
    especially the [Typescript configuration](../guide/typescript-configuration.html) and
    [npm packages](../guide/npm-packages.html) guides.

    Webpack, the plugins, and the loaders are also installed as packages.
    They are listed in the updated `packages.json`.

:marked
  Open a terminal window and install the npm packages.
code-example(language="sh" class="code-shell").
  npm install

a#polyfills
.l-main-section
:marked
  ### Polyfills

  You'll need polyfills to run an Angular application in most browsers as explained
  in the [Browser Support](browser-support.html) guide.

  Polyfills should be bundled separately from the application and vendor bundles.
  Add a `polyfills.ts` like this one to the `src/` folder.

+makeExample('webpack/ts/src/polyfills.ts', '', 'src/polyfills.ts')(format=".")

.callout.is-critical
  header Loading polyfills
  :marked
    Load `zone.js` early within `polyfills.ts`, immediately after the other ES6 and metadata shims.

:marked
  Because this bundle file will load first, `polyfills.ts` is also a good place to configure the browser environment
  for production or development.

a(id="common-configuration")
.l-main-section
:marked
  ### Common configuration

  Developers typically have separate configurations for development, production, and test environments.
  All three have a lot of configuration in common.

  Gather the common configuration in a file called `webpack.common.js`.

+makeExample('webpack/ts/config/webpack.common.js', null, 'config/webpack.common.js')(format=".")

a#inside-webpack-commonjs
:marked
  ### Inside _webpack.common.js_
  Webpack is a NodeJS-based tool that reads configuration from a JavaScript commonjs module file.

  The configuration imports dependencies with `require` statements
  and exports several objects as properties of a `module.exports` object.

  * [`entry`](#common-entries)&mdash;the entry-point files that define the bundles.
  * [`resolve`](#common-resolve)&mdash;how to resolve file names when they lack extensions.
  * [`module.rules`](#common-rules)&mdash; `module` is an object with `rules` for deciding how files are loaded.
  * [`plugins`](#common-plugins)&mdash;creates instances of the plugins.

a#common-entries
:marked
  #### _entry_

  The first export is the `entry` object:

+makeExample('webpack/ts/config/webpack.common.js', 'entries', 'config/webpack.common.js')(format=".")
:marked
  This `entry` object defines the three bundles:

  * `polyfills`&mdash;the polyfills needed to run Angular applications in most modern browsers.
  * `vendor`&mdash;the third-party dependencies such as Angular, lodash, and bootstrap.css.
  * `app`&mdash;the application code.

a#common-resolve
:marked
  #### _resolve_ extension-less imports

  The app will `import` dozens if not hundreds of JavaScript and TypeScript files.
  You could write `import` statements with explicit extensions like this example:

.code-example
  code-example(language="typescript").
    import { AppComponent } from './app.component.ts';

:marked
  But most `import` statements don't mention the extension at all.
  Tell Webpack to resolve extension-less file requests by looking for matching files with
  `.ts` extension or `.js` extension (for regular JavaScript files and pre-compiled TypeScript files).

+makeExample('webpack/ts/config/webpack.common.js', 'resolve', 'config/webpack.common.js')(format=".")
.l-sub-section
  :marked
    If Webpack should resolve extension-less files for styles and HTML,
    add `.css` and `.html` to the list.

a#common-rules
:marked
:marked
  #### _module.rules_
  Rules tell Webpack which loaders to use for each file, or module:

+makeExample('webpack/ts/config/webpack.common.js', 'loaders', 'config/webpack.common.js')(format=".")

:marked
  * `awesome-typescript-loader`&mdash;a loader to transpile the Typescript code to ES5, guided by the `tsconfig.json` file.
  * `angular2-template-loader`&mdash;loads angular components' template and styles.
  * `html-loader`&mdash;for component templates.
  * images/fonts&mdash;Images and fonts are bundled as well.
  * CSS&mdash;the first pattern matches application-wide styles; the second handles 
  component-scoped styles (the ones specified in a component's `styleUrls` metadata property).
.l-sub-section
  :marked
    The first pattern is for the application-wide styles. It excludes `.css` files within the `src/app` directory
    where the component-scoped styles sit. The `ExtractTextPlugin` (described below) applies the `style` and `css`
    loaders to these files.

    The second pattern filters for component-scoped styles and loads them as strings via the `raw-loader`,
    which is what Angular expects to do with styles specified in a `styleUrls` metadata property.

.l-sub-section
  :marked
    Multiple loaders can be chained using the array notation.

a#common-plugins
:marked
:marked
  #### _plugins_
  Finally, create instances of three plugins:

+makeExample('webpack/ts/config/webpack.common.js', 'plugins', 'config/webpack.common.js')(format=".")

a(id="commons-chunk-plugin")
:marked
  #### *CommonsChunkPlugin*

  The `app.js` bundle should contain only application code. All vendor code belongs in the `vendor.js` bundle.

  Of course the application code imports vendor code.
  On its own, Webpack is not smart enough to keep the vendor code out of the `app.js` bundle.
  The `CommonsChunkPlugin` does that job.
.l-sub-section
  :marked
    The `CommonsChunkPlugin` identifies the hierarchy among three _chunks_: `app` -> `vendor` -> `polyfills`.
    Where Webpack finds that `app` has shared dependencies with `vendor`, it removes them from `app`.
    It would remove `polyfills` from `vendor` if they shared dependencies, which they don't.

a(id="html-webpack-plugin")
:marked
  #### _HtmlWebpackPlugin_

  Webpack generates a number of js and CSS files.
  You _could_ insert them into the `index.html` _manually_. That would be tedious and error-prone.
  Webpack can inject those scripts and links for you with the `HtmlWebpackPlugin`.

a(id="environment-configuration")
.l-main-section
:marked
  ### Environment-specific configuration

  The `webpack.common.js` configuration file does most of the heavy lifting.
  Create separate, environment-specific configuration files that build on `webpack.common`
  by merging into it the peculiarities particular to the target environments.

  These files tend to be short and simple.

a(id="development-configuration")
.l-main-section
:marked
  ### Development configuration

  Here is the `webpack.dev.js` development configuration file.

+makeExample('webpack/ts/config/webpack.dev.js', null, 'config/webpack.dev.js')(format=".")

:marked
  The development build relies on the Webpack development server, configured near the bottom of the file.

  Although you tell Webpack to put output bundles in the `dist` folder,
  the dev server keeps all bundles in memory; it doesn't write them to disk.
  You won't find any files in the `dist` folder, at least not any generated from *this development build*.


  The `HtmlWebpackPlugin`, added in `webpack.common.js`, uses the `publicPath` and the `filename` settings to generate
  appropriate `<script>` and `<link>` tags into the `index.html`.

  The CSS styles are buried inside the Javascript bundles by default. The `ExtractTextPlugin` extracts them into
  external `.css` files that the `HtmlWebpackPlugin` inscribes as `<link>` tags into the `index.html`.

  Refer to the [Webpack documentation](https://webpack.github.io/docs/) for details on these and 
  other configuration options in this file.

  Grab the app code at the end of this guide and try:

code-example(language="sh" class="code-shell").
  npm start

a(id="production-configuration")
.l-main-section
:marked
  ### Production configuration

  Configuration of a *production* build resembles *development* configuration with a few key changes.

+makeExample('webpack/ts/config/webpack.prod.js', null, 'config/webpack.prod.js')(format=".")

:marked
  You'll deploy the application and its dependencies to a real production server.
  You won't deploy the artifacts needed only in development.

  Put the production output bundle files in the `dist` folder.

  Webpack generates file names with cache-busting hash.
  Thanks to the `HtmlWebpackPlugin`, you don't have to update the `index.html` file when the hash changes.

  There are additional plugins:

  * *`NoEmitOnErrorsPlugin`&mdash;stops the build if there is an error.
  * *`UglifyJsPlugin`&mdash;minifies the bundles.
  * *`ExtractTextPlugin`&mdash;extracts embedded css as external files, adding cache-busting hash to the filename.
  * *`DefinePlugin`&mdash;use to define environment variables that you can reference within the application.
  * *`LoaderOptionsPlugins`&mdash;to override options of certain loaders.

  Thanks to the `DefinePlugin` and the `ENV` variable defined at top, you can enable Angular production mode like this:

+makeExample('webpack/ts/src/main.ts', 'enable-prod')(format=".")

:marked
  Grab the app code at the end of this guide and try:

code-example(language="sh" class="code-shell").
  npm run build

a(id="test-configuration")
.l-main-section
:marked
  ### Test configuration

  You don't need much configuration to run unit tests.
  You don't need the loaders and plugins that you declared for your development and production builds.
  You probably don't need to load and process the application-wide styles files for unit tests and doing so would slow you down;
  you'll use the `null` loader for those CSS files.

  You could merge the test configuration into the `webpack.common` configuration and override the parts you don't want or need.
  But it might be simpler to start over with a completely fresh configuration.

+makeExample('webpack/ts/config/webpack.test.js', null, 'config/webpack.test.js')(format=".")

:marked
  Reconfigure [Karma](https://karma-runner.github.io/1.0/index.html) to use Webpack to run the tests:

+makeExample('webpack/ts/config/karma.conf.js', null, 'config/karma.conf.js')(format=".")

:marked
  You don't precompile the TypeScript; Webpack transpiles the Typescript files on the fly, in memory, and feeds the emitted JS directly to Karma.
  There are no temporary files on disk.

  The `karma-test-shim` tells Karma what files to pre-load and
  primes the Angular test framework with test versions of the providers that every app expects to be pre-loaded.

+makeExample('webpack/ts/config/karma-test-shim.js', null, 'config/karma-test-shim.js')(format=".")

:marked
  Notice that you do _not_ load the application code explicitly.
  You tell Webpack to find and load the test files (the files ending in `.spec.ts`).
  Each spec file imports all&mdash;and only&mdash;the application source code that it tests.
  Webpack loads just _those_ specific application files and ignores the other files that you aren't testing.

:marked
  Grab the app code at the end of this guide and try:

code-example(language="sh" class="code-shell").
  npm test

<a id="try"></a>
:marked
  ## Trying it out

  Here is the source code for a small application that bundles with the
  Webpack techniques covered in this guide.

+makeTabs(
  `webpack/ts/src/index.html,
  webpack/ts/src/main.ts,
  webpack/ts/src/assets/css/styles.css`,
  null,
  `src/index.html,
  src/main.ts,
  src/assets/css/styles.css`
)

+makeTabs(
  `webpack/ts/src/app/app.component.ts,
  webpack/ts/src/app/app.component.html,
  webpack/ts/src/app/app.component.css,
  webpack/ts/src/app/app.component.spec.ts,
  webpack/ts/src/app/app.module.ts`,
  null,
  `src/app/app.component.ts,
  src/app/app.component.html,
  src/app/app.component.css,
  src/app/app.component.spec.ts,
  src/app/app.module.ts`
)


:marked
  The <code>app.component.html</code> displays this downloadable Angular logo
  <a href="https://raw.githubusercontent.com/angular/angular.io/master/public/resources/images/logos/angular/angular.png" target="_blank">
  <img src="/resources/images/logos/angular/angular.png" height="40px" title="download Angular logo"></a>.
  Create a folder called `images` under the project's `assets` folder, then right-click (Cmd+click on Mac) 
  on the image and download it to that folder.

a#bundle-ts
:marked
  Here again are the TypeScript entry-point files that define the `polyfills` and `vendor` bundles.
+makeTabs(
  `webpack/ts/src/polyfills.ts,
   webpack/ts/src/vendor.ts`,
  null,
  `src/polyfills.ts,
   src/vendor.ts`
)
<a id="highlights"></a>
:marked
  ### Highlights

  * There are no `<script>` or `<link>` tags in the `index.html`.
  The `HtmlWebpackPlugin` inserts them dynamically at runtime.

  * The `AppComponent` in `app.component.ts` imports the application-wide css with a simple `import` statement.

  * The `AppComponent` itself has its own html template and css file. WebPack loads them with calls to `require()`.
  Webpack stashes those component-scoped files in the `app.js` bundle too.
  You don't see those calls in the source code;
  they're added behind the scenes by the `angular2-template-loader` plug-in.

  * The `vendor.ts` consists of vendor dependency `import` statements that drive the `vendor.js` bundle.
  The application imports these modules too; they'd be duplicated in the `app.js` bundle
  if the `CommonsChunkPlugin` hadn't detected the overlap and removed them from `app.js`.

<a id="conclusion"></a>
:marked
  ## Conclusion

  You've learned just enough Webpack to configurate development, test and production builds
  for a small Angular application.

  _You could always do more_. Search the web for expert advice and expand your Webpack knowledge.

  [Back to top](#top)