@fal-works/esbuild-plugin-global-externals/src/with-object.ts

esbuild plugin for replacing imports with global variables.

import type * as esbuild from "esbuild";
import type { ModuleInfo } from "./module-info";
import type { GlobalsMapper } from "./with-reg-exp";
import { globalExternalsWithRegExp } from "./with-reg-exp.js";

/**
 * Create a `Plugin` for replacing modules with corresponding global variables.
 *
 * @param globals Object that maps between the two below:
 *
 * - From: Module path used in any `import` statements that should be replaced
 *   with a global variable.
 * - To: String for a global variable name, or any `ModuleInfo` object
 *   which also includes the global variable name.
 *
 * @example
 *
 * ```
 * const plugins = [globalExternals({ jquery: "$" })];
 * ```
 */
export const globalExternals = <T extends string>(
  globals: Record<T, string | ModuleInfo>
): esbuild.Plugin => {
  const normalizedGlobals: GlobalsMapper<T> = {
    modulePathFilter: new RegExp(`^(?:${Object.keys(globals).join("|")})$`),
    getModuleInfo: (modulePath: T) => globals[modulePath],
  };

  return globalExternalsWithRegExp(normalizedGlobals);
};