create-windy 0.1.2 → 0.2.1

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "create-windy",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "description": "创建单组织、单租户、私有部署优先的 Windy 企业 Dashboard Starter",
   "type": "module",
   "bin": {
     "create-windy": "dist/cli.js"
   },
   "files": [
-    "assets",
+    "LICENSE",
     "dist",
     "template",
     "README.md"
@@ -29,7 +29,7 @@
     "bun",
     "enterprise"
   ],
-  "license": "UNLICENSED",
+  "license": "Apache-2.0",
   "publishConfig": {
     "access": "public"
   },

package/template/.husky/pre-commit

@@ -0,0 +1,15 @@
+#!/usr/bin/env sh
+set -e
+
+if [ -x "$HOME/.bun/bin/bun" ]; then
+  BUN_BIN="$HOME/.bun/bin/bun"
+elif command -v bun >/dev/null 2>&1; then
+  BUN_BIN="$(command -v bun)"
+else
+  echo "bun not found. Install Bun or ensure it is available at \$HOME/.bun/bin/bun." >&2
+  exit 1
+fi
+
+export PATH="$(dirname "$BUN_BIN"):$PATH"
+
+"$BUN_BIN" run format:staged

package/template/.windy-template.json

@@ -1,7 +1,7 @@
 {
   "schemaVersion": 1,
-  "templateCommit": "fd0b4e6037d1f5478ae7ba261d80a7c6fd6f3da7",
-  "generatorVersion": "0.1.2",
+  "templateCommit": "2ea424d9bb8c8f9ae0bdd94c101052684dfb5880",
+  "generatorVersion": "0.2.1",
   "modules": [
     {
       "name": "system",

package/template/AGENTS.md

@@ -1,87 +1,40 @@
 # AGENTS.md
 
-## 语言与产品默认值
+本文件说明项目由 create-windy 生成时的技术基线，帮助开发者和代码 Agent 快速理解
+仓库。它不是软件供应方对下游项目的永久限制；项目所有者可以按团队需要调整技术、
+工具和工作流，并同步更新实际脚本与文档。
 
-- 软件界面、文档和示例数据默认使用中文。
-- 当前阶段暂不支持国际化，不新增 i18n 框架、语言包或翻译抽象。
-- 本项目是企业级 Dashboard 产品基座，不是传统 Admin Template。
+## Runtime 与工作区
 
-## 技术与依赖
+- Bun 1.3.14+：运行时、包管理器与脚本执行器。
+- TypeScript 5.9：根依赖，由 Bun Workspaces 共享。
+- Monorepo：应用位于 `apps/*`，共享能力与业务模块位于 `packages/*`。
 
-- 优先使用 Bun 进行包管理、脚本运行、测试和构建。
-- 代码检查与格式化统一使用 Oxc：Oxlint 和 Oxfmt，不使用 ESLint 或 Prettier。
-- Oxc 是 Starter 默认提供的代码质量方案；项目生成后由项目所有者决定是否保留、替换或并行使用其它工具。
-- TypeScript 安装在根依赖，由 Bun Workspaces 共享。
-- 新增依赖时使用 Bun 解析最新可用版本，不手写猜测版本。
-- 依赖必须服务于当前技术栈或明确的近期架构目标，避免无用占位包。
-- Web UI 默认使用 shadcn-vue + Reka UI + Tailwind CSS，不再使用 Headless UI 作为主组件库。
-- 安装 shadcn-vue 组件必须使用命令，不手写复制组件源码：`bunx --bun shadcn-vue@latest add <component>`。
-- 常用 shadcn-vue 组件可先安装；其它组件按需安装，安装前先检查 `apps/web/src/components/ui` 是否已有。
-- Web 图表默认使用 `@antv/g2`；不要新增 ECharts 依赖或基于 ECharts 的组件封装。
+## Web
 
-## 架构原则
+- Vue 3 + Vite + Vue Router + Pinia。
+- shadcn-vue + Reka UI + Tailwind CSS。
+- AntV G2 用于图表。
+- Vitest + Vue Test Utils 用于组件和前端单元测试。
 
-- 全项目使用 TypeScript，公共 API、DTO、配置和模块 manifest 必须有明确类型。禁止使用 any 类型。
-- 遵循 SOLID、Clean Architecture、轻量 DDD、Repository Pattern、Dependency Injection。
-- 业务能力默认按模块拆分，保持低耦合、高内聚。
-- 禁止跨模块直接访问 Repository；模块间通过 service、公开接口或模块注册机制协作。
-- 新功能默认接入 RBAC、Feature Flag、License、Audit Log，不绕过基础设施。
-- 数据访问统一通过 Repository + Drizzle；业务层不得直接依赖 PostgreSQL、MySQL、达梦或人大金仓方言。
-- 数据库兼容层负责 SQL Dialect、Migration、类型映射、自增策略、JSON、分页和保留字差异。
-- RuoYi-Vue 兼容能力必须做成可插拔 Adapter：新项目默认关闭，不污染平台 canonical schema，不让业务模块直接依赖旧 `sys_*` 表。
-- 旧项目兼容目标包括一次性导入新库，以及客户单机服务器上必要时直连旧 MySQL / Redis 运行；密码可统一重置，不要求兼容旧 hash。
+## Server 与数据
 
-## 功能注册约束
+- Bun + Elysia 提供 HTTP 服务。
+- Drizzle ORM 负责数据访问和迁移，默认数据库为 PostgreSQL 17。
+- 平台能力通过 Module Manifest 组合，并提供 Feature、RBAC、Audit 与可选 License
+  边界。
 
-- 每新增一个面向用户或业务的功能，必须在所属 Module Manifest 中同时注册 Feature Flag 与 RBAC 权限，不允许只做页面、路由或后端接口。
-- Feature 与权限共用同一个稳定的能力基础 Key：Feature Key 直接使用基础 Key，例如 `system.audit`；权限 Key 在同一基础 Key 后追加动作，例如 `system.audit.read`、`system.audit.manage`。
-- 菜单、页面路由、按钮、Server API、Agent Tool 和后台任务必须引用 Manifest 中已注册的 Feature / Permission Key，并经过统一 Guard；禁止在各层维护互相漂移的手写 Key 列表。
-- 新能力的 Manifest 注册应同时声明菜单或入口、API 权限绑定、可选 Entitlement 和审计动作，并补充注册重复、未知引用和 Guard 拒绝测试。
+## 当前代码质量配置
 
-## 代码组织
+- 生成时默认预装 Oxlint、Oxfmt、lint-staged 与 Husky。
+- 提交前自动格式化暂存文件；lint、typecheck 和 test 保留为显式命令。
+- 这是 Starter 的初始配置；项目所有者可按团队需要保留、替换或扩展。
+- 实际可用命令和提交检查以当前项目的 `package.json` 与 Git hooks 为准。
 
-- 非文档文件最多 350 行；新增代码会超过限制时，先拆分文件再继续实现。
-- 优先组件化、模块化和小文件设计，避免把平台核心、业务逻辑和 UI 细节混在一起。
-- Web 通用布局组件放在 `apps/web/src/layout/`。
-- 非组件库提供、但可跨页面复用的业务通用组件放在 `apps/web/src/components/common/`。
-- shadcn-vue 生成的基础 UI 组件保留在 `apps/web/src/components/ui/`，业务代码优先组合使用，不直接改造成业务组件。
-- 组件、服务、仓储、schema、dto、permission、menu、feature 等职责清晰分离。
-- 公共类型、DTO、校验和配置放入共享 package，避免复制粘贴。
-- 只添加必要注释，复杂逻辑前可补充简短说明。
+## 常用入口
 
-## 未保存编辑保护
-
-- 任何页面、抽屉、Modal 或 Dialog 存在未保存编辑时，用户关闭编辑容器、切换页面、Tab 或路由，以及刷新或关闭浏览器前，都必须得到明确确认；禁止静默丢失用户输入。
-- 应用内确认统一使用 Dialog：取消后留在当前编辑态；保存时按钮必须显示 loading 并阻止重复提交，只有保存成功后才能继续原本的关闭或切换动作；保存失败时保留当前输入并停留原处。
-- 浏览器刷新、关闭窗口或关闭标签页使用原生 `beforeunload` 确认，不尝试用自定义 Dialog 替代浏览器安全提示。
-- 未保存状态必须由当前编辑值与最近一次成功加载或保存的基线比较得出；成功保存、明确重置或重新加载后及时清除，不能只用一次输入事件永久标脏。
-
-## Git Flow
-
-- 当前阶段直接在 `main` 提交，除非用户要求分支、PR 或隔离工作树。
-- 每完成一个功能、修复或文档切片，必须立即提交一个对应 commit。
-- 每个提交保持一个小而完整的功能、修复或文档切片。
-- 使用 Conventional Commits：`feat(scope): summary`、`fix(scope): summary`、`docs(scope): summary`、`chore(scope): summary`。
-- 不回滚无关用户改动。
-- 提交前检查 `git status`，确保没有把无关文件混入提交。
-
-## 验证与测试
-
-- 优先使用 `bun run typecheck`、`bun run build`、`bun test`。
-- 核心模块优先补单元测试。
-- 不使用 Playwright 或 Chrome 做自测，除非用户明确要求。
-- 复杂功能完成后，在 `docs/` 下补充设计、行为、运维和取舍说明。
-
-## Agent skills
-
-### Issue tracker
-
-Issue、PRD 与接力任务保存在仓库的 `.scratch/<feature>/`，不连接外部平台。详见 `docs/agents/issue-tracker.md`。
-
-### Triage labels
-
-使用 `needs-triage`、`needs-info`、`ready-for-agent`、`ready-for-human`、`wontfix` 五种标准状态。详见 `docs/agents/triage-labels.md`。
-
-### Domain docs
-
-采用单上下文布局：根目录 `CONTEXT.md` 与 `docs/adr/`。详见 `docs/agents/domain.md`。
+- `bun run dev:web`：启动 Web 开发服务。
+- `bun run dev:server`：启动 Server 开发服务。
+- `bun run typecheck`、`bun run test`、`bun run build`：执行基础验证。
+- `docs/README.md`：平台架构、模块接入和运维文档入口。
+- `.windy/generation.json`：本次生成器版本、所选模块和选项记录。

package/template/README.md

@@ -4,8 +4,10 @@ windy-starter 是由 create-windy 生成的单组织、单租户企业应用项
 `/`，平台管理控制面位于 `/admin/**`；业务功能可以按自己的产品习惯开发，不需要
 复用 Admin 页面结构。
 
-本项目固定使用 Bun 1.3.14 或更高版本，当前法律许可为 `UNLICENSED`。项目不包含
-软件供应方的 License Authority、内部签名服务、发布密钥或私有源仓库信息。
+本项目固定使用 Bun 1.3.14 或更高版本，客户业务代码的当前法律许可为
+`UNLICENSED`。Windy Starter 基座使用 Apache-2.0，正文保留在
+`.windy/licenses/WINDY-APACHE-2.0.txt`。项目不包含软件供应方的 License Authority、
+内部签名服务、发布密钥或私有源仓库信息。
 创建时包含了 `work-order` 示例模块，用于演示 Module Manifest 接入；它不是生产工单产品，可以在正式开发前替换。
 
 ## 环境要求
@@ -87,8 +89,9 @@ bun run dev:web
 | `system.data-governance` | 未包含 | H2 | 敏感字段、明文访问和治理导出。 |
 | `work-order` | 未包含 | H2 | 可替换的业务模块接入示例。 |
 
-精确生成来源和选择记录在 `.windy/generation.json`。当前版本尚未提供通用
-`module add/remove` 或 `windy update`，不要把 Feature Flag 关闭当成模块已经卸载。
+精确生成来源和选择记录在 `.windy/generation.json`。当前版本已提供可回滚的
+`windy update`；通用 `module add/remove` 尚未交付，不要把 Feature Flag 关闭当成
+模块已经卸载。
 
 ## 常用命令
 
@@ -98,10 +101,19 @@ bun run dev:server
 bun run typecheck
 bun run test
 bun run build
+bun run windy doctor
+bun run windy update --check
+bun run windy update --dry-run
 bun run lint
 bun run format
 ```
 
+提交时 Husky 会通过 lint-staged 与 Oxfmt 格式化暂存文件，不会把未暂存内容带入提交。lint、typecheck 和 test 保留为需要时显式运行的命令。
+
+更新前必须保持 Git 工作区干净。`--dry-run` 只生成计划，不写项目；正式更新先备份，
+再做 package 字段级合并、共享脚手架三方合并与完整验证。任何冲突都会在写入前中止，
+验证失败会自动回滚；中断恢复使用 `bun run windy doctor --repair`。
+
 ## 开发约束
 
 - 新增路由默认需要登录；只有显式 public 的页面允许匿名访问。
@@ -124,5 +136,7 @@ create-windy 默认建立 `main` 分支并创建 `chore: initialize project` 首
 
 ## License
 
-本项目当前法律许可证为 `UNLICENSED`。项目没有附带开源许可证。法律许可证与 `system.license` 离线运行时授权模块是两个不同概念；更换其中一个
-不会自动更换另一个。
+客户业务代码当前法律许可证为 `UNLICENSED`。项目没有附带开源许可证。Windy Starter 基座继续适用
+`.windy/licenses/WINDY-APACHE-2.0.txt` 中的 Apache-2.0。项目法律许可证与
+`system.license` 离线运行时授权模块是两个不同概念；更换其中一个不会自动更换
+另一个。

package/template/_gitignore

@@ -4,4 +4,6 @@ node_modules/
 dist/
 packages/create-windy/template/
 .tmp/
+.windy/backups/
+.windy/update-state.json
 *.tsbuildinfo

package/template/package.json

@@ -40,13 +40,18 @@
     "typecheck": "bun run --cwd apps/web typecheck && bun run --cwd apps/server typecheck && bun run --cwd apps/license typecheck && bun run --cwd apps/signing-service typecheck && bun run --cwd packages/license-sdk typecheck && bun run --cwd packages/storage typecheck && bun run --cwd packages/database typecheck && bun run --cwd packages/crud-generator typecheck && bun run --cwd packages/create-windy typecheck",
     "lint": "oxlint .",
     "format": "oxfmt",
+    "format:staged": "lint-staged",
     "test": "bun test --path-ignore-patterns='packages/create-windy/template/**' && bun run --cwd apps/web test"
   },
+  "lint-staged": {
+    "*.{cjs,css,cts,html,js,json,jsonc,jsx,less,md,mdx,mjs,mts,scss,ts,tsx,vue,yaml,yml}": "oxfmt --write"
+  },
   "devDependencies": {
     "@types/bun": "^1.3.14",
     "@types/pg": "^8.20.0",
     "drizzle-kit": "^0.31.10",
     "husky": "^9.1.7",
+    "lint-staged": "^17.1.1",
     "oxfmt": "^0.59.0",
     "oxlint": "^1.74.0",
     "typescript": "5.9.3"