如何让支持PathLike的函数复用ESM导入别名解析机制？

在ESM包中，我们可以通过package.json的imports字段配置路径别名，比如配置：

{
  "type": "module",
  "imports": {"#*": "./*"}
}

之后使用import something from "#module"会自动解析为import something from "./module"。但Node.js的内置文件操作函数（如readFileSync）或自定义函数并不支持直接复用这个解析机制，无法直接使用readFileSync("#file.txt")这类写法，我们希望不用手动修改路径就能实现别名解析，避免繁琐的相对路径。

@RickN提供了一个基于import.meta.resolve的异步解析函数，能将imports别名解析为可用于文件操作的本地路径：

import { fileURLToPath } from 'node:url';
import type { PathLike } from 'node:fs';

export function resolveImports(path: PathLike): Promise<string> {
  return import.meta!.resolve!(path.toString()).then((resolvedPath) =>
    fileURLToPath(resolvedPath)
  );
}

使用示例 #

因为import.meta.resolve是异步API，需要在异步函数中使用：

import { readFileSync } from 'node:fs';

async function readAliasedFile() {
  const filePath = await resolveImports("#file.txt");
  const content = readFileSync(filePath, 'utf8');
  console.log(content);
}

readAliasedFile();

补充说明 #

• import.meta.resolve是Node.js ESM的内置API，专门用于解析符合模块解析规则的路径，包括imports中配置的别名
• 解析后得到的是file协议的URL，需要用fileURLToPath转换为本地文件系统路径才能给readFileSync等函数使用
• 如果需要同步版本，可以借助util.promisify结合同步阻塞方式实现，但不推荐在性能敏感场景使用，更建议遵循异步流程

内容的提问来源于stack exchange，提问作者Sherif eldeeb