@angular-builders/custom-webpack 14.0.2-beta.0 → 14.1.0

package/README.md

@@ -4,6 +4,28 @@
 
 Allow customizing build configuration without ejecting webpack configuration (`ng eject`)
 
+# Table of Contents
+
+- [Usage](#usage)
+  - [For Example](#for-example)
+- [Builders](#builders)
+  - [Custom Webpack `browser`](#custom-webpack-browser)
+  - [Custom Webpack `dev-server`](#custom-webpack-dev-server)
+    - [Example](#example)
+  - [Custom Webpack `server`](#custom-webpack-server)
+  - [Custom Webpack `karma`](#custom-webpack-karma)
+  - [Custom Webpack `extract-i18n`](#custom-webpack-extract-i18n)
+    - [Example](#example-1)
+- [Custom Webpack Config Object](#custom-webpack-config-object)
+  - [Merging Plugins Configuration:](#merging-plugins-configuration-)
+  - [Custom Webpack Promisified Config](#custom-webpack-promisified-config)
+  - [Custom Webpack Config Function](#custom-webpack-config-function)
+- [Index Transform](#index-transform)
+  - [Example](#example-2)
+- [ES Modules (ESM) Support](#es-modules-esm-support)
+- [Verbose Logging](#verbose-logging)
+- [Further Reading](#further-reading)
+
 # This documentation is for the latest major version only
 
 ## Previous versions
@@ -504,6 +526,39 @@ Custom Webpack builder fully supports ESM.
 - If you want to use TS config in ESM app, you must set the loader to `ts-node/esm` when running `ng build`. Also, in that case `tsconfig.json` for `ts-node` no longer defaults to `tsConfig` from the `browser` target - you have to specify it manually via environment variable. [Example](../../examples/custom-webpack/sanity-app-esm/package.json#L10).  
   _Note that tsconfig paths are not supported in TS configs within ESM apps. That is because [tsconfig-paths](https://github.com/dividab/tsconfig-paths) do not support ESM._
 
+# Verbose Logging
+
+Custom Webpack allows enabling verbose logging for configuration properties. This can be achieved by providing the `verbose` object in builder options. Given the following example:
+
+```json
+{
+  "builder": "@angular-builders/custom-webpack:browser",
+  "options": {
+    "customWebpackConfig": {
+      "verbose": {
+        "properties": ["entry"]
+      }
+    }
+  }
+}
+```
+
+`properties` is an array of strings that supports individual or deeply nested keys (`output.publicPath` and `plugins[0]` are valid keys). The number of times to recurse the object while formatting before it's logged is controlled by the `serializationDepth` property:
+
+```json
+{
+  "builder": "@angular-builders/custom-webpack:browser",
+  "options": {
+    "customWebpackConfig": {
+      "verbose": {
+        "properties": ["plugins[0]"],
+        "serializationDepth": 5
+      }
+    }
+  }
+}
+```
+
 # Further Reading
 
 - [Customizing Angular CLI build - an alternative to ng eject](https://medium.com/angular-in-depth/customizing-angular-cli-build-an-alternative-to-ng-eject-v2-c655768b48cc)

package/dist/browser/schema.json

@@ -456,6 +456,23 @@
             "replaceDuplicatePlugins": {
               "type": "boolean",
               "description": "Flag that indicates whether to replace duplicate webpack plugins or not"
+            },
+            "verbose": {
+              "type": "object",
+              "description": "Determines whether to log configuration properties into a console",
+              "properties": {
+                "properties": {
+                  "description": "A list of properties to log into a console, for instance, `['plugins', 'mode', 'entry']`",
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "serializationDepth": {
+                  "type": "number",
+                  "description": "The number of times to recurse the object while formatting"
+                }
+              }
             }
           }
         },

package/dist/custom-webpack-builder-config.d.ts

@@ -4,4 +4,8 @@ export interface CustomWebpackBuilderConfig {
     path?: string;
     mergeRules?: MergeRules;
     replaceDuplicatePlugins?: boolean;
+    verbose?: {
+        properties?: string[];
+        serializationDepth?: number;
+    };
 }

package/dist/custom-webpack-builder.d.ts

@@ -4,5 +4,5 @@ import { CustomWebpackBuilderConfig } from './custom-webpack-builder-config';
 import { TargetOptions } from './type-definition';
 export declare const defaultWebpackConfigPath = "webpack.config.js";
 export declare class CustomWebpackBuilder {
-    static buildWebpackConfig(root: Path, config: CustomWebpackBuilderConfig, baseWebpackConfig: Configuration, buildOptions: any, targetOptions: TargetOptions, logger: logging.LoggerApi): Promise<Configuration>;
+    static buildWebpackConfig(root: Path, config: CustomWebpackBuilderConfig | null, baseWebpackConfig: Configuration, buildOptions: any, targetOptions: TargetOptions, logger: logging.LoggerApi): Promise<Configuration>;
 }

package/dist/custom-webpack-builder.js

@@ -10,7 +10,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomWebpackBuilder = exports.defaultWebpackConfigPath = void 0;
+const util_1 = require("util");
 const core_1 = require("@angular-devkit/core");
+const lodash_1 = require("lodash");
 const utils_1 = require("./utils");
 const webpack_config_merger_1 = require("./webpack-config-merger");
 exports.defaultWebpackConfigPath = 'webpack.config.js';
@@ -25,19 +27,22 @@ class CustomWebpackBuilder {
             const tsConfig = `${(0, core_1.getSystemPath)(root)}/${buildOptions.tsConfig}`;
             const configOrFactoryOrPromise = yield resolveCustomWebpackConfig(path, tsConfig, logger);
             if (typeof configOrFactoryOrPromise === 'function') {
-                // That exported function can be synchronous either
-                // asynchronous. Given the following example:
-                // `module.exports = async (config) => { ... }`
-                return configOrFactoryOrPromise(baseWebpackConfig, buildOptions, targetOptions);
+                // The exported function can return a new configuration synchronously
+                // or return a promise that resolves to a new configuration.
+                const finalWebpackConfig = yield configOrFactoryOrPromise(baseWebpackConfig, buildOptions, targetOptions);
+                logConfigProperties(config, finalWebpackConfig, logger);
+                return finalWebpackConfig;
             }
-            // The user can also export a `Promise` that resolves `Configuration`
-            // object. Given the following example:
+            // The user can also export a promise that resolves to a `Configuration` object.
+            // Suppose the following example:
             // `module.exports = new Promise(resolve => resolve({ ... }))`
-            // If the user has exported a plain object, like:
-            // `module.exports = { ... }`
-            // then it will promisified and awaited
+            // This is valid both for promise and non-promise cases. If users export
+            // a plain object, for instance, `module.exports = { ... }`, then it will
+            // be wrapped into a promise and also `awaited`.
             const resolvedConfig = yield configOrFactoryOrPromise;
-            return (0, webpack_config_merger_1.mergeConfigs)(baseWebpackConfig, resolvedConfig, config.mergeRules, config.replaceDuplicatePlugins);
+            const finalWebpackConfig = (0, webpack_config_merger_1.mergeConfigs)(baseWebpackConfig, resolvedConfig, config.mergeRules, config.replaceDuplicatePlugins);
+            logConfigProperties(config, finalWebpackConfig, logger);
+            return finalWebpackConfig;
         });
     }
 }
@@ -48,4 +53,20 @@ function resolveCustomWebpackConfig(path, tsConfig, logger) {
         return (0, utils_1.loadModule)(path);
     });
 }
+function logConfigProperties(config, webpackConfig, logger) {
+    var _a;
+    // There's no reason to log the entire configuration object
+    // since Angular's Webpack configuration is huge by default
+    // and doesn't bring any meaningful context by being printed
+    // entirely. Users can provide a list of properties they want to be logged.
+    if ((_a = config.verbose) === null || _a === void 0 ? void 0 : _a.properties) {
+        for (const property of config.verbose.properties) {
+            const value = (0, lodash_1.get)(webpackConfig, property);
+            if (value) {
+                const message = (0, util_1.inspect)(value, /* showHidden */ false, config.verbose.serializationDepth);
+                logger.info(message);
+            }
+        }
+    }
+}
 //# sourceMappingURL=custom-webpack-builder.js.map

package/dist/custom-webpack-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"custom-webpack-builder.js","sourceRoot":"","sources":["../src/custom-webpack-builder.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+CAAoE;AAKpE,mCAAqD;AACrD,mEAAuD;AAE1C,QAAA,wBAAwB,GAAG,mBAAmB,CAAC;AAgB5D,MAAa,oBAAoB;IAC/B,MAAM,CAAO,kBAAkB,CAC7B,IAAU,EACV,MAAkC,EAClC,iBAAgC,EAChC,YAAiB,EACjB,aAA4B,EAC5B,MAAyB;;YAEzB,IAAI,CAAC,MAAM,EAAE;gBACX,OAAO,iBAAiB,CAAC;aAC1B;YAED,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,IAAI,gCAAwB,CAAC;YAClE,MAAM,IAAI,GAAG,GAAG,IAAA,oBAAa,EAAC,IAAI,CAAC,IAAI,iBAAiB,EAAE,CAAC;YAC3D,MAAM,QAAQ,GAAG,GAAG,IAAA,oBAAa,EAAC,IAAI,CAAC,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;YACnE,MAAM,wBAAwB,GAAG,MAAM,0BAA0B,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;YAE1F,IAAI,OAAO,wBAAwB,KAAK,UAAU,EAAE;gBAClD,mDAAmD;gBACnD,6CAA6C;gBAC7C,+CAA+C;gBAC/C,OAAO,wBAAwB,CAAC,iBAAiB,EAAE,YAAY,EAAE,aAAa,CAAC,CAAC;aACjF;YAED,qEAAqE;YACrE,uCAAuC;YACvC,8DAA8D;YAC9D,iDAAiD;YACjD,6BAA6B;YAC7B,uCAAuC;YACvC,MAAM,cAAc,GAAG,MAAM,wBAAwB,CAAC;YAEtD,OAAO,IAAA,oCAAY,EACjB,iBAAiB,EACjB,cAAc,EACd,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,uBAAuB,CAC/B,CAAC;QACJ,CAAC;KAAA;CACF;AAxCD,oDAwCC;AAED,SAAe,0BAA0B,CACvC,IAAY,EACZ,QAAgB,EAChB,MAAyB;;QAEzB,IAAA,sBAAc,EAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAEvC,OAAO,IAAA,kBAAU,EAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CAAA"}
+{"version":3,"file":"custom-webpack-builder.js","sourceRoot":"","sources":["../src/custom-webpack-builder.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+BAA+B;AAC/B,+CAAoE;AACpE,mCAA6B;AAK7B,mCAAqD;AACrD,mEAAuD;AAE1C,QAAA,wBAAwB,GAAG,mBAAmB,CAAC;AAgB5D,MAAa,oBAAoB;IAC/B,MAAM,CAAO,kBAAkB,CAC7B,IAAU,EACV,MAAyC,EACzC,iBAAgC,EAChC,YAAiB,EACjB,aAA4B,EAC5B,MAAyB;;YAEzB,IAAI,CAAC,MAAM,EAAE;gBACX,OAAO,iBAAiB,CAAC;aAC1B;YAED,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,IAAI,gCAAwB,CAAC;YAClE,MAAM,IAAI,GAAG,GAAG,IAAA,oBAAa,EAAC,IAAI,CAAC,IAAI,iBAAiB,EAAE,CAAC;YAC3D,MAAM,QAAQ,GAAG,GAAG,IAAA,oBAAa,EAAC,IAAI,CAAC,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;YACnE,MAAM,wBAAwB,GAAG,MAAM,0BAA0B,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;YAE1F,IAAI,OAAO,wBAAwB,KAAK,UAAU,EAAE;gBAClD,qEAAqE;gBACrE,4DAA4D;gBAC5D,MAAM,kBAAkB,GAAG,MAAM,wBAAwB,CACvD,iBAAiB,EACjB,YAAY,EACZ,aAAa,CACd,CAAC;gBACF,mBAAmB,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,CAAC,CAAC;gBACxD,OAAO,kBAAkB,CAAC;aAC3B;YAED,gFAAgF;YAChF,iCAAiC;YACjC,8DAA8D;YAC9D,wEAAwE;YACxE,yEAAyE;YACzE,gDAAgD;YAChD,MAAM,cAAc,GAAG,MAAM,wBAAwB,CAAC;YAEtD,MAAM,kBAAkB,GAAG,IAAA,oCAAY,EACrC,iBAAiB,EACjB,cAAc,EACd,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,uBAAuB,CAC/B,CAAC;YACF,mBAAmB,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,CAAC,CAAC;YACxD,OAAO,kBAAkB,CAAC;QAC5B,CAAC;KAAA;CACF;AA/CD,oDA+CC;AAED,SAAe,0BAA0B,CACvC,IAAY,EACZ,QAAgB,EAChB,MAAyB;;QAEzB,IAAA,sBAAc,EAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAEvC,OAAO,IAAA,kBAAU,EAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CAAA;AAED,SAAS,mBAAmB,CAC1B,MAAkC,EAClC,aAA4B,EAC5B,MAAyB;;IAEzB,2DAA2D;IAC3D,2DAA2D;IAC3D,4DAA4D;IAC5D,2EAA2E;IAC3E,IAAI,MAAA,MAAM,CAAC,OAAO,0CAAE,UAAU,EAAE;QAC9B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE;YAChD,MAAM,KAAK,GAAG,IAAA,YAAG,EAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YAC3C,IAAI,KAAK,EAAE;gBACT,MAAM,OAAO,GAAG,IAAA,cAAO,EAAC,KAAK,EAAE,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;gBAC1F,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACtB;SACF;KACF;AACH,CAAC"}

package/dist/karma/schema.json

@@ -271,6 +271,23 @@
             "replaceDuplicatePlugins": {
               "type": "boolean",
               "description": "Flag that indicates whether to replace duplicate webpack plugins or not"
+            },
+            "verbose": {
+              "type": "object",
+              "description": "Determines whether to log configuration properties into a console",
+              "properties": {
+                "properties": {
+                  "description": "A list of properties to log into a console, for instance, `['plugins', 'mode', 'entry']`",
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "serializationDepth": {
+                  "type": "number",
+                  "description": "The number of times to recurse the object while formatting"
+                }
+              }
             }
           }
         },

package/dist/server/schema.json

@@ -255,6 +255,23 @@
             "replaceDuplicatePlugins": {
               "type": "boolean",
               "description": "Flag that indicates whether to replace duplicate webpack plugins or not"
+            },
+            "verbose": {
+              "type": "object",
+              "description": "Determines whether to log configuration properties into a console",
+              "properties": {
+                "properties": {
+                  "description": "A list of properties to log into a console, for instance, `['plugins', 'mode', 'entry']`",
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "serializationDepth": {
+                  "type": "number",
+                  "description": "The number of times to recurse the object while formatting"
+                }
+              }
             }
           }
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-builders/custom-webpack",
-  "version": "14.0.2-beta.0",
+  "version": "14.1.0",
   "description": "Custom webpack builders for Angular build facade. Allow to modify Angular build configuration without ejecting it",
   "main": "dist/index.js",
   "files": [
@@ -56,5 +56,5 @@
     "rimraf": "^3.0.2",
     "typescript": "4.7.4"
   },
-  "gitHead": "acc0e556565bd324a0403365b2291099e8bf4b31"
+  "gitHead": "686a75c3d29bbc84850895df59e77b2293b47113"
 }