如何修改TypeScript打包AMD模块时的根模块名称为xrm-mock

我正尝试将大量TypeScript文件打包为单个文件，以便在基于浏览器的TDD中快速加载。主入口文件index.ts内容如下：

export * from "./xrm-mock/index"; export { XrmMockGenerator } from "./xrm-mock-generator/index";

原本有两个独立库xrm-mock和xrm-mock-generator，现已合并为一个库，目前功能正常。

我通过npm引用该项目，使用StealJs在Karma单元测试中加载文件，但加载耗时约3-6秒。解决方案是将所有文件打包为单个文件。

我使用以下构建脚本：

tsc --outFile ./build/build.js --module amd

打包生成单个文件后，根模块名称默认是index：

define("index", ["require", "exports", "xrm-mock/index", "xrm-mock-generator/index"], function (require, exports, xrmMock, index_1) { "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.xrmMock = xrmMock; exports.XrmMockGenerator = index_1.XrmMockGenerator; });

而我希望将其默认设置为**"xrm-mock"**。

请问是否有办法让TypeScript转译时将模块名称设为“xrm-mock”而非index.ts？如果没有，最简单的自动化方法是什么？可以在构建后编辑js和d.ts文件，将“index”替换为“xrm-mock”。

这里有两种方案可以解决你的问题，先从最直接的TypeScript原生方法说起：

方法一：用TypeScript的AMD模块指令直接指定名称 #

这是最推荐的方式，不需要额外的构建后处理。你只需要在入口文件index.ts的顶部添加一行特殊的注释指令：

/// <amd-module name="xrm-mock" />
export * from "./xrm-mock/index"; 
export { XrmMockGenerator } from "./xrm-mock-generator/index";

然后重新执行你的构建命令：

tsc --outFile ./build/build.js --module amd

这样生成的build.js里的模块定义就会自动变成：

define("xrm-mock", ["require", "exports", "xrm-mock/index", "xrm-mock-generator/index"], function (require, exports, xrmMock, index_1) { "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.xrmMock = xrmMock; exports.XrmMockGenerator = index_1.XrmMockGenerator; });

完美符合你的需求！

方法二：构建后自动化替换模块名（备用方案） #

如果因为某些限制不能使用amd-module指令，那可以用脚本自动化替换build.js和对应的.d.ts文件里的index为xrm-mock，以下是两种常见的实现方式：

方案A：Node.js脚本（跨平台） #

创建一个简单的Node.js脚本replace-module-name.js：

const fs = require('fs');
const path = require('path');

// 定义要处理的文件路径
const buildDir = './build';
const targetFiles = ['build.js', 'build.d.ts']; // 根据你的实际d.ts文件名调整

targetFiles.forEach(fileName => {
  const fullPath = path.join(buildDir, fileName);
  fs.readFile(fullPath, 'utf8', (readErr, content) => {
    if (readErr) throw readErr;
    // 替换所有出现的"index"或'index'为"xrm-mock"或'xrm-mock'
    const updatedContent = content.replace(/("|')index("|')/g, '$1xrm-mock$2');
    fs.writeFile(fullPath, updatedContent, 'utf8', writeErr => {
      if (writeErr) throw writeErr;
      console.log(`✅ 已更新${fileName}中的模块名称`);
    });
  });
});

然后在package.json的scripts里修改构建命令，让它自动执行替换脚本：

"scripts": {
  "build": "tsc --outFile ./build/build.js --module amd && node replace-module-name.js"
}

之后执行npm run build就会自动完成编译+替换的流程。

方案B：Shell脚本（Linux/macOS） #

如果你的开发环境是类Unix系统，可以直接用sed命令完成替换，把构建命令改成：

tsc --outFile ./build/build.js --module amd && sed -i '' 's/"index"/"xrm-mock"/g' ./build/build.js ./build/build.d.ts

把这个命令放到package.json的scripts里即可，执行起来更轻便。

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