@sifawm/custom-webpack NPM

Custom webpack builders for Angular build facade

Allow customizing build configuration without ejecting webpack configuration (ng eject)

Prerequisites:

Angular CLI 6
@angular-devkit/build-angular >= 0.10.0

Usage

npm i -D @angular-builders/custom-webpack

In your angular.json:

"projects": {
    ...
    "[project]": {
         ...
         "architect": {
                ...
                "[architect-target]": {
                          "builder": "@angular-builders/custom-webpack:[browser|server|karma]"
                          "options": {
                                ...
                          }

Where:

project is the name of the project to which you want to add the builder
architect-target is the name of build target you want to run (build, serve, test etc. or any custom target)
browser|server|karma one of the supported builders - browser, server or karma

If [architect-target] is not one of the predefined targets (like build, serve, test etc.) then run it like this:
ng run [project]:[architect-target]
If it is one of the predefined targets, you can run it with ng [architect-target]
For example

angular.json:

"projects": {
    ...
    "example-app": {
         ...
         "architect": {
                ...
                "build": {
                          "builder": "@angular-builders/custom-webpack:browser"
                          "options": {
                                ...
                          }

Run the build: ng build

Builders

Custom webpack browser

Extended @angular-devkit/build-angular:browser builder that allows to specify additional webpack configuration (on top of the existing under the hood). The builder will run the same build as @angular-devkit/build-angular:browser does with extra parameters that are specified in the provided webpack configuration.

Builder options:

All the @angular-devkit/build-angular:browser options
customWebpackConfig: see below

angular.json Example:

"architect": {
    ...
    "build": {
              "builder": "@angular-builders/custom-webpack:browser"
              "options": {
                     "customWebpackConfig": {
                        "path": "./extra-webpack.config.js",
                        "mergeStrategies": { "externals": "prepend" }
                     }
                     "outputPath": "dist/my-cool-client",
                     "index": "src/index.html",
                     "main": "src/main.ts",
                     "polyfills": "src/polyfills.ts",
                     "tsConfig": "src/tsconfig.app.json"
              }

In this example externals entry from extra-webpack.config.js will be prepended to externals entry from Angular CLI underlying webpack config.

Custom webpack server

Extended @angular-devkit/build-angular:server builder that allows to specify additional webpack configuration (on top of the existing under the hood). The builder will run the same build as @angular-devkit/build-angular:server does with extra parameters that are specified in the provided webpack configuration.

Builder options:

All the @angular-devkit/build-angular:server options
customWebpackConfig: see below

angular.json Example:

"architect": {
    ...
    "build": {
              "builder": "@angular-builders/custom-webpack:server"
              "options": {
                     "customWebpackConfig": {
                        "path": "./extra-webpack.config.js",
                        "mergeStrategies": { "loaders": "replace" },
                        "replaceDuplicatePlugins": true
                     }
                    "outputPath": "dist/my-cool-server",
                    "main": "src/main.server.ts",
                    "tsConfig": "src/tsconfig.server.json"
              }

Custom webpack Karma

Extended @angular-devkit/build-angular:karma builder that allows to specify additional webpack configuration (on top of the existing under the hood). The builder will run the same build as @angular-devkit/build-angular:karma does with extra parameters that are specified in the provided webpack configuration.

Builder options:

All the @angular-devkit/build-angular:karma options
customWebpackConfig: see below

angular.json Example:

"architect": {
    ...
    "test": {
              "builder": "@angular-builders/custom-webpack:karma"
              "options": {
                     "customWebpackConfig": {
                        "path": "./extra-webpack.config.js"
                     }
                    "main": "src/test.ts",
                    "polyfills": "src/polyfills.ts",
                    "tsConfig": "src/tsconfig.spec.json",
                    "karmaConfig": "src/karma.conf.js",
                    ...
              }

Custom webpack config object

This object defines your custom webpack configuration. It is defined by the following properties:

path: path to the extra webpack configuration, defaults to webpack.config.js. Notice that this configuration shall contain only modifications and additions, you don't have to specify the whole webpack configuration.
Thus, if you'd like to add some options to style-loader (which already there because of default Angular configuration), you only have to specify this part of the loader:
```
 {
   test: /\.css$/,
   use: [
     {loader: 'style-loader', options: {...}}
   ]
 }
```
The builder will take care of merging the delta with the existing configuration provided by Angular.
mergeStrategies: webpack config merge strategies, can be append | prepend | replace per webpack config entry. Defaults to append.
- append: appends the given entry configuration (in custom webpack config) to the existing Angular CLI webpack configuration.
- prepend: prepends the given entry configuration (in custom webpack config) to the existing field configuration (in Angular CLI webpack config). The custom loaders config will be added to the beginning of the existing loaders array.
- replace: replaces the given entry configuration entirely. The custom webpack config will replace the Angular CLI webpack config (for this particular entry). See webpack-merge for more info.
replaceDuplicatePlugins: Defaults to false. If true, the plugins in custom webpack config will replace the corresponding plugins in default Angular CLI webpack configuration.

@sifawm/custom-webpack v7.1.3

Custom webpack builders for Angular build facade

Prerequisites:

Usage

For example

Builders

Custom webpack browser

Custom webpack server

Custom webpack Karma

Custom webpack config object

Further reading