@angular-builders/custom-esbuild 18.0.0 → 18.1.0-beta.0

package/README.md

@@ -100,19 +100,25 @@ Builder options:
   "build": {
     "builder": "@angular-builders/custom-esbuild:application",
     "options": {
-      "plugins": ["./esbuild/plugins.ts", "./esbuild/plugin-2.js"],
+      "plugins": ["./esbuild/plugins.ts", { "path": "./esbuild/define-env.ts", "options": { "stage": "development" } }],
       "indexHtmlTransformer": "./esbuild/index-html-transformer.js",
       "outputPath": "dist/my-cool-client",
       "index": "src/index.html",
       "browser": "src/main.ts",
       "polyfills": ["zone.js"],
       "tsConfig": "src/tsconfig.app.json"
+    },
+    "configurations": {
+      "production": {
+        "plugins": ["./esbuild/plugins.ts", { "path": "./esbuild/define-env.ts", "options": { "stage": "production" } }]
+      }
     }
+  }
 ```
 
 In the above example, we specify the list of `plugins` that should implement the ESBuild plugin schema. These plugins are custom user plugins and are added to the original ESBuild Angular configuration. Additionally, the `indexHtmlTransformer` property is used to specify the path to the file that exports the function used to modify the `index.html`.
 
-The plugin file can export either a single plugin or a list of plugins:
+The plugin file can export either a single plugin or a list of plugins. If a plugin accepts configuration then the config should be provided in `angular.json`:
 
 ```ts
 // esbuild/plugins.ts
@@ -129,6 +135,25 @@ const defineTextPlugin: Plugin = {
 export default defineTextPlugin;
 ```
 
+OR:
+
+```ts
+// esbuild/plugins.ts
+import type { Plugin, PluginBuild } from 'esbuild';
+
+function defineEnv(pluginOptions: { stage: string }): Plugin {
+  return {
+    name: 'define-env',  
+    setup(build: PluginBuild) {
+      const buildOptions = build.initialOptions;
+      buildOptions.define.stage = JSON.stringify(pluginOptions.stage);
+    },
+  };
+};
+
+export default defineEnv;
+```
+
 Or:
 
 ```ts

package/dist/application/schema.json

@@ -152,7 +152,7 @@
       "description": "Automatically clear the terminal screen during rebuilds."
     },
     "optimization": {
-      "description": "Enables optimization of the build output. Including minification of scripts and styles, tree-shaking, dead-code elimination, inlining of critical CSS and fonts inlining. For more information, see https://angular.io/guide/workspace-config#optimization-configuration.",
+      "description": "Enables optimization of the build output. Including minification of scripts and styles, tree-shaking, dead-code elimination, inlining of critical CSS and fonts inlining. For more information, see https://angular.dev/reference/configs/workspace-config#optimization-configuration.",
       "default": true,
       "x-user-analytics": "ep.ng_optimization",
       "oneOf": [
@@ -297,7 +297,7 @@
       "default": true
     },
     "sourceMap": {
-      "description": "Output source maps for scripts and styles. For more information, see https://angular.io/guide/workspace-config#source-map-configuration.",
+      "description": "Output source maps for scripts and styles. For more information, see https://angular.dev/reference/configs/workspace-config#source-map-configuration.",
       "default": false,
       "oneOf": [
         {
@@ -571,7 +571,25 @@
       "description": "A list of paths to ESBuild plugins",
       "default": [],
       "items": {
-        "type": "string",
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "path": {
+                "type": "string"
+              },
+              "options": {
+                "type": "object"
+              }
+            },
+            "required": [
+              "path"
+            ]
+          }
+        ],
         "uniqueItems": true
       }
     },

package/dist/custom-esbuild-schema.d.ts

@@ -1,4 +1,8 @@
 import { ApplicationBuilderOptions, DevServerBuilderOptions } from '@angular-devkit/build-angular';
+export type PluginConfig = string | {
+    path: string;
+    options?: Record<string, unknown>;
+};
 export type CustomEsbuildApplicationSchema = ApplicationBuilderOptions & {
     plugins?: string[];
     indexHtmlTransformer?: string;

package/dist/dev-server/schema.json

@@ -27,7 +27,7 @@
     },
     "proxyConfig": {
       "type": "string",
-      "description": "Proxy configuration file. For more information, see https://angular.io/guide/build#proxying-to-a-backend-server."
+      "description": "Proxy configuration file. For more information, see https://angular.dev/tools/cli/serve#proxying-to-a-backend-server."
     },
     "ssl": {
       "type": "boolean",
@@ -102,6 +102,19 @@
       "type": "number",
       "description": "Enable and define the file watching poll time period in milliseconds."
     },
+    "inspect": {
+      "default": false,
+      "description": "Activate debugging inspector. This option only has an effect when 'SSR' or 'SSG' are enabled.",
+      "oneOf": [
+        {
+          "type": "string",
+          "description": "Activate the inspector on host and port in the format of `[[host:]port]`. See the security warning in https://nodejs.org/docs/latest-v22.x/api/cli.html#warning-binding-inspector-to-a-public-ipport-combination-is-insecure regarding the host parameter usage."
+        },
+        {
+          "type": "boolean"
+        }
+      ]
+    },
     "forceEsbuild": {
       "type": "boolean",
       "description": "Force the development server to use the 'browser-esbuild' builder when building. This is a developer preview option for the esbuild-based build system.",

package/dist/load-plugins.d.ts

@@ -1,3 +1,4 @@
 import type { Plugin } from 'esbuild';
 import type { logging } from '@angular-devkit/core';
-export declare function loadPlugins(paths: string[] | undefined, workspaceRoot: string, tsConfig: string, logger: logging.LoggerApi): Promise<Plugin[]>;
+import { PluginConfig } from './custom-esbuild-schema';
+export declare function loadPlugins(pluginConfig: PluginConfig[] | undefined, workspaceRoot: string, tsConfig: string, logger: logging.LoggerApi): Promise<Plugin[]>;

package/dist/load-plugins.js

@@ -12,9 +12,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadPlugins = void 0;
 const path = require("node:path");
 const common_1 = require("@angular-builders/common");
-function loadPlugins(paths, workspaceRoot, tsConfig, logger) {
+function loadPlugins(pluginConfig, workspaceRoot, tsConfig, logger) {
     return __awaiter(this, void 0, void 0, function* () {
-        const plugins = yield Promise.all((paths || []).map(pluginPath => (0, common_1.loadModule)(path.join(workspaceRoot, pluginPath), tsConfig, logger)));
+        const plugins = yield Promise.all((pluginConfig || []).map((pluginConfig) => __awaiter(this, void 0, void 0, function* () {
+            if (typeof pluginConfig === 'string') {
+                return (0, common_1.loadModule)(path.join(workspaceRoot, pluginConfig), tsConfig, logger);
+            }
+            else {
+                const pluginFactory = yield (0, common_1.loadModule)(path.join(workspaceRoot, pluginConfig.path), tsConfig, logger);
+                return pluginFactory(pluginConfig.options);
+            }
+        })));
         return plugins.flat();
     });
 }

package/dist/load-plugins.js.map

@@ -1 +1 @@
-{"version":3,"file":"load-plugins.js","sourceRoot":"","sources":["../src/load-plugins.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kCAAkC;AAGlC,qDAAsD;AAEtD,SAAsB,WAAW,CAC/B,KAA2B,EAC3B,aAAqB,EACrB,QAAgB,EAChB,MAAyB;;QAEzB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAC7B,IAAA,mBAAU,EAAoB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,CACtF,CACF,CAAC;QAEF,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;IACxB,CAAC;CAAA;AAbD,kCAaC"}
+{"version":3,"file":"load-plugins.js","sourceRoot":"","sources":["../src/load-plugins.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kCAAkC;AAGlC,qDAAsD;AAGtD,SAAsB,WAAW,CAC/B,YAAwC,EACxC,aAAqB,EACrB,QAAgB,EAChB,MAAyB;;QAEzB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAM,YAAY,EAAC,EAAE;YAC1C,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;gBACrC,OAAO,IAAA,mBAAU,EAAoB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;YACjG,CAAC;iBAAM,CAAC;gBACN,MAAM,aAAa,GAAG,MAAM,IAAA,mBAAU,EAA6B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAClI,OAAO,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YAC7C,CAAC;QAEH,CAAC,CAAA,CACF,CACF,CAAC;QAEF,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;IACxB,CAAC;CAAA;AApBD,kCAoBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-builders/custom-esbuild",
-  "version": "18.0.0",
+  "version": "18.1.0-beta.0",
   "description": "Custom esbuild builders for Angular build facade. Allow to modify Angular build configuration without ejecting it",
   "main": "dist/index.js",
   "files": [
@@ -32,7 +32,8 @@
   "scripts": {
     "prebuild": "yarn clean",
     "build": "yarn prebuild && tsc && ts-node ../../merge-schemes.ts && yarn postbuild",
-    "postbuild": "yarn run e2e",
+    "postbuild": "yarn test && yarn run e2e",
+    "test": "jest --config ../../jest-ut.config.js",
     "e2e": "jest --config ../../jest-e2e.config.js",
     "clean": "rimraf dist",
     "ci": "./scripts/ci.sh"
@@ -49,11 +50,11 @@
   },
   "devDependencies": {
     "@angular/build": "^18.0.0",
-    "esbuild": "0.20.2",
+    "esbuild": "0.21.5",
     "jest": "29.7.0",
     "rimraf": "^5.0.0",
     "ts-node": "^10.0.0",
     "typescript": "5.4.5"
   },
-  "gitHead": "8369c67cb248abcc2210a2c25e8143e25d07f159"
+  "gitHead": "1b0decdede47b0d8a5a7049bbe68d8859c204edf"
 }