@poppinss/ts-exec 1.1.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright (c) 2023
+
+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,32 @@
+# ts-exec
+
+<br />
+
+[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url]
+
+## Introduction
+
+## Official Documentation
+
+## Contributing
+
+One of the primary goals of <org> is to have a vibrant community of users and contributors who believes in the principles of the framework.
+
+We encourage you to read the [contribution guide](https://github.com/<org>/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework.
+
+## Code of Conduct
+
+In order to ensure that the <org> community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/<org>/.github/blob/main/docs/CODE_OF_CONDUCT.md).
+
+## License
+
+<pkg-name> is open-sourced software licensed under the [MIT license](LICENSE.md).
+
+[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/<org>/<repo>/checks.yml?style=for-the-badge
+[gh-workflow-url]: https://github.com/<org>/<repo>/actions/workflows/checks.yml 'Github action'
+[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
+[typescript-url]: "typescript"
+[npm-image]: https://img.shields.io/npm/v/<scope>/<repo>.svg?style=for-the-badge&logo=npm
+[npm-url]: https://npmjs.org/package/<scope>/<repo> 'npm'
+[license-image]: https://img.shields.io/npm/l/<scope>/<repo>?color=blueviolet&style=for-the-badge
+[license-url]: LICENSE.md 'license'

package/build/index.d.ts

@@ -0,0 +1 @@
+export {};

package/build/index.js

@@ -0,0 +1,3 @@
+// index.ts
+import { register } from "node:module";
+register("./src/loader.js", import.meta.url);

package/build/src/debug.d.ts

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

package/build/src/get_config.d.ts

@@ -0,0 +1,11 @@
+import type { Config as SWCConfig } from '@swc/core';
+import { type TsConfigJsonResolved } from 'get-tsconfig';
+/**
+ * Returns the TSConfig and the SWC config by searching for the "tsconfig.json"
+ * file in the provided search path
+ */
+export declare function getConfig(searchPath: string | URL): {
+    tsConfig: TsConfigJsonResolved | null;
+    tsConfigPath: string | null;
+    swcConfig: SWCConfig;
+};

package/build/src/get_package_json.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Returns the contents of the package.json file
+ */
+export declare function getPackageJson(searchPath: string | URL): Promise<any>;

package/build/src/loader.d.ts

@@ -0,0 +1,20 @@
+import type { LoadHook, ResolveHook } from 'node:module';
+/**
+ * Initialize hook to load different config files
+ */
+export declare function initialize(): Promise<void>;
+/**
+ * Resolve hook to rewrite ".js" imports to ".ts" file only when
+ * "allowArbitraryExtensions" is not enabled. Otherwise, we expect
+ * the user to always specify the accurate file extensions and we
+ * won't check for file existence on the disk, since that may
+ * lead to many false positives.
+ *
+ * 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;
+/**
+ * Load hook to compile TypeScript and JSX files on the fly
+ */
+export declare const load: LoadHook;

package/build/src/loader.js

@@ -0,0 +1,228 @@
+// src/loader.ts
+import { extname } from "node:path";
+import { fileURLToPath as fileURLToPath3 } from "node:url";
+import { resolveImports } from "resolve-pkg-maps";
+
+// src/debug.ts
+import { debuglog } from "node:util";
+var debug_default = debuglog("ts-exec");
+
+// src/get_config.ts
+import { fileURLToPath } from "node: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"
+      }
+    },
+    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: {
+        decoratorMetadata: tsConfig2.compilerOptions?.emitDecoratorMetadata,
+        legacyDecorator: tsConfig2.compilerOptions?.experimentalDecorators,
+        verbatimModuleSyntax: tsConfig2.compilerOptions?.verbatimModuleSyntax,
+        useDefineForClassFields: tsConfig2.compilerOptions?.useDefineForClassFields,
+        react: {
+          runtime: "automatic",
+          importSource: tsConfig2.compilerOptions?.jsxImportSource
+        }
+      },
+      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 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/get_package_json.ts
+import { join } from "node:path";
+import { fileURLToPath as fileURLToPath2 } from "node:url";
+import { readFile } from "node:fs/promises";
+async function getPackageJson(searchPath) {
+  try {
+    const pkgFile = await readFile(
+      join(typeof searchPath === "string" ? searchPath : fileURLToPath2(searchPath), "package.json"),
+      "utf-8"
+    );
+    return JSON.parse(pkgFile);
+  } catch (error) {
+    if (error.code === "ENOENT") {
+      return null;
+    }
+    throw error;
+  }
+}
+
+// src/loader.ts
+var swcConfig;
+var tsConfig;
+var subPathImports;
+var UNALLOWED_FILE_EXTENSIONS = [".tsx", ".ts", ".mts", ".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);
+  const pkgJSON = await getPackageJson(searchPath);
+  swcConfig = config.swcConfig;
+  tsConfig = config.tsConfig;
+  subPathImports = pkgJSON ? pkgJSON.imports : null;
+}
+var resolve = async (specifier, context, nextResolve) => {
+  debug_default("resolving specifier %s", specifier);
+  if (specifier.startsWith("#") && subPathImports) {
+    debug_default("resolving subpath import %s %O", specifier, subPathImports);
+    const resolvedPaths = resolveImports(subPathImports, specifier, context.conditions);
+    if (resolvedPaths.length) {
+      specifier = resolvedPaths[0];
+    }
+  }
+  const allowArbitraryExtensions = !!tsConfig?.compilerOptions?.allowArbitraryExtensions;
+  if (!allowArbitraryExtensions) {
+    if (isLocalPath(specifier)) {
+      const fileExtension = extname(specifier);
+      if (UNALLOWED_FILE_EXTENSIONS.includes(fileExtension) && context.parentURL) {
+        throw new Error(`Unknown file extension "${fileExtension}"`);
+      }
+      if (fileExtension === ".js") {
+        specifier = specifier.replace(".js", ".ts");
+      } else if (fileExtension === ".mjs") {
+        specifier = specifier.replace(".mjs", ".mts");
+      } else if (fileExtension === ".cjs") {
+        specifier = specifier.replace(".cjs", ".cts");
+      } else if (fileExtension === ".jsx") {
+        specifier = specifier.replace(".jsx", ".tsx");
+      }
+    }
+  }
+  debug_default("resolving file with specifier %s", specifier);
+  return nextResolve(specifier, context);
+};
+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 } = transformSync(source.toString(), {
+        format: format ?? "module-tsx",
+        filename: fileURLToPath3(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
+};

package/build/src/transform.d.ts

@@ -0,0 +1,8 @@
+import { Config as SwcConfig } from '@swc/core';
+/**
+ * Transforms source code using SWC
+ */
+export declare function transformSync(source: string, options: SwcConfig & {
+    filename: string;
+    format: 'module-typescript' | 'commonjs-typescript' | 'module-tsx';
+}): import("@swc/types").Output;

package/package.json

@@ -0,0 +1,127 @@
+{
+  "name": "@poppinss/ts-exec",
+  "description": "",
+  "version": "1.1.0",
+  "engines": {
+    "node": ">=20.6.0"
+  },
+  "type": "module",
+  "files": [
+    "build",
+    "!build/bin",
+    "!build/tests"
+  ],
+  "main": "build/index.js",
+  "exports": {
+    ".": "./build/index.js"
+  },
+  "scripts": {
+    "pretest": "npm run lint && npm run build",
+    "test": "c8 npm run quick:test",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "typecheck": "tsc --noEmit",
+    "precompile": "npm run lint",
+    "compile": "tsup-node && tsc --emitDeclarationOnly --declaration",
+    "build": "npm run compile",
+    "version": "npm run build",
+    "prepublishOnly": "npm run build",
+    "release": "release-it",
+    "quick:test": "node --experimental-transform-types --enable-source-maps bin/test.ts"
+  },
+  "devDependencies": {
+    "@adonisjs/eslint-config": "^2.0.0-beta.6",
+    "@adonisjs/prettier-config": "^1.4.0",
+    "@adonisjs/tsconfig": "^1.4.0",
+    "@japa/assert": "^4.0.0",
+    "@japa/expect": "^3.0.2",
+    "@japa/expect-type": "^2.0.2",
+    "@japa/file-system": "^2.3.2",
+    "@japa/runner": "^3.1.4",
+    "@japa/snapshot": "^2.0.8",
+    "@release-it/conventional-changelog": "^9.0.4",
+    "@types/node": "^22.10.2",
+    "c8": "^10.1.3",
+    "eslint": "^9.17.0",
+    "ipaddr.js": "^2.2.0",
+    "preact": "^10.26.6",
+    "preact-render-to-string": "^6.5.13",
+    "prettier": "^3.4.2",
+    "release-it": "^17.11.0",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2"
+  },
+  "dependencies": {
+    "@swc/core": "^1.11.24",
+    "get-tsconfig": "^4.10.0",
+    "resolve-pkg-maps": "^1.0.0"
+  },
+  "homepage": "https://github.com/thetutlage/ts-exec#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thetutlage/ts-exec.git"
+  },
+  "bugs": {
+    "url": "https://github.com/thetutlage/ts-exec/issues"
+  },
+  "keywords": [
+    "typescript",
+    "ts-node",
+    "transpiler",
+    "tsx"
+  ],
+  "author": "Harminder Virk <virk@adonisjs.com>",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "tsup": {
+    "entry": [
+      "index.ts",
+      "src/loader.ts"
+    ],
+    "outDir": "./build",
+    "clean": true,
+    "format": "esm",
+    "dts": false,
+    "sourcemap": false,
+    "target": "esnext"
+  },
+  "release-it": {
+    "git": {
+      "requireCleanWorkingDir": true,
+      "requireUpstream": true,
+      "commitMessage": "chore(release): ${version}",
+      "tagAnnotation": "v${version}",
+      "push": true,
+      "tagName": "v${version}"
+    },
+    "github": {
+      "release": true
+    },
+    "npm": {
+      "publish": true,
+      "skipChecks": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
+  },
+  "prettier": "@adonisjs/prettier-config",
+  "volta": {
+    "node": "24.0.0"
+  }
+}