【问题标题】:Write an easily consumable Typescript framework编写一个易于使用的 Typescript 框架
【发布时间】:2017-03-05 03:24:25
【问题描述】:

我一直在开发一个在 NPM 中发布的框架,并且一切正常。但是当我使用自己的框架作为外部模块时,有些东西真的很痛苦。我必须使用这样的完整路径设置导入:

import { MyService } 'myframework/all/the/internal/path/myservice.service';

而且我必须为我在框架中使用的每个类、服务或 Web 组件创建一个不同的导入语句。我想这是因为声明文件不是从顶级 index.d.ts 文件中导出的。

感谢 Matthias247,我正确地编写了重新导出文件,在其中导出了我框架中的所有类。当将它用作外部 NPM 模块时,它运行良好,我可以像这样编写所有导入:

import {MyService, MyClass1, MyClass2, ... } from 'myframework';

现在这可行,我尝试将我编译的 JavaScript 文件变成一个单独的 bundle.js,由 SystemJS 加载,就像 @angular 模块一样。

而这我真的完全迷失了......我无法理解构建这样一个捆绑包的正确方法是什么或应该是什么。 使用browserify,每个命令都会通过将“NO_MODULE_FOUND”写入我的bundle.js而失败。因此,我尝试使用 tsify 作为 browserify 的插件运行,看起来它正在做正确的工作,将所有类收集在一个包中。但小问题,它还捆绑了所有 @angular 和 RxJS。

请有人指导我如何生成 UMD 捆绑包?我使用“模块:commonjs”选项进行编译,但由于任何文件都被 browserify 识别为模块,我真的不知道该怎么做。

【问题讨论】:

    标签: javascript angular typescript frameworks systemjs


    【解决方案1】:

    一种可能的解决方案(也是我建议的解决方案)是更好地设置库的导出,以便您能够做到

    import {MyService, MyClass1, MyClass2, ... } from 'myframework';
    

    最后,即使这些类型可能定义在框架的子文件夹中。

    通常的做法是利用再出口。 在您的框架的主文件夹中,您可以有一些 index.ts,同时重新导出对用户有效的所有类型。

    喜欢

    export * from 'myframework/all/the/internal/path/myservice.service';
    

    为了不必引用主索引文件中的所有类型,您还可以以分层方式执行此操作。例如。在子文件夹中定义一个 index.ts 文件,例如 myframework/all/the/internal/path/index.ts 并从其中的该文件夹中导出所有类型。然后在更高级别导出子文件夹:export * from 'myframework/all/the/internal/path';

    【讨论】:

    • 嗯,正如我解释的那样,我已经这样做了。我的问题是运行时路径解析。将我的框架加载为 SystemJS 模块时,它尝试在“host/myframework/dist”上导入,但它不起作用,我得到 404,因为它应该转到“host/myframework/dist/feature/feature.class”或类似的东西。
    • 你没有这样做。您已经编写了一个 .d.ts 文件,该文件将更改声明,但不会影响导出的代码和运行时加载。我建议编写一个实现再导出的 ts 文件(没有 .d)。这会更改生成的代码并解决您的运行时问题,因为导入主索引文件也会导入其余部分。
    • 确实!实际上查看 node_modules/@angular/core 索引文件会误导我,因为它们使用 umd 包并且不需要与我相同的东西。我已经按照您的建议进行了分层再导出,但我只是想使用我的根假索引(.d.ts 和 .js)文件。所以现在我使用我的 dist 文件夹中的主 index.js(从真正的 index.ts 生成),它可以在运行时运行。非常感谢 ! :) 但我仍然想了解如何使用 browserify 生成 UMD 包,因此我将编辑我的问题并等待,然后将您的答案标记为已接受。
    • 抱歉,这是一个完全不同的问题。你不应该这样做,而是问另一个问题,因为没有人能够关注你,这对响应者不公平。原始问题已得到解答。
    • 嗯...我最初的问题是“请有人指导我应该如何生成 UMD 捆绑包?”。这仍然是我想要答案的问题。但是我的帖子中有很多东西,你解决了我的运行时问题,所以你说得对,我应该更具体地问一个关于如何生成捆绑包的新问题。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2011-05-31
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多