Getting Started

hoolly 是一个由 Rust 编写的命令行工具，用于生成可直接发布的 TypeScript/React SDK 脚手架。

安装

通过 npm 安装（推荐）

npm install -g hoolly

安装后会自动尝试编译 Rust 二进制（需要 Rust 工具链）。如果没有 Rust，可以稍后手动编译。

从源码安装

# 克隆仓库
git clone https://github.com/whl555/leo-sdk-template.git
cd leo-sdk-template

# 使用 Cargo 安装
cargo install --path .

从源码快速体验

cargo run -- my-awesome-sdk

本地构建

cargo build --release
./target/release/hoolly --help

快速开始

hoolly my-awesome-sdk

CLI 会引导你选择模板、包管理器等信息；也可以使用 --defaults 快速生成：

hoolly my-awesome-sdk --defaults

常用参数

• --defaults：跳过所有交互问题，使用默认配置
• --with-examples：生成示例代码（若模板提供）
• --with-ci：生成 GitHub Actions 工作流
• --org <org>：组织名
• --author <author>：作者名
• --template <react-lib|ts-lib>：选择模板类型（默认 ts-lib）
• --package-manager <npm|pnpm|yarn>：指定首选包管理器

生成项目后的步骤

1. 进入新项目目录：

   cd my-awesome-sdk

2. 安装依赖（以 npm 为例）：

   npm install

3. 构建与测试：

   npm run build
   npm test

4. 发布前检查与发布：

   npm run prepublishOnly
   npm publish

模板概览

ts-lib

• 提供纯 TypeScript SDK 脚手架，默认导出 createClient 帮助函数。
• 预置 Rollup 构建、类型声明与 Jest 测试配置。
• 适合面向 Node.js/浏览器双端的逻辑 SDK。

react-lib

• 包含示例 SdkSection 组件，展示如何构建组件型 SDK。
• 同样提供 Rollup/Jest 配置，方便直接发布。
• 默认标记 React 为 peer dependency，保持体积轻量。

定制建议

• 修改 template/ts-lib 或 template/react-lib 下的文件定制脚手架内容。
• 根据团队习惯更新模板中的 rollup.config.js、tsconfig*.json 或 scripts/publish.js。
• 若需要更多模板类型，可在 template/ 目录新增子目录并扩展 Rust 版生成逻辑。

开发与发布

如果你想要贡献代码或发布 hoolly 工具本身到 npm：

版本管理

使用自动化脚本更新版本号（会同步更新 package.json 和 Cargo.toml）：

# 增加补丁版本 (0.1.0 -> 0.1.1)
npm run version patch

# 增加次版本 (0.1.0 -> 0.2.0)
npm run version minor

# 增加主版本 (0.1.0 -> 1.0.0)
npm run version major

发布到 npm

# 确保已登录 npm
npm login

# 运行发布脚本（会自动构建、测试和发布）
npm run publish

发布脚本会自动：

• ✅ 检查版本号一致性
• ✅ 检查 npm 登录状态
• ✅ 检查 Git 工作目录状态
• ✅ 构建 Rust 二进制文件
• ✅ 进行本地打包测试
• ✅ 发布到 npm
• ✅ 创建 Git tag 并推送

更多详情请查看 PUBLISH.md。