@poppinss/ts-exec 1.4.3 → 1.5.0

package/README.md

@@ -189,6 +189,22 @@ If you have `rewriteRelativeImportExtensions` enabled in your TypeScript configu
 
 <br />
 
+### Files loaded using `require`
+
+TypeScript files loaded using `require` (for example, via `createRequire`) are also compiled by `ts-exec`, so enums and decorators work inside them. The same file resolution rules apply to them as well. You must enable the `rewriteRelativeImportExtensions` compiler option to require a file using its TypeScript extension.
+
+```ts
+import { createRequire } from 'node:module'
+const require = createRequire(import.meta.url)
+
+// Needs "rewriteRelativeImportExtensions"
+const { Role } = require('./role.cts')
+```
+
+The `.jsx` and `.tsx` files are always compiled as ES modules, including when they are loaded using `require`. Therefore, they cannot use `module.exports` or other CommonJS globals.
+
+<br />
+
 ## 🤔 Why not tsx?
 
 If you're currently using `tsx`, you might wonder why to switch. The answer depends on your priorities.

package/build/index.js

@@ -1,4 +1,230 @@
 // index.ts
-import { register } from "module";
+import { registerHooks } from "module";
+
+// src/loader.ts
+import { extname } from "path";
+import { fileURLToPath as fileURLToPath2 } from "url";
+
+// src/debug.ts
+import { debuglog } from "util";
+var debug_default = debuglog("ts-exec");
+
+// src/get_config.ts
+import { fileURLToPath } from "url";
+import { getTsconfig } from "get-tsconfig";
+var DEFAULT_CONFIG = {
+  sourceMaps: true,
+  module: {
+    type: "es6"
+  },
+  jsc: {
+    target: "esnext",
+    externalHelpers: false,
+    parser: {
+      syntax: "typescript",
+      tsx: true,
+      decorators: true,
+      dynamicImport: true
+    },
+    transform: {
+      decoratorMetadata: true,
+      legacyDecorator: true,
+      verbatimModuleSyntax: true,
+      useDefineForClassFields: true,
+      react: {
+        runtime: "automatic"
+      }
+    },
+    experimental: {
+      keepImportAttributes: true
+    },
+    keepClassNames: true
+  }
+};
+function tsConfigToSwcConfig(tsConfig2) {
+  const tsTarget = tsConfig2.compilerOptions?.target?.toLowerCase();
+  return {
+    sourceMaps: tsConfig2.compilerOptions?.sourceMap ?? true,
+    module: {
+      /**
+       * Since, we will run the SWC transformer via Nodejs loader hooks, the
+       * entry point will always be ES6
+       */
+      type: "es6"
+    },
+    jsc: {
+      target: tsTarget ? tsTarget === "es6" ? "esnext" : tsTarget : "esnext",
+      baseUrl: tsConfig2.compilerOptions?.baseUrl,
+      externalHelpers: false,
+      parser: {
+        syntax: "typescript",
+        tsx: !!tsConfig2.compilerOptions?.jsx,
+        decorators: true,
+        dynamicImport: true
+      },
+      transform: {
+        ...tsConfig2.compilerOptions?.emitDecoratorMetadata ? {
+          decoratorMetadata: true
+        } : {},
+        ...tsConfig2.compilerOptions?.experimentalDecorators ? {
+          legacyDecorator: true
+        } : {},
+        ...tsConfig2.compilerOptions?.verbatimModuleSyntax ? {
+          verbatimModuleSyntax: true
+        } : {},
+        ...tsConfig2.compilerOptions?.useDefineForClassFields ? {
+          useDefineForClassFields: true
+        } : {},
+        react: {
+          runtime: "automatic",
+          ...tsConfig2.compilerOptions?.jsxImportSource ? {
+            importSource: tsConfig2.compilerOptions?.jsxImportSource
+          } : {}
+        }
+      },
+      experimental: {
+        keepImportAttributes: true
+      },
+      keepClassNames: true
+    }
+  };
+}
+function getConfig(searchPath) {
+  const tsConfig2 = getTsconfig(
+    typeof searchPath === "string" ? searchPath : fileURLToPath(searchPath)
+  );
+  if (!tsConfig2) {
+    debug_default("Unable to locate tsconfig file");
+    return {
+      tsConfig: null,
+      tsConfigPath: null,
+      swcConfig: {
+        ...DEFAULT_CONFIG
+      }
+    };
+  }
+  debug_default("tsConfig %O", tsConfig2.config);
+  const swcConfig2 = tsConfigToSwcConfig(tsConfig2.config);
+  debug_default("swcConfig %O", swcConfig2);
+  return { tsConfig: tsConfig2.config, tsConfigPath: tsConfig2.path, swcConfig: swcConfig2 };
+}
+
+// src/transform.ts
+import { transformSync as swcTransformSync } from "@swc/core";
+function transformSync(source, options) {
+  const input = `${source ?? ""}`;
+  const { format, ...rest } = options;
+  rest.module.type = format === "commonjs-typescript" ? "commonjs" : "es6";
+  return swcTransformSync(input, rest);
+}
+
+// src/loader.ts
+var swcConfig;
+var tsConfig;
+function isTypeScriptFile(filePath) {
+  return !filePath.endsWith(".d.ts") && (filePath.endsWith(".ts") || filePath.endsWith(".tsx") || filePath.endsWith(".mts") || filePath.endsWith(".cts"));
+}
+function isLocalPath(specifier) {
+  return specifier.startsWith("./") || specifier.startsWith("../") || specifier.startsWith("/") || specifier.startsWith("file:");
+}
+function wrapAndReThrowSwcError(error) {
+  const errorHints = `${error.filename}:${error.startLine}
+${error.snippet}
+`;
+  switch (error.code) {
+    case "UnsupportedSyntax": {
+      const unsupportedSyntaxError = new Error(error.message);
+      unsupportedSyntaxError.name = "UnsupportedSyntaxError";
+      unsupportedSyntaxError.stack = `${errorHints}${unsupportedSyntaxError.stack}`;
+      throw unsupportedSyntaxError;
+    }
+    case "InvalidSyntax": {
+      const syntaxError = new SyntaxError(error.message);
+      syntaxError.stack = `${errorHints}${syntaxError.stack}`;
+      throw syntaxError;
+    }
+    default:
+      throw new Error(error.message);
+  }
+}
+function initialize() {
+  const searchPath = process.env.TS_EXEC_PWD ?? process.cwd();
+  const config = getConfig(searchPath);
+  swcConfig = config.swcConfig;
+  tsConfig = config.tsConfig;
+}
+var resolve = (specifier, context, nextResolve) => {
+  debug_default("resolving specifier %s", specifier);
+  const [pathname] = specifier.split("?");
+  if (!tsConfig?.compilerOptions?.rewriteRelativeImportExtensions && context.parentURL && isTypeScriptFile(pathname)) {
+    throw new Error(
+      `Cannot import "${specifier}" using "${extname(pathname)}" extension. Enable "compilerOptions.rewriteRelativeImportExtensions" to import TypeScript files`
+    );
+  }
+  try {
+    return nextResolve(specifier, context);
+  } catch (error) {
+    if (error.code === "ERR_MODULE_NOT_FOUND" && error.url && isLocalPath(error.url)) {
+      let [urlPathname, ...urlQs] = error.url.split("?");
+      const fileExtension = extname(urlPathname);
+      const testExtensions = [];
+      if ([".js", ".mjs", ".cjs", ".jsx"].includes(fileExtension)) {
+        testExtensions.push(fileExtension.replace("js", "ts"));
+      }
+      if (fileExtension === ".js") {
+        testExtensions.push(".tsx");
+      }
+      for (const ext of testExtensions) {
+        const tryPath = urlPathname.slice(0, -fileExtension.length) + ext;
+        try {
+          const url = urlQs.length ? `${tryPath}?${urlQs.join("?")}` : tryPath;
+          debug_default("retrying to resolve file with specifier %s", url);
+          return nextResolve(url, context);
+        } catch {
+        }
+      }
+    }
+    throw error;
+  }
+};
+var load = function load2(url, context, nextLoad) {
+  const { format } = context;
+  debug_default("load file %s, %O", url, context);
+  if (format && (format === "module-typescript" || format === "commonjs-typescript") || url.endsWith(".tsx") || url.endsWith(".jsx")) {
+    try {
+      const { source } = nextLoad(url, {
+        ...context,
+        format: "module"
+      });
+      const { code, map } = transformSync(source.toString(), {
+        format: format ?? "module-tsx",
+        filename: fileURLToPath2(url),
+        ...swcConfig
+      });
+      let output = code;
+      if (map) {
+        const base64SourceMap = Buffer.from(map).toString("base64");
+        output = `${code}
+
+//# sourceMappingURL=data:application/json;base64,${base64SourceMap}`;
+      }
+      return {
+        format: format ? format.replace("-typescript", "") : "module",
+        source: `${output}
+
+//# sourceURL=${url}`
+      };
+    } catch (error) {
+      if (error.code !== void 0) {
+        wrapAndReThrowSwcError(error);
+      }
+      throw error;
+    }
+  }
+  return nextLoad(url, context);
+};
+
+// index.ts
 process.setSourceMapsEnabled(true);
-register("./src/loader.js", import.meta.url);
+initialize();
+registerHooks({ resolve, load });

package/build/src/debug.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("util").DebugLogger;
+declare const _default: import("node:util").DebugLogger;
 export default _default;

package/build/src/loader.d.ts

@@ -1,8 +1,9 @@
-import type { LoadHook, ResolveHook } from 'node:module';
+import type { LoadHookSync, ResolveHookSync } from 'node:module';
 /**
- * Initialize hook to load different config files
+ * Loads the tsconfig file and computes the SWC config. Must be called
+ * before registering the hooks
  */
-export declare function initialize(): Promise<void>;
+export declare function initialize(): void;
 /**
  * Resolve hook to rewrite ".js" imports to ".ts" file only when
  * "allowArbitraryExtensions" is not enabled. Otherwise, we expect
@@ -13,8 +14,11 @@ export declare function initialize(): Promise<void>;
  * For example, someone registers a loader to import files from Github and
  * our extension rewrite checks for same file on disk, hence it will fail.
  */
-export declare const resolve: ResolveHook;
+export declare const resolve: ResolveHookSync;
 /**
- * Load hook to compile TypeScript and JSX files on the fly
+ * Load hook to compile TypeScript and JSX files on the fly.
+ *
+ * Node.js does not report a format for ".jsx" and ".tsx" files, hence
+ * they are always compiled as ES modules, even when loaded via "require".
  */
-export declare const load: LoadHook;
+export declare const load: LoadHookSync;

package/build/src/transform.d.ts

@@ -5,4 +5,4 @@ import { type Config as SwcConfig } from '@swc/core';
 export declare function transformSync(source: string, options: SwcConfig & {
     filename: string;
     format: 'module-typescript' | 'commonjs-typescript' | 'module-tsx';
-}): Promise<import("@swc/types").Output>;
+}): import("@swc/types").Output;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@poppinss/ts-exec",
   "description": "TypeScript JIT compiler built for correctness and supports legacy/experimental decorators",
-  "version": "1.4.3",
+  "version": "1.5.0",
   "engines": {
     "node": ">=24.0.0"
   },
@@ -27,33 +27,33 @@
     "version": "npm run build",
     "prepublishOnly": "npm run build",
     "release": "release-it",
-    "quick:test": "node --experimental-transform-types --enable-source-maps bin/test.ts"
+    "quick:test": "node --enable-source-maps bin/test.ts"
   },
   "devDependencies": {
-    "@adonisjs/eslint-config": "^3.0.0-next.0",
-    "@adonisjs/prettier-config": "^1.4.5",
-    "@adonisjs/tsconfig": "^2.0.0-next.0",
-    "@japa/assert": "^4.1.1",
-    "@japa/expect": "^3.0.6",
-    "@japa/expect-type": "^2.0.3",
-    "@japa/file-system": "^2.3.2",
-    "@japa/runner": "^4.4.0",
-    "@japa/snapshot": "^2.0.9",
-    "@release-it/conventional-changelog": "^10.0.2",
-    "@types/node": "^24.10.1",
-    "c8": "^10.1.3",
-    "eslint": "^9.39.1",
-    "ipaddr.js": "^2.3.0",
-    "preact": "^10.28.0",
-    "preact-render-to-string": "^6.6.3",
-    "prettier": "^3.7.4",
-    "release-it": "^19.0.6",
+    "@adonisjs/eslint-config": "^3.1.0",
+    "@adonisjs/prettier-config": "^1.5.0",
+    "@adonisjs/tsconfig": "^2.0.0",
+    "@japa/assert": "^4.2.0",
+    "@japa/expect": "^3.0.7",
+    "@japa/expect-type": "^2.0.4",
+    "@japa/file-system": "^3.0.0",
+    "@japa/runner": "^5.3.0",
+    "@japa/snapshot": "^2.0.10",
+    "@release-it/conventional-changelog": "^12.0.2",
+    "@types/node": "^26.6.4",
+    "c8": "^12.0.0",
+    "eslint": "^10.12.0",
+    "ipaddr.js": "^2.5.0",
+    "preact": "^11.0.0",
+    "preact-render-to-string": "^6.8.0",
+    "prettier": "^3.9.9",
+    "release-it": "^21.1.1",
     "tsup": "^8.5.1",
-    "typescript": "^5.9.3"
+    "typescript": "^6.0.3"
   },
   "dependencies": {
-    "@swc/core": "1.15.3",
-    "get-tsconfig": "^4.13.0"
+    "@swc/core": "~1.16.13",
+    "get-tsconfig": "^4.14.3"
   },
   "homepage": "https://github.com/poppinss/ts-exec#readme",
   "repository": {
@@ -77,8 +77,7 @@
   },
   "tsup": {
     "entry": [
-      "index.ts",
-      "src/loader.ts"
+      "index.ts"
     ],
     "outDir": "./build",
     "clean": true,

package/build/src/loader.js

@@ -1,223 +0,0 @@
-// src/loader.ts
-import { extname } from "path";
-import { fileURLToPath as fileURLToPath2 } from "url";
-
-// src/debug.ts
-import { debuglog } from "util";
-var debug_default = debuglog("ts-exec");
-
-// src/get_config.ts
-import { fileURLToPath } from "url";
-import { getTsconfig } from "get-tsconfig";
-var DEFAULT_CONFIG = {
-  sourceMaps: true,
-  module: {
-    type: "es6"
-  },
-  jsc: {
-    target: "esnext",
-    externalHelpers: false,
-    parser: {
-      syntax: "typescript",
-      tsx: true,
-      decorators: true,
-      dynamicImport: true
-    },
-    transform: {
-      decoratorMetadata: true,
-      legacyDecorator: true,
-      verbatimModuleSyntax: true,
-      useDefineForClassFields: true,
-      react: {
-        runtime: "automatic"
-      }
-    },
-    experimental: {
-      keepImportAttributes: true
-    },
-    keepClassNames: true
-  }
-};
-function tsConfigToSwcConfig(tsConfig2) {
-  const tsTarget = tsConfig2.compilerOptions?.target?.toLowerCase();
-  return {
-    sourceMaps: tsConfig2.compilerOptions?.sourceMap ?? true,
-    module: {
-      /**
-       * Since, we will run the SWC transformer via Nodejs loader hooks, the
-       * entry point will always be ES6
-       */
-      type: "es6"
-    },
-    jsc: {
-      target: tsTarget ? tsTarget === "es6" ? "esnext" : tsTarget : "esnext",
-      baseUrl: tsConfig2.compilerOptions?.baseUrl,
-      externalHelpers: false,
-      parser: {
-        syntax: "typescript",
-        tsx: !!tsConfig2.compilerOptions?.jsx,
-        decorators: true,
-        dynamicImport: true
-      },
-      transform: {
-        ...tsConfig2.compilerOptions?.emitDecoratorMetadata ? {
-          decoratorMetadata: true
-        } : {},
-        ...tsConfig2.compilerOptions?.experimentalDecorators ? {
-          legacyDecorator: true
-        } : {},
-        ...tsConfig2.compilerOptions?.verbatimModuleSyntax ? {
-          verbatimModuleSyntax: true
-        } : {},
-        ...tsConfig2.compilerOptions?.useDefineForClassFields ? {
-          useDefineForClassFields: true
-        } : {},
-        react: {
-          runtime: "automatic",
-          ...tsConfig2.compilerOptions?.jsxImportSource ? {
-            importSource: tsConfig2.compilerOptions?.jsxImportSource
-          } : {}
-        }
-      },
-      experimental: {
-        keepImportAttributes: true
-      },
-      keepClassNames: true
-    }
-  };
-}
-function getConfig(searchPath) {
-  const tsConfig2 = getTsconfig(
-    typeof searchPath === "string" ? searchPath : fileURLToPath(searchPath)
-  );
-  if (!tsConfig2) {
-    debug_default("Unable to locate tsconfig file");
-    return {
-      tsConfig: null,
-      tsConfigPath: null,
-      swcConfig: {
-        ...DEFAULT_CONFIG
-      }
-    };
-  }
-  debug_default("tsConfig %O", tsConfig2.config);
-  const swcConfig2 = tsConfigToSwcConfig(tsConfig2.config);
-  debug_default("swcConfig %O", swcConfig2);
-  return { tsConfig: tsConfig2.config, tsConfigPath: tsConfig2.path, swcConfig: swcConfig2 };
-}
-
-// src/transform.ts
-import { transform as swcTransform } from "@swc/core";
-function transformSync(source, options) {
-  const input = `${source ?? ""}`;
-  const { format, ...rest } = options;
-  rest.module.type = format === "commonjs-typescript" ? "commonjs" : "es6";
-  return swcTransform(input, rest);
-}
-
-// src/loader.ts
-var swcConfig;
-var tsConfig;
-function isTypeScriptFile(filePath) {
-  return !filePath.endsWith(".d.ts") && (filePath.endsWith(".ts") || filePath.endsWith(".tsx") || filePath.endsWith(".mts") || filePath.endsWith(".cts"));
-}
-function isLocalPath(specifier) {
-  return specifier.startsWith("./") || specifier.startsWith("../") || specifier.startsWith("/") || specifier.startsWith("file:");
-}
-function wrapAndReThrowSwcError(error) {
-  const errorHints = `${error.filename}:${error.startLine}
-${error.snippet}
-`;
-  switch (error.code) {
-    case "UnsupportedSyntax": {
-      const unsupportedSyntaxError = new Error(error.message);
-      unsupportedSyntaxError.name = "UnsupportedSyntaxError";
-      unsupportedSyntaxError.stack = `${errorHints}${unsupportedSyntaxError.stack}`;
-      throw unsupportedSyntaxError;
-    }
-    case "InvalidSyntax": {
-      const syntaxError = new SyntaxError(error.message);
-      syntaxError.stack = `${errorHints}${syntaxError.stack}`;
-      throw syntaxError;
-    }
-    default:
-      throw new Error(error.message);
-  }
-}
-async function initialize() {
-  const searchPath = process.env.TS_EXEC_PWD ?? process.cwd();
-  const config = getConfig(searchPath);
-  swcConfig = config.swcConfig;
-  tsConfig = config.tsConfig;
-}
-var resolve = async (specifier, context, nextResolve) => {
-  debug_default("resolving specifier %s", specifier);
-  const [pathname] = specifier.split("?");
-  if (!tsConfig?.compilerOptions?.rewriteRelativeImportExtensions && context.parentURL && isTypeScriptFile(pathname)) {
-    throw new Error(
-      `Cannot import "${specifier}" using "${extname(pathname)}" extension. Enable "compilerOptions.rewriteRelativeImportExtensions" to import TypeScript files`
-    );
-  }
-  try {
-    return await nextResolve(specifier, context);
-  } catch (error) {
-    if (error.code === "ERR_MODULE_NOT_FOUND" && error.url && isLocalPath(error.url)) {
-      let [urlPathname, ...urlQs] = error.url.split("?");
-      const fileExtension = extname(urlPathname);
-      if (fileExtension === ".js") {
-        urlPathname = urlPathname.replace(".js", ".ts");
-      } else if (fileExtension === ".mjs") {
-        urlPathname = urlPathname.replace(".mjs", ".mts");
-      } else if (fileExtension === ".cjs") {
-        urlPathname = urlPathname.replace(".cjs", ".cts");
-      } else if (fileExtension === ".jsx") {
-        urlPathname = urlPathname.replace(".jsx", ".tsx");
-      }
-      const url = urlQs.length ? `${urlPathname}?${urlQs.join("?")}` : urlPathname;
-      debug_default("retrying to resolve file with specifier %s", url);
-      return nextResolve(url, context);
-    }
-    throw error;
-  }
-};
-var load = async function load2(url, context, nextLoad) {
-  const { format } = context;
-  debug_default("load file %s, %O", url, context);
-  if (format && (format === "module-typescript" || format === "commonjs-typescript") || url.endsWith(".tsx") || url.endsWith(".jsx")) {
-    try {
-      const { source } = await nextLoad(url, {
-        ...context,
-        format: "module"
-      });
-      const { code, map } = await transformSync(source.toString(), {
-        format: format ?? "module-tsx",
-        filename: fileURLToPath2(url),
-        ...swcConfig
-      });
-      let output = code;
-      if (map) {
-        const base64SourceMap = Buffer.from(map).toString("base64");
-        output = `${code}
-
-//# sourceMappingURL=data:application/json;base64,${base64SourceMap}`;
-      }
-      return {
-        format: format ? format.replace("-typescript", "") : "module",
-        source: `${output}
-
-//# sourceURL=${url}`
-      };
-    } catch (error) {
-      if (error.code !== void 0) {
-        wrapAndReThrowSwcError(error);
-      }
-      throw error;
-    }
-  }
-  return nextLoad(url, context);
-};
-export {
-  initialize,
-  load,
-  resolve
-};