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

Question

我有一个要发布为NPM模块的TypeScript项目。编译项目的输出在{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的东西，但是idea是很常见的。

更新：

如果您确实需要在不通过require/exports进行绑定的情况下完成此操作，那么您可以使用符号链接方法。我不确定这个选项是否在所有平台上都能很好地工作，但是例如你可以在GitHub上查看这个solved issue和this repository。后者中的aliases目录包含符号链接到recipes目录模块的文件。