如何在Typescript编写的NPM包中加载用户后续创建的JS配置文件

你遇到的问题同时包含TS静态检查报错和配置文件路径查找两个问题，以下是可落地的解决方案，按推荐优先级排序：

方案1：使用成熟的配置加载库（最推荐） #

绝大多数前端工具都使用cosmiconfig这类专业的配置加载库处理用户配置，它会自动帮你处理模块导入、路径查找、不同配置格式兼容的问题，完全避开TS静态检查的问题，还能解决你手写相对路径找不准用户工作目录的问题（你原本写的./config.js是相对于你编译后JS文件的路径，而非用户执行npx命令的目录，就算解决TS报错运行时也大概率找不到配置）。
使用示例：
首先安装依赖：
npm install cosmiconfig
代码调用：

import { cosmiconfig } from 'cosmiconfig';

async function main() {
  // 替换为你的库名，会自动查找工作目录下的.someLibraryrc、someLibrary.config.js等标准格式配置
  const explorer = cosmiconfig('someLibrary');
  const result = await explorer.search();
  if (!result) {
    throw new Error('未找到有效配置文件');
  }
  const config = result.config;
  console.log(config);
}

main();

方案2：将导入路径改为动态变量 #

TS只会对字符串字面量的导入语句做静态模块存在性检查，如果你把路径赋值给变量再传入import，TS就不会做静态检查了，同时你可以配合process.cwd()拼接用户工作目录的路径解决查找问题：

import { join } from 'path';

main();

async function main(): Promise<void> {
  // 拼接用户执行命令的工作目录下的config.js路径
  const configPath = join(process.cwd(), 'config.js');
  // 路径为动态变量，TS不会静态校验模块是否存在
  const config = await import(configPath);
  console.log(config.default);
}

如果需要给配置加类型，可以自己定义Config类型做断言：

interface MyConfig {
  // 你的配置字段定义
}
const config = (await import(configPath)).default as MyConfig;

方案3：添加类型声明绕过检查 #

在你项目的类型声明文件（比如global.d.ts）里添加对应的模块声明，告知TS这个模块是存在的：

// global.d.ts
declare module "./config.js" {
  const config: {
    default: any // 或者替换成你定义的配置类型
  };
  export default config;
}

添加后TS就不会再报找不到模块的错误，不过这个方案还是没解决路径查找的问题，仅适合固定路径导入的场景。

方案4：临时忽略TS检查 #

如果你只是想快速验证逻辑，可以在导入语句前加// @ts-ignore注释，跳过这一行的TS检查：

async function main(): Promise<void> {
  // @ts-ignore: 配置文件由用户在运行时提供，编译阶段不存在
  const config = await import("./config.js");
  console.log(config);  
}

这个方案最简单，但不推荐长期使用，会丢失类型检查能力，也无法解决路径查找问题。

内容的提问来源于stack exchange，提问作者João Melo