create-windy 0.1.2 → 0.2.1

package/README.md

@@ -23,8 +23,9 @@ pnpm dlx create-windy@latest my-dashboard
 版本。创建器默认安装依赖、初始化 Git `main` 分支并尝试创建
 `chore: initialize project` 首次提交。
 
-不带参数运行时会交互选择模块、Oxc 和项目法律许可证。模块列表使用上下键移动，
-空格切换选中状态，回车提交选择。CI 或脚本中可使用：
+不带参数运行时会在同一个列表中交互选择平台模块和 Oxc 基础设施，再选择项目法律
+许可证。列表中的括号展示用途说明，不暴露内部模块 Key；使用上下键移动、空格切换
+选中状态、回车提交选择。CI 或脚本中可使用：
 
 ```bash
 # 接受默认模块、Oxc 和 UNLICENSED
@@ -57,7 +58,9 @@ npx create-windy@latest my-dashboard \
   `system.operations`。
 - 默认不选：离线 `system.license`、文件、任务、通知、工作流、搜索、数据治理、
   Agent、批量数据和示例工单等模块。
-- 默认代码质量：Oxlint + Oxfmt；`--no-oxc` 会物理排除配置、依赖和脚本。
+- 默认代码质量：Oxlint + Oxfmt。Husky 会在提交前通过 lint-staged 自动格式化暂存
+  文件，不会把未暂存内容带入提交；lint、typecheck 和 test 保留为显式命令。
+- `--no-oxc` 会物理排除 Oxc 配置、Husky hook、lint-staged、依赖和质量脚本。
 - 默认法律许可证：`UNLICENSED`，不会生成 `LICENSE` 文件。
 
 法律许可证与离线 `system.license` 是两项独立选择：前者决定项目代码授权，后者
@@ -75,7 +78,7 @@ npx create-windy@latest my-dashboard \
 | `--module <key>`        | 增加一个模块，可重复使用并自动解析依赖   |
 | `--all-modules`         | 选择目录中的全部模块                     |
 | `--no-optional-modules` | 只生成两个锁定核心模块                   |
-| `--no-oxc`              | 不引入 Oxlint、Oxfmt、配置和质量脚本     |
+| `--no-oxc`              | 不引入 Oxc、Husky、配置、依赖和质量脚本  |
 | `--license <SPDX>`      | 选择 `UNLICENSED`、`MIT` 或 `Apache-2.0` |
 | `--verify`              | 安装后运行 typecheck、test 和 build      |
 | `--skip-install`        | 只跳过依赖安装；仍要求本机有 Bun         |
@@ -95,21 +98,41 @@ cd my-dashboard
 bun run dev
 ```
 
+生成项目会固定安装与创建器同版本的生命周期 CLI，并提供：
+
+```bash
+bun run windy doctor
+bun run windy update --check
+bun run windy update --dry-run
+bun run windy update
+```
+
+更新器要求 Git 工作区干净，从 npm 历史 artifact 重建 Base，并以
+Base/Ours/Theirs 合并共享脚手架。`package.json` 使用字段级合并；已发布 migration
+只允许追加；冲突发生时不写项目，验证失败则从 `.windy/backups/` 自动回滚。项目锁定
+的 CLI 检测到新版后，会委托给目标版本生成完整更新计划。
+
 本地 Web 默认使用 8746；如果该端口属于其它服务，会自动尝试 8747、8748 等端口。
 如果检测到同一个项目已启动，则直接复用现有地址。
 
+默认创建流程会在依赖安装和 Git 初始化后启用 Husky。使用 `--skip-install` 时，后续
+执行 `bun install` 会完成启用；使用 `--no-git` 后自行初始化 Git，则再运行一次
+`bun run prepare`。
+
 ## 安全与分发边界
 
 客户项目只来自 npm 包内的已清理模板快照，不需要访问 Windy 私有源仓库。供应方
 License Authority、内部签名服务、Secret、开发凭据、本机绝对路径和运行状态不会进入
 生成物。创建失败默认事务化清理；`--keep-on-error` 是显式诊断例外。
 
-当前包与默认生成项目均为 `UNLICENSED`。除非创建时明确选择 MIT 或 Apache-2.0，
-生成器不会自动授予开源许可。
+`create-windy` 与它分发的 Windy Starter 基座使用 Apache-2.0；完整正文随包发布，
+生成项目会保留在 `.windy/licenses/WINDY-APACHE-2.0.txt`。项目所有者新增的业务代码
+法律许可仍由创建时的 `--license` 独立决定，默认 `UNLICENSED`，不会因为使用了
+Apache-2.0 基座而自动开源客户业务代码。
 
 ## 当前生命周期边界
 
 创建期模块物理组合已达到 H2：默认、纯核心、全模块和无 Oxc 组合持续执行真实安装、
 类型检查、测试和构建，模块组合还在 PostgreSQL 17 上验证首次/重复迁移与 Server
-启动。已生成项目的 `doctor`、无损 `update` 和 `module add/remove/update` 属于下一
-阶段；H2 不代表部署后已经可以无损安装或卸载模块。
+启动。`doctor` 与无损 `update` 已交付；部署后的通用 `module add/remove/update` 仍属
+下一切片，因此 H2 暂不代表模块已经可以无损安装或卸载。