海外团队前端开发套件 🏊

前端开发中除UI组件外所有开发套件。

API文档站点 | 规划文档 | PR | Release Logs | 开发插件: Monorepo Workspace | 基于

Packages 📦

开发代码相关

• [x] webtools-utils (util) 通用的js工具函数
• [x] webtools-solutions (solutions) 与react相兼容的技术方案

开发插件相关

• [x] webtools-eslint (eslint) 团队公用 Eslint 规范配置
• [x] webtools-prettier (prettier) 团队公用 Prettier 规范配置
• [x] webtools-commitlint (commitlint) 团队公用 Commitlint 规范配置
• [x] webtools-translator (translator) 目前主要用于文档多语言翻译的脚本工具
• [x] webtools-configuration (configuration) 该包作为webtools中其他包统一的配置中心
• [x] webtools-cf-pages (cf-pages) 该包为一个action，用于触发cloudflare pages的构建，并实时获取构建进度

启动 🚀

全局安装管理包的管理器 @antfu/ni

npm i -g @antfu/ni
复制

启动 corepack 以保证使用 packageManager 所约定的包管理器

corepack enable
复制

使用 ni 安装初始化项目依赖

ni
复制

发布流程 ⚙️

[💡开发必读💡]

通过 PR 触发 GitHub Actions 进行发布 ✅

1. 在非main分支上面进行开发；
2. 通过 git commit 提交更改, 必须携带 scope。需遵从 commit 约定；
3. 代码提交远程，稍等片刻(10s左右)，github Action会自动创建当前分支的PR;
4. PR代码评审，ok后，点击合并，等待github Action执行发布流程;

本地发布

仅作为测试手段或特殊情况的特殊手段

1. git commit 提交更改, 必须携带 scope。
2. pnpm run release-scope 更新版本号、添加commit、打tag、生成changelog、将tag、commit同步到远程
3. pnpm run publish-scope 代码 build、发布到 github Package

体验与测试 🛝

在 playground/react-demo 中对各个包进行快速的体验测试与问题复现

 pnpm run playground
复制

创建新包、快速开始！🚀

• copy template/webtools-template 到 packages/ 中
• 将新包中所有的 template 名称替换为新包的 scope 名称
• 最后需要在以下文件中添加 新的 scope 的变量与逻辑
  • commit 配置: commitlint.config.js 在 scope-enum 中新增 scope
  • CI 配置：lint-pr-title.yml 在 PR_TITLE_SCOPE 中新增 scope
  • CI 配置：check.sh 添加新 scope 的构建逻辑
• 启动！

TODO LIST 🧾

• [X] 集成 TypeDoc；
• [x] changelog与README合并显示；
• [x] 统一各包的配置为单一配置文件。eg: webtools.config.js
• [ ] 批量发布存在改动的包;