在 JavaScript 项目中运行 TypeScript 子进程的实用指南

本文详细介绍了在 javascript（如 electron）应用中以子进程方式运行 typescript 项目（如 express 服务器）时遇到的 `err_unknown_file_extension` 错误，并提供了通过 `node` 命令结合 `ts-node/esm` 加载器和 `experimental-specifier-resolution` 标志来直接执行 typescript 文件的解决方案，确保父子进程间的平滑集成。

引言：JavaScript 应用中运行 TypeScript 子进程的挑战

在现代应用开发中，将不同技术栈的模块集成在一起是常见的需求。例如，一个基于 JavaScript 的 Electron 桌面应用可能需要启动一个用 TypeScript 编写的 Express 后端服务作为其子进程。然而，直接尝试使用 node 命令运行 .ts 文件时，通常会遇到 TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".ts" 错误。这是因为 Node.js 运行时默认不识别 .ts 文件类型，它期望执行的是标准的 JavaScript 文件。

理解错误根源：Node.js 对 TypeScript 的原生支持

Node.js 引擎设计用于执行 JavaScript 代码。当它遇到一个 .ts 文件时，它不知道如何解析其中的类型注解和非标准 JavaScript 语法，因此会抛出“未知文件扩展名”的错误。要解决这个问题，我们需要在 Node.js 执行 TypeScript 文件之前，将其转换（转译）为 JavaScript。这可以通过两种主要方式实现：

1. 预编译： 在运行之前，使用 TypeScript 编译器（tsc）将所有 .ts 文件编译成 .js 文件，然后运行这些编译后的 .js 文件。
2. 运行时转译： 使用像 ts-node 这样的工具，它能在 Node.js 运行时环境中动态地转译 TypeScript 代码，使其可以直接被 Node.js 执行。

在子进程场景中，尤其是不希望引入额外构建步骤或需要快速迭代时，运行时转译是一个非常便捷的方案。

解决方案核心：利用 ts-node 作为运行时加载器

解决上述问题的关键在于，在启动 TypeScript 子进程时，明确告知 Node.js 如何处理 .ts 文件。ts-node 提供了一个 --loader 选项，允许 Node.js 在加载模块时使用 ts-node 进行转译。

立即学习“Java免费学习笔记（深入）”；

具体来说，我们需要在 node 命令中加入以下参数：

• --loader ts-node/esm：启用 ts-node 作为 ES 模块加载器。这使得 Node.js 能够识别和转译 .ts 文件，特别是当项目使用 ES 模块语法（import/export）时。
• --experimental-specifier-resolution=node：这是一个实验性标志，用于改进 Node.js 在解析模块路径时的行为，使其更符合传统的 Node.js 模块解析逻辑，这对于处理 TypeScript 项目中的模块导入非常有用。

实现步骤：配置 Electron 应用的子进程启动

以下是如何在 Electron 应用的 electron.js 文件中启动一个 TypeScript Express 服务器子进程的示例：

const { spawn } = require("child_process");
const path = require("path");

// 假设你的 TypeScript Express 项目位于 Electron 项目的同级目录或指定路径
// 例如：D:/expressproject/src/server.ts 或 ./expressproject/src/server.ts
// 确保 pathToExpressServerTS 指向你的 TypeScript Express 服务器的入口文件（例如 server.ts）
const pathToExpressServerTS = path.join(__dirname, '..', 'expressproject', 'src', 'server.ts');

function startExpressServer() {
  const command = "node"; // 启动 Node.js 进程
  const args = [
    "--loader", // 指定自定义加载器
    "ts-node/esm", // 使用 ts-node 作为 ES 模块加载器
    "--experimental-specifier-resolution=node", // 启用实验性模块解析
    pathToExpressServerTS, // TypeScript Express 服务器的入口文件路径
  ];

  // 启动子进程
  const expressProcess = spawn(command, args, {
    // shell: true 可以在某些系统上帮助找到 node 命令，但通常不是必需的
    // stdio: "ignore" 忽略子进程的 stdin/stdout/stderr，避免输出干扰主进程
    // 也可以设置为 "inherit" 来让子进程的输出直接显示在父进程的控制台
    // 或者设置为 ['pipe', 'pipe', 'pipe'] 来捕获子进程的输出
    stdio: "inherit",
    cwd: path.dirname(pathToExpressServerTS) // 将工作目录设置为 Express 项目根目录，确保相对路径解析正确
  });

  // 监听子进程的输出（如果 stdio 不为 "ignore"）
  expressProcess.stdout.on('data', (data) => {
    console.log(`Express stdout: ${data}`);
  });

  expressProcess.stderr.on('data', (data) => {
    console.error(`Express stderr: ${data}`);
  });

  // 监听子进程关闭事件
  expressProcess.on("close", (code) => {
    console.log(`Express server process exited with code ${code}`);
    // 根据需要处理子进程意外关闭的情况
  });

  // 监听子进程错误事件
  expressProcess.on("error", (err) => {
    console.error("Failed to start Express server process:", err);
  });
}

// 在 Electron 应用启动时调用
function createWindow() {
  // ... Electron 窗口创建逻辑
}

// Electron ready 事件
app.whenReady().then(() => {
  startExpressServer(); // 在 Electron 窗口创建前或后启动服务器
  createWindow();
});

// ... 其他 Electron 生命周期事件

代码解释：

一览运营宝

一览“运营宝”是一款搭载AIGC的视频创作赋能及变现工具，由深耕视频行业18年的一览科技研发推出。

41

查看详情

• command: "node"：指定要执行的命令是 Node.js 运行时。
• args: 这是一个数组，包含了传递给 node 命令的所有参数。
  • "--loader", "ts-node/esm"：这是核心，它告诉 Node.js 使用 ts-node 作为模块加载器，并且以 ES 模块模式运行。
  • "--experimental-specifier-resolution=node"：辅助模块解析，确保 TypeScript 项目中的导入路径能够正确解析。
  • pathToExpressServerTS：这是你 TypeScript Express 服务器的入口文件路径。请确保这个路径是准确的，并且是 .ts 文件。
• options 对象：
  • stdio: "inherit"：将子进程的标准输入、输出和错误流连接到父进程，方便调试。在生产环境中，你可能希望根据需求设置为 "ignore" 或捕获到日志文件。
  • cwd: path.dirname(pathToExpressServerTS): 设置子进程的工作目录。这对于确保子进程内部的相对路径（如配置文件、静态资源等）能够正确解析至关重要。
  • shell: true: （可选）在某些操作系统上，如果 node 命令不在系统的 PATH 中，或者需要执行更复杂的 shell 命令时，设置 shell: true 会有所帮助。但对于简单的 node 命令，通常不需要。

关键注意事项与最佳实践

1. ts-node 依赖：

   • 确保你的 TypeScript Express 项目（即子进程项目）在其 package.json 中安装了 ts-node 和 typescript 作为开发依赖。
   • npm install --save-dev ts-node typescript
   • 虽然 ts-node 在父进程中被引用，但实际是在子进程的环境中运行，所以它必须存在于子进程可访问的 node_modules 中。

2. 生产环境考量：预编译 vs. 运行时编译：

   • 运行时编译 (ts-node) 方便开发和调试，但每次启动子进程都需要进行转译，这会带来一定的性能开销。
   • 预编译 是生产环境的推荐做法。在部署之前，先使用 tsc 命令将 TypeScript 项目编译成纯 JavaScript 文件，然后子进程直接运行这些编译后的 .js 文件。
     • 在 TypeScript 项目的 package.json 中添加一个 build 脚本："build": "tsc -p tsconfig.json"。
     • 在 Electron 应用中，启动子进程时，执行编译后的入口文件（例如 dist/server.js），而不是原始的 src/server.ts。
     • 此时，spawn 命令将变为 spawn("node", [pathToCompiledServerJS])，无需 ts-node 加载器。

3. 路径解析：

   • pathToExpressServerTS 必须是正确的绝对路径或相对于 Electron 应用执行位置的相对路径。
   • 使用 path.join(__dirname, ...) 是构建跨平台兼容路径的推荐方式。
   • cwd 选项对于子进程内部的相对路径解析至关重要。

4. 错误处理与日志：

   • 始终为子进程添加 close 和 error 事件监听，以便及时发现并处理子进程的异常退出或启动失败。
   • 合理配置 stdio 选项，以便在开发和生产环境中获取必要的日志输出。

5. TypeScript 项目的 tsconfig.json：

   • 确保 TypeScript 项目的 tsconfig.json 配置正确，特别是 module 和 target 选项，它们会影响 ts-node 的转译行为。例如，如果使用 ES 模块，"module": "ESNext" 或 "ES2020" 是合适的。
   • ts-node 自身的配置也可以在 tsconfig.json 中指定，例如：

     {
       "compilerOptions": { /* ... */ },
       "ts-node": {
         "transpileOnly": true, // 仅转译，不进行类型检查，加快启动速度
         "esm": true // 明确启用 ES 模块模式
       }
     }

     登录后复制

总结

在 JavaScript 父进程中以子进程方式运行 TypeScript 项目，核心在于解决 Node.js 对 .ts 文件不识别的问题。通过利用 ts-node 作为运行时加载器，并配合 --loader ts-node/esm 和 --experimental-specifier-resolution=node 参数，我们可以直接执行 TypeScript 源码，极大地简化了开发流程。然而，在生产环境中，为了性能和稳定性，通常更推荐预编译 TypeScript 项目为 JavaScript 后再运行。理解这两种方法的优缺点并根据项目需求选择合适的策略，是成功集成不同技术栈的关键。

以上就是在 JavaScript 项目中运行 TypeScript 子进程的实用指南的详细内容，更多请关注php中文网其它相关文章！