Rollpkg:构建零配置的TypeScript包利器
🚀 Rollpkg 是一个基于 Rollup 和 TypeScript 的零配置构建工具,它同时也支持JavaScript项目。为开发者提供了简单易用的环境,让你的包开发变得轻而易举。
🌐 Rollpkg 为你生成 esm
(ES 模块)、cjs
(CommonJS)和 umd
(通用模块定义)三种类型的构建文件,满足开发与生产环境的需求。它还充分利用了 Rollup 的树摇优化特性,确保代码体积最小化。
🌍 并且,Rollpkg 提供了一套默认配置,包括 TypeScript 配置、Prettier 格式化、ESLint 代码检查以及 Jest 测试框架。这意味着你可以立即开始编码,而不必担心基础设置的问题。
示例项目 & 实际应用
查看 rollpkg-example-package
查看一个完整的示例项目,以及在 Unpkg 上浏览已构建并发布的代码。这个项目已被多个实际项目采用,如 react-interactive
、detect-it
和 fscreen
等。
项目特点:
- 零配置启动 - 无需繁琐的设置,只需遵循简单的步骤,即可快速启动新项目。
- 多平台支持 - 提供
esm
、cjs
和umd
三类构建,适用于不同环境和场景。 - 树摇优化 - 利用 Rollup 进行深度代码优化,减少不必要的模块导入。
- 内置配置 - 内建 TypeScript、Prettier、ESLint 及 Jest 配置,提供全面质量保证。
- 类型安全 - 使用 TypeScript 编译源码,确保类型安全,避免全局类型污染。
如何开始?
首先,确保安装 git
和 npm
。然后,按照以下步骤操作:
- 初始化项目:
mkdir <package-name> && cd <package-name> && git init && npm init
- 安装依赖:
npm install --save-dev rollpkg typescript
- 更新
package.json
添加必要字段 - 添加构建相关脚本
- 创建
tsconfig.json
文件
完成以上步骤后,你的项目就已经准备好了。运行 npm run build
即可构建项目,npm run watch
用于实时编译。
Rollpkg 简单、强大,是创建高质量 TypeScript 包的理想选择。无论是新手还是经验丰富的开发者,都将从中受益匪浅。立刻尝试 Rollpkg,体验高效无痛的包开发流程!