专栏首页云前端[译] 使用 microbundle 打包 TypeScript 组件库

[译] 使用 microbundle 打包 TypeScript 组件库

原文:https://codewithhugo.com/microbundle-typescript-npm-module/

对于那些想要编写一个组件并发布到 npm 上的开发者来说,TypeScript + microbundle 算是一种构建高质量代码库的低成本方式。

为什么是 TypeScript ?

TypeScript 是一个增加了静态类型系统的 JavaScript 超集。它其余的特性则相当密切地遵循了当前和未来的 ECMAScript 规范。对于组件库作者来说,这意味着即便是不实际使用 TypeScript 开发的用户,他们所使用的能对 TypeScript 智能处理的 编辑器/IDE(比如 Visual Studio Code)也能给出更友好的自动完成等。在编写代码时,当你传入某些错误的东西,TypeScript 也能充当行内文档做出及时提醒,这将解救你在面对自己几个月前开发的代码一筹莫展之时。

为什么是 microbundle ?

microbundle 号称 “微小组件的零配置打包器”。它是一个围绕 rollup 构建的包装器,包含了健全的默认功能(如最小化/压缩)、美观的打包体积输出、多目标格式(ES modules, CommonJS, UMD)。而在本文范围内最重要的是,其拥有开箱即用的 TypeScript 支持(真正的 无配置,甚至不用 tsconfig.json 也行)。其简单到离谱的设置使得组件库作者可以聚焦于构建一个极好的库,而非为了把 ES6/TypeScript 等编译为 JS 大费周章 ?。

用 microbundle 零配置打包

首先,我们得通过 npm init 创建组件包的设置,运行之并完成所有提示性选项。

接下来运行:npm i --save-dev microbundle.

创建源文件和目标文件夹:mkdir src && mkdir dist

以及添加首个 TypeScript 文件:touch src/index.ts.

为 index.ts 增添一个类,这样我们就不至于编译空文件了:echo "export class MyMainClass {}" >> src/index.ts

microbundle 会检查 package.json 中的 "main""source" 选项(编译后的入口文件和源入口文件),在本例中也就是 dist/index.js(尚不存在)和 src/index.ts。现在动手在 package.json 中加入这两项:

{
  "main": "dist/index.js",
  "source": "src/index.ts"
}

这意味着 microbundle 现在知晓了如何编译我们的组件库,运行 npx microbundle (当 npm < 5.x 时,也可以运行 ./node_modules/.bin/microbundle)。

这会将你的 src/index.ts 编译到 dist 文件夹中。如果查看后者的内容,你将看到 microbundle 为你做了多少工作:

ls dist
index.d.ts       index.js.map     index.m.js.map   index.umd.js.map
index.js         index.m.js       index.umd.js

来看一下这都是些什么:

  • index.js 是 CommonJS 模块。这是一种被 NodeJS 使用的模块类型,看起来像 const myModule = require('my-module')
  • index.m.js 是 ECMAScript 模块,由 ES6 定义,看起来类似 import MyModule from 'my-module'
  • index.umd.js 是 UMD 模块
  • index.d.ts 是 TypeScript 类型描述文件

另有一个配套的 .map 文件,为每个文件提供到 TypeScript 源文件的映射。

看看 index.js 的内容:

cat dist/index.js
var n=function(){return function(){}}();exports.MyMainClass=n;
//# sourceMappingURL=index.js.map

我们的 class MyMainClass {} 语句被编译为其 ES5 的等价实现,并导出为一个 CommonJS 模块。

index.d.ts 同样有趣:

cat dist/index.d.ts
export declare class MyMainClass {
}

这允许了一个 TypeScript 项目将正确的类型信息反向指派给组件包 -- 通过这种间接方式,完成了本来要引入 .ts 文件才能达到的类型识别目标。单独的类型声明文件意味着非 TypeScript 项目也可以理解模块的公共 API (例如代码编辑器可以对 npm 包中引用的代码智能自动完成)。

microbundle 也能监视文件改变:npx microbundle watch

为便于使用我们可以将 watch 和 build 任务作为 npm scripts 放置在 package.json 中:

{
  "scripts": {
    "dev": "microbundle watch",
    "build": "microbundle"
  }
}

将 microbundle 构建的模块发布到 NPM

借助 microbundle 可以将模块发布为 CommonJS 模块(标准的 npm 模块),但也能作为 ES Module 和 UMD 模块,按官网文档设置即可。

tl;dr

  • "source": "src/index.ts"
  • "main": "dist/index.umd.js"
  • "module": "dist/index.modern.js"
  • "types": "dist/index.d.ts"

换言之,package.json 看起来应该是类似这样的:

{
  "// other": "fields",
  "source": "src/index.ts",
  "main": "dist/index.umd.js",
  "module": "dist/index.modern.module.js",
  "types": "dist/index.d.ts",
  "// more": "fields"
}

package.json 如此配置后就可以通过 npm publish 发布到 npm 了。

本文分享自微信公众号 - 云前端(fewelife),作者:云前端

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-08-04

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 微生活时光机:去项目中挖掘JS模块化简史

    让我们把眼光投向微生活各个时期项目中的 JS 代码,看一看时代在其中投下的烙印,也许只是管中窥豹、走马观花,但通过其组织形式的异同,或可一瞥 JS 模块化层面的...

    江米小枣
  • Webpack之阿拉丁神灯

    现今的web,都很丰富,它们拥有着复杂的JavaScript代码,一大堆依赖包,为了简化开发的复杂度,前端世界出现了很多很好的实践方法。

    江米小枣
  • [译] 理解 CORS

    当你看到这个信息,就意味着响应失败了;但你依然能在浏览器开发工具的网络 tab 里看到返回数据 -- 这是什么情况呢?

    江米小枣
  • FIS应用实例-require.js+CMD模块

    前面文章讲了FIS的源码实现细节,这篇文章偏实战一些,给出FIS跟require.js结合的简单例子。

    IMWeb前端团队
  • Lerna+webpack+juction来拆分组件库为多个单独的npm包

    前不久发布了vc-popup组件集, 但是那时候完全只是展示没有如何使用的教程, 因为当时急于发布出来, 实在不妥, 抱歉~ 既然是想自己东西可以让别人方便使用...

    IMWeb前端团队
  • FIS应用实例-require.js+CMD模块

    前面文章讲了FIS的源码实现细节,这篇文章偏实战一些,给出FIS跟require.js结合的简单例子。 FIS编译流程 如果已熟悉了FIS的编译设计,可以跳过这...

    IMWeb前端团队
  • Lerna+webpack+juction来拆分组件库为多个单独的npm包

    前不久发布了vc-popup组件集, 但是那时候完全只是展示没有如何使用的教程, 因为当时急于发布出来, 实在不妥, 抱歉~

    IMWeb前端团队
  • ES6基础语法之模块化

    比如我希望在a.js中使用b.js的变量或者函数,那么ES6就中模块化就帮到咱们啦!

    十月梦想
  • Meteor1.3七日谈 — Mantra核心简介

    时见疏星

扫码关注云+社区

领取腾讯云代金券