如何展平已发布 NPM 模块的文件结构

Question

我有一个 TypeScript 项目，我将其作为 NPM 模块发布。编译项目的输出在{mymodule}/dist/src/...目录下，也就是说我发布的时候，NPM模块也是采用上面的文件结构。

这样做的缺点是当需要单独的模块时，它看起来像这样：

var individualModule = require('/dist/src');

我想展平已发布模块的输出，其中已发布模块中的文件将是 {mymodule}/... 而不是 {mymodule}/dist/src/...

Answer 1

在我看来，正确的做法是通过根文件中的module.exports（或import/export）有意地从您的包中公开模块。

const exposableOne = require('/dist/src/ex-1.js');
const exposableTwo = require('/dist/src/ex-2.js');

// ...

module.exports = { mymodule, exposableOne, exposableTwo };

您可以查看主要的Express framework file - 他们使用exports. 指令做了几乎相同的事情。

不完全是 TypeScript 的东西，但想法很常见。

更新：

如果您确实需要在不通过require/exports 绑定的情况下执行此操作，则可以使用符号链接方法。我不确定此选项是否适用于所有平台，但例如，您可以在 GitHub 上查看 solved issue 和 this repository。后者中的aliases 目录包含符号链接到recipes 目录模块的文件。