README.md

ng-cli-hooks

Hooks for the angular-cli

This documentation is for version 7 only

Documentation for other versions could be found here:

• Version 8.x.x

Getting Started

Install the package:

npm install --save-dev ng-cli-hooks

Update your angular.json file:

{
  ...
  "projects": {
    "app": {
      ...
      "architect": {
        "build": {
          "builder": "ng-cli-hooks:browser",
          "options": {
            "optionsHook": "hooks/options.js",
            "webpackHook": "hooks/webpack.js",
            ...

This Plugin contains hookable builders for

• browser
• dev-server
• extract-i18n
• server

Hooks

Currently this plugin contains two different hooks: optionsHook and webpackHook.

optionsHook

This hook modifies the options for the builder at build-time.

Example: hooks/options.js

module.exports = function(options) {
  options.assets = options.assets.map(asset => {
    if(asset.input === 'src/assets') {
      asset.input = `branding/${process.env.APP_BRANDING}/assets`;
    }
    return asset;
  });
  return options;
}

webpackHook

This hook can be used to modify the generated webpack-config of angular-cli or to replace it.

Modify the generated webpack-config

Example: hooks/webpack.js

const StringReplacePlugin = require('string-replace-webpack-plugin');

module.exports = function (generatedWebpackConfig, options) {
  generatedWebpackConfig.module.rules.push({
    test: /\.html$/,
    loader: StringReplacePlugin.replace({
      replacements: [
        {
          pattern: /Hello World/ig,
          replacement: function () {
            return 'Hello Angular'
          }
        }
      ]
    })
  });
  return generatedWebpackConfig;
}

Replace the generated webpack-config

If hooks/webpack.js exports a webpack-config-object, than the generated webpack-config will be replaced by your own.

Ionic 4

The ionic-cli uses hardcoded the BrowserBuilder from Angular for the cordova-build. This made it impossible to use ng-cli-hooks for the cordova-build. To force Ionic to use ng-cli-hooks we can replace @ionic/ng-toolkit:cordova-build with ng-cli-hooks:cordova-build in the angular.json file.

Changelog

7.0.0

• Major version of ng-cli-hooks now equals the Angular version (use [email protected] to work with Angular 7.x.x)

1.1.0

• added ng-cli-hooks:cordova-build for Ionic 4 projects.