esbuild-auto-path-plugin 0.15.1-beta.5107

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 - 2022 smapiot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,65 @@
+# `esbuild-auto-path-plugin`
+
+A plugin for `esbuild` to allow referencing files relative to the path of the JavaSCript. This can be useful to work in a micro frontend setup where the individual files of one micro frontend are served from a different path than the other micro frontends, i.e., no common public path can be determined.
+
+## Usage
+
+Install the plugin:
+
+```sh
+npm i esbuild-auto-path-plugin --save-dev
+```
+
+Now in your `esbuild` configuration file you can do:
+
+```js
+const { build } = require('esbuild');
+const { autoPathPlugin } = require('esbuild-auto-path-plugin');
+
+build({
+  // ...
+  plugins: [autoPathPlugin()],
+});
+```
+
+At this point you can reference an asset file (e.g., `.jpg`) in any file, e.g., in a TypeScript asset
+
+```js
+import someImage from './my.jpg';
+```
+
+The reference to the generated asset file will be done via the automatically (i.e., at runtime) determined path.
+
+### File Extensions
+
+This plugin takes all extensions mapped to the `file` type in your esbuild configuration. However, you can also use the plugin to generate you this list of files. By default (i.e., if you don't specify any option and have not introduced any custom loader mapping) the following extensions will be mapped:
+
+- `.png`
+- `.svg`
+- `.jpg`
+- `.jpeg`
+- `.webp`
+- `.mp4`
+- `.mp3`
+- `.ogg`
+- `.wav`
+- `.ogv`
+- `.wasm`
+- `.gif`
+
+To override this list you can just pass in the extensions like this:
+
+```js
+const { build } = require('esbuild');
+const { autoPathPlugin } = require('esbuild-auto-path-plugin');
+
+build({
+  plugins: [autoPathPlugin({
+    defaultExtensions: [".png", ".mov", ".woff"]
+  })],
+});
+```
+
+## License
+
+This plugin is released using the MIT license. For more information see the [LICENSE file](LICENSE).

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+import { Plugin } from "esbuild";
+interface AutoPathPluginOptions {
+    defaultExtensions?: Array<string>;
+}
+export declare const autoPathPlugin: (options?: AutoPathPluginOptions) => Plugin;
+export {};

package/lib/index.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.autoPathPlugin = void 0;
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
+const fallbackExtensions = [
+    ".png",
+    ".svg",
+    ".jpg",
+    ".jpeg",
+    ".webp",
+    ".mp4",
+    ".mp3",
+    ".ogg",
+    ".wav",
+    ".ogv",
+    ".wasm",
+    ".gif",
+];
+function makeExtensions(extensions = fallbackExtensions) {
+    return extensions.reduce((obj, ext) => {
+        obj[ext] = "file";
+        return obj;
+    }, {});
+}
+const autoPathPlugin = (options = {}) => ({
+    name: "auto-path-plugin",
+    setup(build) {
+        const { loader = makeExtensions(options.defaultExtensions) } = build.initialOptions;
+        const extensions = [];
+        for (const ext of Object.keys(loader)) {
+            const l = loader[ext];
+            if (l === "file") {
+                extensions.push(ext);
+                delete loader[ext];
+            }
+        }
+        const filter = new RegExp(`(${extensions.map((ext) => `\\${ext}`).join("|")})$`);
+        build.onResolve({ filter }, (args) => {
+            if (args.namespace === "ref-stub") {
+                return {
+                    path: args.path,
+                    namespace: "ref-binary",
+                };
+            }
+            else if (args.resolveDir !== "") {
+                return {
+                    path: (0, path_1.isAbsolute)(args.path)
+                        ? args.path
+                        : (0, path_1.join)(args.resolveDir, args.path),
+                    // for CSS we'll just use the path; no intermediate module needed
+                    namespace: args.kind === "url-token" ? "ref-binary" : "ref-stub",
+                };
+            }
+            else {
+                return; // Ignore unresolvable paths
+            }
+        });
+        build.onLoad({ filter: /.*/, namespace: "ref-stub" }, async (args) => ({
+            resolveDir: (0, path_1.resolve)(__dirname),
+            contents: [
+                `import path from ${JSON.stringify(args.path)}`,
+                `import { __bundleUrl__ } from ${JSON.stringify("../set-path.js")}`,
+                `export default __bundleUrl__ + path;`,
+            ].join("\n"),
+        }));
+        build.onLoad({ filter: /.*/, namespace: "ref-binary" }, async (args) => ({
+            contents: await (0, promises_1.readFile)(args.path),
+            loader: "file",
+        }));
+    },
+});
+exports.autoPathPlugin = autoPathPlugin;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,0CAAuC;AACvC,+BAAiD;AAEjD,MAAM,kBAAkB,GAAG;IACzB,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;CACP,CAAC;AAMF,SAAS,cAAc,CAAC,UAAU,GAAG,kBAAkB;IACrD,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACpC,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;QAClB,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAA4B,CAAC,CAAC;AACnC,CAAC;AAEM,MAAM,cAAc,GAAG,CAAC,UAAiC,EAAE,EAAU,EAAE,CAAC,CAAC;IAC9E,IAAI,EAAE,kBAAkB;IACxB,KAAK,CAAC,KAAK;QACT,MAAM,EAAE,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,GAC1D,KAAK,CAAC,cAAc,CAAC;QACvB,MAAM,UAAU,GAAkB,EAAE,CAAC;QAErC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YACrC,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YAEtB,IAAI,CAAC,KAAK,MAAM,EAAE;gBAChB,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACrB,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;aACpB;SACF;QAED,MAAM,MAAM,GAAG,IAAI,MAAM,CACvB,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CACtD,CAAC;QAEF,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;YACnC,IAAI,IAAI,CAAC,SAAS,KAAK,UAAU,EAAE;gBACjC,OAAO;oBACL,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,SAAS,EAAE,YAAY;iBACxB,CAAC;aACH;iBAAM,IAAI,IAAI,CAAC,UAAU,KAAK,EAAE,EAAE;gBACjC,OAAO;oBACL,IAAI,EAAE,IAAA,iBAAU,EAAC,IAAI,CAAC,IAAI,CAAC;wBACzB,CAAC,CAAC,IAAI,CAAC,IAAI;wBACX,CAAC,CAAC,IAAA,WAAI,EAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC;oBACpC,iEAAiE;oBACjE,SAAS,EAAE,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,UAAU;iBACjE,CAAC;aACH;iBAAM;gBACL,OAAO,CAAC,4BAA4B;aACrC;QACH,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YACrE,UAAU,EAAE,IAAA,cAAO,EAAC,SAAS,CAAC;YAC9B,QAAQ,EAAE;gBACR,oBAAoB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAC/C,iCAAiC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE;gBACnE,sCAAsC;aACvC,CAAC,IAAI,CAAC,IAAI,CAAC;SACb,CAAC,CAAC,CAAC;QAEJ,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YACvE,QAAQ,EAAE,MAAM,IAAA,mBAAQ,EAAC,IAAI,CAAC,IAAI,CAAC;YACnC,MAAM,EAAE,MAAM;SACf,CAAC,CAAC,CAAC;IACN,CAAC;CACF,CAAC,CAAC;AArDU,QAAA,cAAc,kBAqDxB"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "esbuild-auto-path-plugin",
+  "version": "0.15.1-beta.5107",
+  "description": "Plugin for transforming bundles to use an auto path for assets.",
+  "keywords": [
+    "plugin",
+    "esbuild",
+    "build",
+    "microfrontend"
+  ],
+  "author": "smapiot",
+  "homepage": "https://piral.io",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "engines": {
+    "node": ">=12.0"
+  },
+  "files": [
+    "lib",
+    "src",
+    "set-path.js"
+  ],
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/smapiot"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/smapiot/piral-cli-esbuild.git"
+  },
+  "bugs": {
+    "url": "https://github.com/smapiot/piral-cli-esbuild/issues"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: run tests from root\" && exit 1"
+  },
+  "devDependencies": {
+    "esbuild": "^0.13.6"
+  },
+  "gitHead": "5f5af4ab4f6dc4996df9f989d156b69fe2736747"
+}

package/set-path.js

@@ -0,0 +1,22 @@
+function computePath() {
+  try {
+    throw new Error();
+  } catch (t) {
+    const e = ("" + t.stack).match(
+      /(https?|file|ftp|chrome-extension|moz-extension):\/\/[^)\n]+/g
+    );
+
+    if (e) {
+      return (
+        e[0].replace(
+          /^((?:https?|file|ftp|chrome-extension|moz-extension):\/\/.+)\/[^\/]+$/,
+          "$1"
+        ) + "/"
+      );
+    }
+  }
+
+  return "/";
+}
+
+export const __bundleUrl__ = computePath();

package/src/index.ts

@@ -0,0 +1,84 @@
+import { Plugin } from "esbuild";
+import { readFile } from "fs/promises";
+import { isAbsolute, join, resolve } from "path";
+
+const fallbackExtensions = [
+  ".png",
+  ".svg",
+  ".jpg",
+  ".jpeg",
+  ".webp",
+  ".mp4",
+  ".mp3",
+  ".ogg",
+  ".wav",
+  ".ogv",
+  ".wasm",
+  ".gif",
+];
+
+interface AutoPathPluginOptions {
+  defaultExtensions?: Array<string>;
+}
+
+function makeExtensions(extensions = fallbackExtensions) {
+  return extensions.reduce((obj, ext) => {
+    obj[ext] = "file";
+    return obj;
+  }, {} as Record<string, "file">);
+}
+
+export const autoPathPlugin = (options: AutoPathPluginOptions = {}): Plugin => ({
+  name: "auto-path-plugin",
+  setup(build) {
+    const { loader = makeExtensions(options.defaultExtensions) } =
+      build.initialOptions;
+    const extensions: Array<string> = [];
+
+    for (const ext of Object.keys(loader)) {
+      const l = loader[ext];
+
+      if (l === "file") {
+        extensions.push(ext);
+        delete loader[ext];
+      }
+    }
+
+    const filter = new RegExp(
+      `(${extensions.map((ext) => `\\${ext}`).join("|")})$`
+    );
+
+    build.onResolve({ filter }, (args) => {
+      if (args.namespace === "ref-stub") {
+        return {
+          path: args.path,
+          namespace: "ref-binary",
+        };
+      } else if (args.resolveDir !== "") {
+        return {
+          path: isAbsolute(args.path)
+            ? args.path
+            : join(args.resolveDir, args.path),
+          // for CSS we'll just use the path; no intermediate module needed
+          namespace: args.kind === "url-token" ? "ref-binary" : "ref-stub",
+        };
+      } else {
+        return; // Ignore unresolvable paths
+      }
+    });
+
+    build.onLoad({ filter: /.*/, namespace: "ref-stub" }, async (args) => ({
+      resolveDir: resolve(__dirname),
+      contents: [
+        `import path from ${JSON.stringify(args.path)}`,
+        `import { __bundleUrl__ } from ${JSON.stringify("../set-path.js")}`,
+        `export default __bundleUrl__ + path;`,
+      ].join("\n"),
+    }));
+
+    build.onLoad({ filter: /.*/, namespace: "ref-binary" }, async (args) => ({
+      contents: await readFile(args.path),
+      loader: "file",
+    }));
+  },
+});