使用 esm 时，带有 tsconfig-paths 的 ts-node 将不起作用

Question

我无法弄清楚为什么 ts-node 在启用 esm 时无法解析别名

我做了一个小项目试图尽可能地隔离问题

package.json

{
  "type": "module"
}

tsconfig.json

{
  "compilerOptions": {
    "module": "es2020",                                
    "baseUrl": "./",                                  
    "paths": {
      "$lib/*": [
        "src/lib/*"
      ]
    },
  },
  "ts-node": {
    "esm": true
  }
}

test.ts

import { testFn } from "$lib/module"

testFn()

lib/module.ts

export function testFn () {
  console.log("Test function")
}

命令

ts-node -r tsconfig-paths/register src/test.ts

这是一个最小的存储库

Answer 1

解决方案来自： https://github.com/TypeStrong/ts-node /discussions/1450#discussion-3563207

目前，ESM 加载器不处理 TypeScript 路径映射。为了使其工作，您可以使用以下自定义加载程序：

// loader.js
import {
  resolve as resolveTs,
  getFormat,
  transformSource,
  load,
} from "ts-node/esm";
import * as tsConfigPaths from "tsconfig-paths"

export { getFormat, transformSource, load };

const { absoluteBaseUrl, paths } = tsConfigPaths.loadConfig()
const matchPath = tsConfigPaths.createMatchPath(absoluteBaseUrl, paths)

export function resolve(specifier, context, defaultResolver) {
  const mappedSpecifier = matchPath(specifier)
  if (mappedSpecifier) {
    specifier = `${mappedSpecifier}.js`
  }
  return resolveTs(specifier, context, defaultResolver);
}

然后使用加载程序：
node --loader loader.js index.ts

注意：这仅适用于没有扩展名的模块说明符。例如， import /foo/bar 有效，但 import /foo/bar.js 和 import /foo/bar.ts 则无效。

请记住还要安装这些软件包：

"ts-node": "^10.9.1",
"tsconfig-paths": "^4.1.2",

更新：09/11/2023

新加载器将自动解析 index.(js|ts)：

import { resolve as resolveTs } from 'ts-node/esm'
import * as tsConfigPaths from 'tsconfig-paths'
import { pathToFileURL } from 'url'

const { absoluteBaseUrl, paths } = tsConfigPaths.loadConfig()
const matchPath = tsConfigPaths.createMatchPath(absoluteBaseUrl, paths)

export function resolve (specifier, ctx, defaultResolve) {
  const match = matchPath(specifier)
  return match
    ? resolveTs(pathToFileURL(`${match}`).href, ctx, defaultResolve)
    : resolveTs(specifier, ctx, defaultResolve)
}

export { load, transformSource } from 'ts-node/esm'

示例：

Path: /src/modules/order/index.ts
Resolve: import orderModule from '@/modules/order';

更新：11/04/2024

对于节点版本20、我们需要设置arg：--experimental-specifier-resolution=node

node --experimental-specifier-resolution=node --loader ./loader.js src/main.ts

Answer 2

我建议使用 esno esno src/test.ts

Answer 3

您可以使用 @bleed- believeer/path-alias 来执行您的 ESM 项目（ts-node 作为依赖项包含在内）：

npm i --save @bleed-believer/path-alias

到使用ts-node执行源文件：

npx bb-path-alias ./src/test.ts

假设"outDir": "./dist"，直接使用node执行转译代码（绕过ts-node）：

npx bb-path-alias ./dist/test.js

如果如果您不想使用该库来执行转译后的项目，可以使用 swc （此转换器解析路径别名），或者您可以使用 tsc -alias 使用 tsc 转译项目后。

注意

我根据上次更新更新了库的使用方法。

Answer 4

现在有一个更好的打字稿执行节点模块“可以正常工作”。

https://tsx.is/