@bams-app/work-cli 0.1.2 → 0.1.4

package/README.md

@@ -157,58 +157,30 @@ cd work/configs && npm publish --registry=https://registry.npmjs.org/
 
 `work-cli` 与 `create` 生成的项目均以 `"*"` 声明 `@bams-app/ui-dev-server`：仓库内直接链接到
 本地包，发布后自动解析为 registry 上最新的已发布版本，无需手动改版本号。
+用户项目升级时使用 `npm i @bams-app/ui-dev-server@latest`，该命令会把声明改写为 `^x.y.z`。
 
 ## 用户项目升级
 
-用户项目的 `devDependencies` 只声明 `@bams-app/ui-dev-server` 一个（`"*"`），能力包与
-运行时依赖全部作为它的传递依赖解析到同一份包，提升到项目根 `node_modules`。
+用户项目只声明 `@bams-app/ui-dev-server` 一个依赖，能力包与运行时依赖全部作为它的传递依赖解析到
+同一份包，提升到项目根 `node_modules`。
 
-### 为什么直接用 npm 命令带不动这些依赖
-
-能力包在 ui-dev-server 里声明为 `"*"`，运行时依赖是普通版本范围，而项目
-`package-lock.json` 已把它们逐个钉死在具体版本、且仍满足声明范围，npm 便不再重新解析：
-`npm install` 与 `npm update @bams-app/ui-dev-server` 都不会动它们；裸 `npm update` 虽能带上，
-但会重解析整棵依赖树、顺带升级其它第三方依赖。所以只能清掉它们在 lockfile 里的记录，
-让 npm 重新解析。
-
-### 升级步骤
+ui-dev-server 对能力包声明的是显式版本范围（`^x.y.z`），范围随 ui-dev-server 每次发布同步更新，
+因此升级就是一条命令：
 
 ```bash
-# 1. 按 ui-dev-server 的依赖清单清理 package-lock.json
-node -e "
-const fs = require('fs');
-const dev = JSON.parse(fs.readFileSync('node_modules/@bams-app/ui-dev-server/package.json', 'utf8'));
-const names = new Set([...Object.keys(dev.dependencies || {}), '@bams-app/ui-dev-server']);
-const lock = JSON.parse(fs.readFileSync('package-lock.json', 'utf8'));
-let removed = 0;
-for (const section of ['packages', 'dependencies']) {
-    const container = lock[section];
-    if (!container) continue;
-    for (const key of Object.keys(container)) {
-        const name = key.replace(/^.*node_modules\//, '');
-        if (names.has(name)) { delete container[key]; removed++; }
-    }
-}
-fs.writeFileSync('package-lock.json', JSON.stringify(lock, null, 2) + '\n');
-console.log('已清理', removed, '条由 ui-dev-server 提供的依赖记录');
-"
-
-# 2. 这些包按 ui-dev-server 声明的版本重新解析，其余依赖保持锁定不动
-npm install
+npm i @bams-app/ui-dev-server@latest
 ```
 
-清理范围必须覆盖 ui-dev-server 声明的**全部**依赖：只删 `@bams-app/*` 的话，能力包会刷新，
-但 vue / axios 等运行时依赖仍停在 lockfile 里的旧版本。
+新版本的依赖范围与 `package-lock.json` 中钉住的旧版本不再匹配，npm 会自动重新解析整套能力包，
+无需手工清理 lockfile（历史版本遗留的 `*` 范围才需要旧办法，见 git 历史）。
 
-只想升 ui-dev-server 本身、不在意它带的依赖时，直接 `npm i @bams-app/ui-dev-server@latest`。
-跨大版本（0.1 → 0.2）先改 `package.json` 为 `"^0.2.0"`，再执行上面的两步。
+跨大版本（0.1 → 0.2）同理，直接执行上面的命令即可。
 
 ### 前提
 
-- 升级前确保对应版本已发布：`"*"` 只解析 registry 上已发布的版本。
+- 升级前确保对应版本已发布：能力包与 ui-dev-server 由 `yarn publish-all` 同批次发布。
 - registry 指向：`create` 不生成项目 `.npmrc`，`@bams-app/*` 默认走官方 npm
-  （registry.npmjs.org）；仅在内网隔离、必须走私服时，才在项目 `.npmrc` 手动加
-  `@bams-app:registry=https://npm.hedpy.cn/`（私服若存在同名旧版本，会遮蔽官方新版）。
+  （切私服需在执行 `create` 时指定 registry）。
 
 ## 环境要求
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bams-app/work-cli",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "BAMS-Work 全局开发工具：复用 work 已发布的包（create-env / create-ui-*）提供项目初始化、组件创建与环境配置能力，开发调试由用户项目本地的 ui-dev-server 承担",
   "main": "index.js",
   "bin": {
@@ -13,12 +13,12 @@
     "templates"
   ],
   "dependencies": {
-    "@bams-app/create-env": "*",
-    "@bams-app/create-pages-entry": "*",
-    "@bams-app/create-pages-from-components": "*",
-    "@bams-app/create-ui-base": "*",
-    "@bams-app/create-ui-component": "*",
-    "@bams-app/create-ui-page": "*"
+    "@bams-app/create-env": "^0.1.3",
+    "@bams-app/create-pages-entry": "^0.1.3",
+    "@bams-app/create-pages-from-components": "^0.1.3",
+    "@bams-app/create-ui-base": "^0.1.3",
+    "@bams-app/create-ui-component": "^0.1.3",
+    "@bams-app/create-ui-page": "^0.1.3"
   },
   "engines": {
     "node": ">=16.7.0"

package/templates/project/.envs/.env.dev-demo

@@ -1,8 +1,54 @@
+# DEMO Environment (complete config)
+# ==================== 编译时变量（构建配置用，修改后需重启 dev server 或重新打包） ====================
+# 运行环境：development/production
 NODE_ENV=development
+# 开发服务器端口（以 PROXY_TARGET 端口为基准，建议保持一致）
 PORT=8700
+# 开发代理目标地址（vue.config.dev.js 中使用，端口号为基准）
 PROXY_TARGET=http://192.168.7.11:8700
+# 应用基础路径
 BASE_URL=/
+# 可配置组件插槽：登录页使用的组件（完整包名），例如 @bams-app/ui-login-component
+COMPONENT_LOGIN=@bams-app/ui-login-component
+# 可配置组件插槽：应用布局使用的组件（完整包名），例如 @bams-app/ui-startr-layout-component
+COMPONENT_STARTR_LAYOUT=@bams-app/ui-startr-layout-component
 
+# ==================== 编译注入 / 运行时读取变量 ====================
+# 应用标题：用于浏览器标签页显示
 VUE_APP_TITLE=BAMS组件开发环境
+# WebSocket 服务地址（用于实时消息推送），配置后自动进行连接，示例：/energy-ws
+VUE_APP_WEBSOCKET_URL=
+# 登录页面地址，外部登录页面地址，必须支持回调参数，默认走路由/login
+VUE_APP_LOGIN_URL=
+# 登录公钥（用于登录密码加密）
+VUE_APP_LOGIN_PUBLIC_KEY=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCPaHixlk2lAHJLVHcKxKsaxyP/oJUTmkFDCAdyKPMGurxjZWGeCj9Y2OciTlZXjhi1NTjliTPtWNVq6zM2bjMcU09jW+vcP7MmHGLzaA4Klv+SCYhDdxZ83ienPN9o8D5u8f+pKLrhe12yIcXHvyKFLisiBbQCcHzwOzXkVMN1UwIDAQAB
+# 系统编码：用于标识不同的业务系统，登录时传给后台接口
 VUE_APP_SYS_CODE=bams-apex
+# 系统名称：用于在界面上显示的系统名称
 VUE_APP_SYS_NAME=BAMS组件开发示例
+# 显示头部：设置为 true 显示startr应用头部，否则隐藏
+VUE_APP_SHOW_HEADER=true
+# DevExtreme 组件库许可证密钥，用于在应用中使用DevExtreme组件库
+VUE_APP_DEVEXTREME_LICENSE_KEY=
+# 主题功能开关：设置为 true 启用，不设置或其他值禁用
+VUE_APP_ENABLE_THEME=true
+# 默认主题模式：light | dark | auto，留空使用默认值 light
+VUE_APP_THEME_MODE=
+# 默认主题色：material.blue | material.teal | material.purple | material.lime | material.orange，留空使用默认值 material.blue
+VUE_APP_THEME_PRESET=
+# i18n 国际化功能开关：设置为 true 启用，不设置或其他值禁用
+VUE_APP_ENABLE_I18N=true
+# 版本日志功能开关：显式设置 true/1/on/yes 启用，不设置或其他值禁用
+VUE_APP_ENABLE_VERSION_LOG=true
+# Tabs 标签页展开/收起功能：留空不开启（默认收起）；expanded 开启且默认展开；collapsed 开启且默认收起
+VUE_APP_TABS_EXPAND_STATE=expanded
+# 版本变化检测功能开关：显式设置 true/1/on/yes 启用版本检测，不设置或其他值禁用（默认关闭）；调试模式由代码参数 debug 控制
+VUE_APP_ENABLE_VERSION_CHECK=true
+# 运行时环境变量功能开关：开启后应用启动时从后台接口加载当前系统的环境变量配置，运行时覆盖构建注入值，无需重新打包即可调整前端配置；显式设置 true/1/on/yes 启用，不设置或其他值禁用（默认关闭）
+VUE_APP_ENABLE_RUNTIME_ENV=false
+# 登录验证码功能开关：设置为 true 启用，不设置或其他值禁用
+VUE_APP_ENABLE_CAPTCHA=false
+# 消息告警通知开关：设置为 true 启用，不设置或其他值禁用（默认关闭）
+VUE_APP_ENABLE_MESSAGE_VOICE=true
+# 消息告警通知 WS 地址：留空使用默认 /message（自动补全为当前 host），本地联调可配完整地址如 ws://localhost:9090/ws
+VUE_APP_MESSAGE_WS_URL=

package/templates/project/README.md

@@ -13,6 +13,14 @@ demo-ui/ui-component-demo   # 示例组件
 <scope>-ui/ui-xxx           # 业务组件（add 时创建）
 ```
 
+## 前置条件（必需）
+
+必须先全局安装 CLI，否则 `work` 命令（`work add` / `work env` / `work pages-entry`）不可用：
+
+```bash
+npm i -g @bams-app/work-cli
+```
+
 ## 开始
 
 ```bash
@@ -32,40 +40,26 @@ npm run dev:ui demo -- --port 8080          # `--` 之后透传给 vue-cli-servi
 
 ## 命令
 
-| 命令                                                                                    | 作用                                                                        |
-| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
-| `npm run dev:ui <环境标识> [组件名]`                                                    | 启动开发服务                                                                |
+| 命令                                                                               | 作用                                                                        |
+| ---------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `npm run dev:ui <环境标识> [组件名]`                                               | 启动开发服务                                                                |
 | `work add --dir <scope> --name <name> [--type component\|page\|base] [--desc ...]` | 新建组件/页面/基础组件；scope 目录不存在会自动创建并注册到根 `package.json` |
-| `work env` | 交互式生成 `.envs/.env.dev-<标识>` |
-| `work pages-entry --dir <scope> --type page\|component` | 生成构建用动态入口（内部使用） |
-| `work pages-from-components --dir <scope>` | 把 `ui-*` 批量复制为 `page-*` |
+| `work env`                                                                         | 交互式生成 `.envs/.env.dev-<标识>`                                          |
+| `work pages-entry --dir <scope> --type page\|component`                            | 生成构建用动态入口（内部使用）                                              |
+| `work pages-from-components --dir <scope>`                                         | 把 `ui-*` 批量复制为 `page-*`                                               |
 
 环境文件字段：`PORT`、`PROXY_TARGET`、`BASE_URL`、`VUE_APP_*` 等，见模板文件；改完重跑 `dev:ui` 生效。
 
 ## 依赖升级
 
 项目只声明 `@bams-app/ui-dev-server`，能力包与 vue、devextreme 等运行时依赖都由它提供并提升到根 `node_modules`。
+ui-dev-server 对能力包声明的是显式版本范围（`^x.y.z`），范围随它每次发布同步更新，因此升级就是一条命令：
 
 ```bash
-npm i @bams-app/ui-dev-server@latest   # 只换 ui-dev-server
+npm i @bams-app/ui-dev-server@latest
 ```
 
-lockfile 会把 ui-dev-server 提供的包逐个钉死；要连带刷新这些包，先清理记录再安装：
-
-```bash
-node -e "
-const fs=require('fs');
-const dev=JSON.parse(fs.readFileSync('node_modules/@bams-app/ui-dev-server/package.json','utf8'));
-const names=new Set([...Object.keys(dev.dependencies||{}),'@bams-app/ui-dev-server']);
-const lock=JSON.parse(fs.readFileSync('package-lock.json','utf8'));
-let n=0;
-for(const s of ['packages','dependencies']){const c=lock[s];if(!c)continue;
-for(const k of Object.keys(c))if(names.has(k.replace(/^.*node_modules\//,''))){delete c[k];n++}}
-fs.writeFileSync('package-lock.json',JSON.stringify(lock,null,2)+'\n');
-console.log('已清理',n,'条');
-"
-npm install
-```
+新范围与 `package-lock.json` 中钉住的旧版本不再匹配，npm 会自动重新解析整套能力包，无需手工清理 lockfile。
 
 全局 CLI 升级：`npm i -g @bams-app/work-cli@latest`。