@gjsify/esbuild-plugin-transform-ext 0.0.2

package/README.md

@@ -0,0 +1,38 @@
+# @gjsify/esbuild-plugin-transform-ext
+
+Transform import file extensions plugin for `esbuild`.
+This can be useful if you want to bundle a module for Deno and Node.js. 
+
+## Example
+
+This example transforms the typescript entrypoint with `.ts` imports into a javascript file with `.js` imports.
+
+index:ts:
+```ts
+import { a } from './a.ts';
+import { b } from './b.ts';
+a();
+b();
+```
+
+esbuild.mjs:
+```js
+import esbuild from 'esbuild';
+import { transformExtPlugin } from "@gjsify/esbuild-plugin-transform-ext";
+
+await esbuild.build({
+  plugins: [transformExtPlugin({ outExtension: {'.ts': '.js'}})],
+  entryPoints: ["./src/index.ts"],
+  outdir: "./dist/",
+  bundle: false,
+  format: "esm",
+});
+```
+
+output index:js:
+```ts
+import { a } from './a.js';
+import { b } from './b.js';
+a();
+b();
+```

package/dist/cjs/index.cjs

@@ -0,0 +1,93 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  transformExtPlugin: () => transformExtPlugin,
+  transformImports: () => transformImports
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/plugin.ts
+var import_promises = require("fs/promises");
+var IMPORT_PATTERN = /(import|from) ("|')\..*\.(js|ts|mjs|cjs|mts|cts)("|')/gm;
+var TS_EXT_PATTERN = /\.(ts|mts|cts|tsx)/;
+var JS_EXT_PATTERN = /\.(js|mjs|cjs|jsx)/;
+var DEFAULT_EXTENSIONS = { ".js": ".js", ".ts": ".js", ".mts": ".js", ".cts": ".js", ".cjs": ".js", ".mjs": ".js" };
+var transformImports = async (path, outExtension = {}, verbose = false) => {
+  let changed = false;
+  let contents = await (0, import_promises.readFile)(path, "utf8");
+  if (Object.keys(outExtension).length <= 0) {
+    outExtension = DEFAULT_EXTENSIONS;
+  }
+  const matches = Array.from(contents.matchAll(IMPORT_PATTERN));
+  for (const match of matches) {
+    const importStr = match[0];
+    let transformed = importStr;
+    for (const ext of Object.keys(outExtension)) {
+      transformed = transformed.replaceAll(ext, outExtension[ext]);
+    }
+    if (importStr === transformed) {
+      continue;
+    }
+    changed = true;
+    contents = contents.replace(importStr, transformed);
+    if (verbose) {
+      console.debug(`[transform-ext] ${importStr} -> ${transformed}`);
+    }
+  }
+  if (changed && verbose) {
+    console.debug(`[transform-ext] in ${path}
+`);
+  }
+  return contents;
+};
+var transformExtPlugin = (pluginOptions) => {
+  const plugin = {
+    name: "transform-ext",
+    async setup(build) {
+      const outExtension = {};
+      if (pluginOptions.outExtension) {
+        Object.assign(outExtension, pluginOptions.outExtension);
+      } else if (build.initialOptions.outExtension) {
+        Object.assign(outExtension, build.initialOptions.outExtension);
+      } else {
+        Object.assign(outExtension, DEFAULT_EXTENSIONS);
+      }
+      const onLoad = async (loader, args) => {
+        let contents;
+        try {
+          contents = await transformImports(args.path, outExtension, pluginOptions.verbose);
+        } catch (error) {
+          console.error(error);
+          return null;
+        }
+        return { contents, loader };
+      };
+      build.onLoad({ filter: TS_EXT_PATTERN }, onLoad.bind(this, "ts"));
+      build.onLoad({ filter: JS_EXT_PATTERN }, onLoad.bind(this, "js"));
+    }
+  };
+  return plugin;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  transformExtPlugin,
+  transformImports
+});

package/dist/esm/index.mjs

@@ -0,0 +1,66 @@
+// src/plugin.ts
+import { readFile } from "fs/promises";
+var IMPORT_PATTERN = /(import|from) ("|')\..*\.(js|ts|mjs|cjs|mts|cts)("|')/gm;
+var TS_EXT_PATTERN = /\.(ts|mts|cts|tsx)/;
+var JS_EXT_PATTERN = /\.(js|mjs|cjs|jsx)/;
+var DEFAULT_EXTENSIONS = { ".js": ".js", ".ts": ".js", ".mts": ".js", ".cts": ".js", ".cjs": ".js", ".mjs": ".js" };
+var transformImports = async (path, outExtension = {}, verbose = false) => {
+  let changed = false;
+  let contents = await readFile(path, "utf8");
+  if (Object.keys(outExtension).length <= 0) {
+    outExtension = DEFAULT_EXTENSIONS;
+  }
+  const matches = Array.from(contents.matchAll(IMPORT_PATTERN));
+  for (const match of matches) {
+    const importStr = match[0];
+    let transformed = importStr;
+    for (const ext of Object.keys(outExtension)) {
+      transformed = transformed.replaceAll(ext, outExtension[ext]);
+    }
+    if (importStr === transformed) {
+      continue;
+    }
+    changed = true;
+    contents = contents.replace(importStr, transformed);
+    if (verbose) {
+      console.debug(`[transform-ext] ${importStr} -> ${transformed}`);
+    }
+  }
+  if (changed && verbose) {
+    console.debug(`[transform-ext] in ${path}
+`);
+  }
+  return contents;
+};
+var transformExtPlugin = (pluginOptions) => {
+  const plugin = {
+    name: "transform-ext",
+    async setup(build) {
+      const outExtension = {};
+      if (pluginOptions.outExtension) {
+        Object.assign(outExtension, pluginOptions.outExtension);
+      } else if (build.initialOptions.outExtension) {
+        Object.assign(outExtension, build.initialOptions.outExtension);
+      } else {
+        Object.assign(outExtension, DEFAULT_EXTENSIONS);
+      }
+      const onLoad = async (loader, args) => {
+        let contents;
+        try {
+          contents = await transformImports(args.path, outExtension, pluginOptions.verbose);
+        } catch (error) {
+          console.error(error);
+          return null;
+        }
+        return { contents, loader };
+      };
+      build.onLoad({ filter: TS_EXT_PATTERN }, onLoad.bind(this, "ts"));
+      build.onLoad({ filter: JS_EXT_PATTERN }, onLoad.bind(this, "js"));
+    }
+  };
+  return plugin;
+};
+export {
+  transformExtPlugin,
+  transformImports
+};

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types/index.js';
+export * from './plugin.js';

package/dist/types/plugin.d.ts

@@ -0,0 +1,12 @@
+import type { Plugin } from "esbuild";
+import type { PluginOptions, Extension } from './types/index.js';
+/**
+ * You can use this method to transform the imports of a file by yourself without the need of the esbuild plugin
+ * @param path The file path you want to transform
+ * @param outExtension The extension map you want to transform
+ * @param options
+ * @returns The transformed file content
+ */
+export declare const transformImports: (path: string, outExtension?: Extension, verbose?: boolean) => Promise<string>;
+export declare const transformExtPlugin: (pluginOptions: PluginOptions) => Plugin;
+export default transformExtPlugin;

package/dist/types/types/extension.d.ts

@@ -0,0 +1,3 @@
+export type Extension = {
+    [ext: string]: string;
+};

package/dist/types/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './extension.js';
+export * from './plugin-options.js';

package/dist/types/types/plugin-options.d.ts

@@ -0,0 +1,5 @@
+import type { Extension } from './extension.js';
+export interface PluginOptions {
+    outExtension?: Extension;
+    verbose?: boolean;
+}

package/esbuild.mjs

@@ -0,0 +1,49 @@
+import { build } from 'esbuild';
+import { readFile } from 'fs/promises';
+import { extname, dirname } from 'path';
+import { EXTERNALS_NODE } from '@gjsify/resolve-npm';
+
+const pkg = JSON.parse(
+    await readFile(
+      new URL('./package.json', import.meta.url), 'utf8'
+    )
+);
+
+if (!pkg.main && !pkg.module) {
+    throw new Error("package.json: The main or module property is required!");
+}
+
+const baseConfig = {
+    entryPoints: ['src/index.ts'],
+    bundle: true,
+    minify: false,
+    external: [
+        ...EXTERNALS_NODE,
+        'typescript',
+        '@deepkit/type-compiler',
+        'esbuild',
+        // '@gjsify/resolve-npm', can't be required in cjs builds
+        '@gjsify/esbuild-plugin-deno-loader',
+        '@gjsify/esbuild-plugin-deepkit',
+        '@gjsify/esbuild-plugin-gjsify',
+    ]
+}
+
+if (pkg.main) {
+    build({
+        ...baseConfig,
+        outdir: dirname(pkg.main),
+        format: 'cjs',
+        outExtension: {'.js': extname(pkg.main)},
+        platform: "node",
+    });    
+}
+
+if (pkg.module) {
+    build({
+        ...baseConfig,
+        outdir: dirname(pkg.module),
+        format: 'esm',
+        outExtension: {'.js': extname(pkg.module)},
+    });
+}

package/example/dist/index.js

@@ -0,0 +1,4 @@
+import { a } from "./a.js";
+import { b } from "./b.js";
+a();
+b();

package/example/esbuild.mjs

@@ -0,0 +1,12 @@
+// Run this with `node esbuild.mjs`
+
+import esbuild from 'esbuild';
+import { transformExtPlugin } from "@gjsify/esbuild-plugin-transform-ext";
+
+await esbuild.build({
+  plugins: [transformExtPlugin({ outExtension: {'.ts': '.js'}})],
+  entryPoints: ["./src/index.ts"],
+  outdir: "./dist/",
+  bundle: false,
+  format: "esm",
+});

package/example/src/a.ts

@@ -0,0 +1,3 @@
+export const a = () => {
+    console.log("a")
+}

package/example/src/b.ts

@@ -0,0 +1,3 @@
+export const b = () => {
+    console.log("b")
+}

package/example/src/index.ts

@@ -0,0 +1,4 @@
+import { a } from './a.ts';
+import { b } from './b.ts';
+a();
+b();

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@gjsify/esbuild-plugin-transform-ext",
+  "version": "0.0.2",
+  "description": "Transform import file extensions plugin for esbuild",
+  "type": "module",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.mjs",
+  "types": "dist/types/index.d.ts",
+  "scripts": {
+    "clear": "rm -rf dist tsconfig.tsbuildinfo",
+    "print:name": "echo '@gjsify/esbuild-plugin-transform-ext'",
+    "build": "yarn print:name && yarn build:js && yarn build:types",
+    "build:js": "node esbuild.mjs",
+    "build:types": "tsc --emitDeclarationOnly"
+  },
+  "keywords": [
+    "gjs",
+    "gjsify",
+    "esbuild"
+  ],
+  "peerDependencies": {
+    "esbuild": "^0.17.19"
+  },
+  "devDependencies": {
+    "esbuild": "^0.18.2",
+    "typescript": "^5.1.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './types/index.js';
+export * from './plugin.js';

package/src/plugin.ts

@@ -0,0 +1,91 @@
+import { readFile } from 'fs/promises';
+
+import type { Plugin, OnLoadArgs, OnLoadResult } from "esbuild";
+import type { PluginOptions, Extension } from './types/index.js';
+
+const IMPORT_PATTERN = /(import|from) ("|')\..*\.(js|ts|mjs|cjs|mts|cts)("|')/gm;
+const TS_EXT_PATTERN = /\.(ts|mts|cts|tsx)/;
+const JS_EXT_PATTERN = /\.(js|mjs|cjs|jsx)/;
+const DEFAULT_EXTENSIONS: Extension = {'.js': '.js', '.ts': '.js', '.mts': '.js', '.cts': '.js', '.cjs': '.js', '.mjs': '.js'};
+
+/**
+ * You can use this method to transform the imports of a file by yourself without the need of the esbuild plugin
+ * @param path The file path you want to transform 
+ * @param outExtension The extension map you want to transform
+ * @param options 
+ * @returns The transformed file content
+ */
+export const transformImports = async (path: string, outExtension: Extension = {}, verbose = false) => {
+
+  let changed = false;
+
+  let contents = await readFile(path, 'utf8');
+
+  if(Object.keys(outExtension).length <= 0) {
+    outExtension = DEFAULT_EXTENSIONS;
+  }
+
+  const matches =  Array.from(contents.matchAll(IMPORT_PATTERN));
+
+  for (const match of matches) {
+    const importStr = match[0];
+    let transformed = importStr;
+    for (const ext of Object.keys(outExtension)) {
+      transformed = transformed.replaceAll(ext, outExtension[ext])
+    }
+
+    if(importStr === transformed) {
+      continue
+    }
+
+    changed = true;
+
+    contents = contents.replace(importStr, transformed)
+    if(verbose) {
+      console.debug(`[transform-ext] ${importStr} -> ${transformed}`);
+    }
+  }
+
+  if(changed && verbose) {
+    console.debug(`[transform-ext] in ${path}\n`);
+  }
+  
+  return contents
+}
+
+export const transformExtPlugin = (pluginOptions: PluginOptions) => {
+    const plugin: Plugin = {
+        name: 'transform-ext',
+        async setup(build) {
+
+          const outExtension: {[ext: string]: string;} = {};
+
+          if(pluginOptions.outExtension) {
+            Object.assign(outExtension, pluginOptions.outExtension)
+          } else if(build.initialOptions.outExtension) {
+            Object.assign(outExtension, build.initialOptions.outExtension)
+          } else {
+            Object.assign(outExtension, DEFAULT_EXTENSIONS)
+          }
+
+          const onLoad = async (loader: 'js'|'ts', args: OnLoadArgs): Promise<OnLoadResult | null | undefined> => {
+            let contents: string;
+        
+            try {
+              contents = await transformImports(args.path, outExtension, pluginOptions.verbose)
+            } catch (error) {
+              console.error(error);
+              return null;
+            }
+            
+            return { contents, loader };
+          }
+
+          build.onLoad({filter: TS_EXT_PATTERN}, onLoad.bind(this, 'ts'));
+          build.onLoad({filter: JS_EXT_PATTERN}, onLoad.bind(this, 'js'));
+        }
+    }
+    return plugin;
+};
+
+export default transformExtPlugin;

package/src/types/extension.ts

@@ -0,0 +1 @@
+export type Extension = { [ext: string]: string }

package/src/types/index.ts

@@ -0,0 +1,2 @@
+export * from './extension.js'
+export * from './plugin-options.js'

package/src/types/plugin-options.ts

@@ -0,0 +1,6 @@
+import type { Extension } from './extension.js';
+
+export interface PluginOptions {
+    outExtension?: Extension;
+    verbose?: boolean;
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "module": "ESNext",
+    "target": "ESNext",
+    "outDir": "dist",
+    "types": ["node"],
+    "declarationDir": "dist/types",
+    "declaration": true,
+    "allowSyntheticDefaultImports": true,
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true
+  },
+  "files": ["src/index.ts"]
+}