pangu-vis-cli 1.0.4 → 1.2.0

package/README.md

@@ -1,28 +1,25 @@
 # pangu-vis-cli
 
-> 盘古可视化图表开发工具链 - 一站式图表创建、开发、打包、上传解决方案
+> 盘古可视化平台的图表包脚手架与开发辅助工具
 
 ## 简介
 
-`pangu-vis-cli` 是一个专为盘古可视化平台设计的命令行工具，提供图表包的创建、开发调试、打包构建、上传发布等完整工作流支持。通过简洁的命令，开发者可以快速创建标准化的图表项目，进行本地开发调试，并一键打包上传至泰合社区。
+`pangu-vis-cli` 是一个专为盘古可视化平台设计的图表包脚手架与开发辅助工具，覆盖图表包创建、本地开发调试与打包构建。通过简洁的命令，开发者可以快速创建标准化的图表项目，进行本地开发调试，并一键打包为 tar.gz 发布产物。1.1.0 起本工具聚焦脚手架与开发辅助，tar.gz 发布产物面向盘古可视化平台使用。
 
 **核心价值**：
 
 - 🚀 **快速初始化** - 一键创建标准化图表项目模板
-- 🔧 **开发友好** - 本地开发环境自动配置
-- 📦 **智能打包** - 版本管理、自动压缩、依赖优化
-- 📤 **便捷发布** - 认证上传至图表社区
+- 🔧 **开发友好** - 一键启动图表包本地开发调试
+- 📦 **智能打包** - 版本同步、自动压缩、一键生成 tar.gz 发布产物
 - ⚙️ **灵活配置** - 自动化行为可自定义
 
 ## 特性
 
-- ✅ 支持 8 种图表类型（折线图、柱状图、饼图、表格、地图、文本、指标、交互）
+- ✅ 支持 9 种图表类型（折线图、柱状图、饼图、表格、地图、文本、指标、交互、其他）
 - ✅ 可选 TypeScript 支持
 - ✅ 交互式命令行提示
-- ✅ 自动版本同步（base.json ↔ package.json）
-- ✅ 并发打包优化
-- ✅ tar.gz 压缩包生成
-- ✅ 用户认证与 token 管理
+- ✅ 自动版本同步（public/base.json ↔ package.json）
+- ✅ 单图表一键打包为 tar.gz
 - ✅ 自动更新检测
 - ✅ 跨平台支持（macOS / Windows / Linux）
 
@@ -88,18 +85,14 @@ pnpm dev
 # 1. 创建图表包
 pv create my-chart
 
-# 2. 开发调试
+# 2. 进入图表包目录
 cd packages/components/my-chart
+
+# 3. 启动开发环境
 pnpm dev
 
-# 3. 打包构建（在图表包目录）
+# 4. 打包构建（在图表包目录）
 pv build
-
-# 4. 用户认证
-pv auth
-
-# 5. 上传发布
-pv upload my-chart_v1.0.0.tar.gz
 ```
 
 ## 命令详解
@@ -128,7 +121,7 @@ pv c <project-name>
    - `text` - 文本
    - `indicator` - 指标
    - `interaction` - 交互
-   - `other` - 其他
+   - `other` - 其他（默认选中，推荐）
 
 2. **TypeScript 支持**：
    - `yes` - 启用 TypeScript
@@ -137,6 +130,7 @@ pv c <project-name>
 3. **图表命名规则**：
    - 必须以小写字母开头
    - 仅允许小写字母、数字、下划线
+   - 长度 1-100 字符
    - 推荐添加自定义前缀防止冲突
 
 **示例**：
@@ -152,8 +146,14 @@ pv create custom_bar_chart
 
 **创建目录结构**：
 
-- 在图表库根目录下：`packages/components/<project-name>/`
-- 在 tailored 目录下：`packages/tailored/<project-name>/`
+图表创建位置取决于当前工作目录：
+
+- **当前目录或其上级目录（最多向上 10 层）具备图表库特征**（`package.json` 包名含 `pangu` + `packages/components` + `packages/tailored`）：
+  - 在特征目录下归位：`packages/components/<project-name>/`
+  - 运行路径包含 "tailored" 时：`packages/tailored/<project-name>/`
+
+- **其他目录**：
+  - 当前目录下创建：`./<project-name>/`
 
 **自动执行**：
 
@@ -165,7 +165,7 @@ pv create custom_bar_chart
 
 ### pv build - 单个图表打包
 
-打包单个图表组件为 tar.gz 压缩包，准备上传。
+打包单个图表组件为 tar.gz 压缩包。
 
 **别名**：`pv b`
 
@@ -193,14 +193,13 @@ pv build packages/components/my-chart
 
 **打包流程**：
 
-1. 版本同步（`base.json` ↔ `package.json`）
+1. 版本同步（`public/base.json` ↔ `package.json`）
 2. 执行 `pnpm build`
 3. 生成产物目录：`<chart-name>_v<version>/`
 4. 可选删除 `es/` 目录（根据配置）
-5. 过滤无用文件（`.git`, `.vscode`, `.DS_Store`）
+5. 过滤无用文件（`.git`, `.vscode`, `.DS_Store`, `.idea`）
 6. 打包为 tar.gz：`<chart-name>_v<version>.tar.gz`
 7. 可选删除打包目录（根据配置 `autoRemove`）
-8. 可选自动上传（根据配置 `autoUpload`）
 
 **产物文件**：
 
@@ -220,12 +219,9 @@ my-chart_v1.0.0.tar.gz
 
 ```bash
 pv dev              # 启动当前目录开发环境
-pv dev <path>       # 启动指定路径开发环境
 ```
 
-**参数**：
-
-- `<path>` - 图表包路径
+需先 cd 到图表包目录再执行。
 
 **示例**：
 
@@ -233,146 +229,16 @@ pv dev <path>       # 启动指定路径开发环境
 # 在图表包目录下执行
 cd packages/components/my-chart
 pv dev
-
-# 指定路径启动
-pv dev packages/components/my-chart
 ```
 
 **自动检测**：
 
-- 查找 `package.json` 中的 `dev` 或 `serve` 脚本
-- 执行 `pnpm dev` 或 `pnpm serve`
+- 查找 `package.json` 中的 `dev` 脚本
+- 执行 `<探测到的包管理器> run dev`
 - 实时预览图表开发效果
 
 ---
 
-### pv upload - 上传图表包
-
-上传打包后的 tar.gz 文件至泰合社区服务器。
-
-**别名**：`pv u`
-
-**前置条件**：需先通过 `pv auth` 进行用户认证。
-
-**用法**：
-
-```bash
-pv upload                      # 上传当前目录所有 .tar.gz 文件
-pv upload <file.tar.gz>        # 上传指定 tar.gz 文件
-pv upload <path>               # 上传指定目录下的所有 .tar.gz 文件
-```
-
-**参数**：
-
-- `<file.tar.gz>` - tar.gz 文件路径
-- `<path>` - 目录路径
-
-**示例**：
-
-```bash
-# 用户认证（首次）
-pv auth
-
-# 上传当前目录所有 tar.gz
-pv upload
-
-# 上传指定文件
-pv upload my-chart_v1.0.0.tar.gz
-
-# 上传指定目录下的所有 tar.gz
-pv upload dist/
-```
-
-**认证要求**：
-
-- 未登录时自动触发认证流程
-- 需输入泰合社区用户名和密码
-- token 自动保存，后续无需重复登录
-
----
-
-### pv auth - 用户认证
-
-登录泰合社区，获取上传权限。
-
-**别名**：`pv a`
-
-**用法**：
-
-```bash
-pv auth                    # 交互式登录
-pv auth <user> <password>  # 命令行登录
-```
-
-**参数**：
-
-- `<user>` - 泰合社区用户名
-- `<password>` - 泰合社区密码
-
-**示例**：
-
-```bash
-# 交互式登录（推荐）
-pv auth
-# 按提示输入用户名和密码
-
-# 命令行登录
-pv auth myuser mypassword
-```
-
-**认证流程**：
-
-1. 输入用户名和密码（密码经 MD5 加密）
-2. 请求服务器 token
-3. 保存认证信息至本地配置文件
-
-**认证信息存储位置**：
-
-```
-~/.pangu-vis-store/.cli_store
-```
-
-**认证失败处理**：
-
-- 失败后可重试（最多 3 次）
-- 失败 3 次后提示稍后尝试
-
----
-
-### pv tar - tar 打包工具
-
-通用的 tar.gz 打包命令，可打包任意目录或文件。
-
-**别名**：`pv t`
-
-**用法**：
-
-```bash
-pv tar <targetDir> <name> [distDir] [distName]
-```
-
-**参数**：
-
-- `<targetDir>` - 目标目录（必需）
-- `<name>` - 打包文件名（必需）
-- `<distDir>` - 输出目录（可选，默认为 targetDir）
-- `<distName>` - 输出文件名（可选，默认为 name）
-
-**示例**：
-
-```bash
-# 打包当前目录下的 dist 为 dist.tar.gz
-pv tar ./dist dist
-
-# 打包并指定输出目录
-pv tar ./dist dist ./output
-
-# 打包并指定输出文件名
-pv tar ./dist dist ./output my-dist
-```
-
----
-
 ### pv config - 配置管理
 
 配置 CLI 工具的自动化行为。
@@ -389,7 +255,6 @@ pv config
 
 | 配置项         | 说明                           | 默认值       |
 | -------------- | ------------------------------ | ------------ |
-| `autoUpload`   | 图表打包后是否自动上传泰合社区 | `no` (false) |
 | `autoRemove`   | 打包后是否自动删除打包目录     | `yes` (true) |
 | `autoRemoveEs` | 打包后是否移除 es 目录         | `yes` (true) |
 
@@ -410,12 +275,10 @@ pv config
 
 ```json
 {
-  "user": "your-username",
-  "password": "your-password",
-  "token": "your-token",
-  "autoUpload": false,
-  "autoRemove": true,
-  "autoRemoveEs": true
+	"autoRemove": true,
+	"autoRemoveEs": true,
+	"lastUpdateCheck": 1788480000000,
+	"privateRegistry": "http://192.168.12.88:10000"
 }
 ```
 
@@ -435,10 +298,9 @@ pv update
 
 **更新流程**：
 
-1. 检查 npm 是否有新版本
-2. 提示是否更新
-3. 执行全局安装：`npm i -g pangu-vis-cli`
-4. macOS/Linux 自动启用 sudo（如需）
+1. 检查 npm 源最新版本
+2. 安装前确认提示「是否安装 <版本>？」（默认 yes，可跳过；跳过后提示稍后可再运行 `pvis update`）
+3. 优先用探测到的 pnpm（不可用时回退 npm）执行 `install -g pangu-vis-cli@latest`
 
 **示例**：
 
@@ -447,10 +309,11 @@ pv update
 pv update
 
 # 已是最新版本提示
-当前版本已是最新！
+当前已是最新版本 1.1.0
 
 # 有新版本时提示
-是否更新Cli工具？ yes/no
+发现新版本 1.2.0，当前版本 1.1.0
+是否安装 1.2.0？
 ```
 
 **自动检查**：
@@ -470,16 +333,16 @@ CLI 配置信息存储在用户主目录：
 ~/.pangu-vis-store/.cli_store
 ```
 
+可通过环境变量 `PANGU_CONFIG_DIR` 覆盖配置目录位置。
+
 ### 配置项说明
 
-| 配置项         | 类型    | 说明                    | 默认值  |
-| -------------- | ------- | ----------------------- | ------- |
-| `user`         | string  | 泰合社区用户名          | `''`    |
-| `password`     | string  | 泰合社区密码（MD5加密） | `''`    |
-| `token`        | string  | 认证 token              | `''`    |
-| `autoUpload`   | boolean | 打包后自动上传          | `false` |
-| `autoRemove`   | boolean | 打包后删除打包目录      | `true`  |
-| `autoRemoveEs` | boolean | 打包后删除 es 目录      | `true`  |
+| 配置项            | 类型    | 说明                                                         | 默认值     |
+| ----------------- | ------- | ------------------------------------------------------------ | ---------- |
+| `autoRemove`      | boolean | 打包后是否自动删除打包目录                                   | `true`     |
+| `autoRemoveEs`    | boolean | 打包后是否自动删除 es 目录                                   | `true`     |
+| `lastUpdateCheck` | number  | 更新检查节流时间戳（可选）                                   | 无         |
+| `privateRegistry` | string  | 私有 npm 源（可选，优先级：`PANGU_REGISTRY` 环境变量 > 配置文件 > 内网默认源） | 内网默认源 |
 
 ### 修改配置
 
@@ -492,21 +355,9 @@ pv config
 **方法 2：手动编辑**
 编辑 `~/.pangu-vis-store/.cli_store` 文件。
 
-### 清除认证
-
-如需重新登录，删除配置文件中的 `token` 字段：
-
-```bash
-# 编辑配置文件
-vi ~/.pangu-vis-store/.cli_store
-
-# 删除 token 行后重新认证
-pv auth
-```
-
 ## 使用示例
 
-### 示例 1：创建并发布折线图
+### 示例：创建并打包折线图
 
 完整流程演示：
 
@@ -525,43 +376,17 @@ pnpm dev
 # 4. 开发完成后，打包图表
 pv build
 # 生成：custom_line_chart_v1.0.0.tar.gz
-
-# 5. 用户认证
-pv auth
-# 输入泰合社区用户名和密码
-
-# 6. 上传发布
-pv upload custom_line_chart_v1.0.0.tar.gz
-# 上传成功提示
-```
-
-### 示例 2：自动化配置
-
-配置打包后自动上传：
-
-```bash
-# 配置自动上传
-pv config
-# 选择：autoUpload = yes
-
-# 以后打包会自动上传
-pv build my-chart
-# 打包完成后自动上传，无需手动执行 pv upload
 ```
 
 ## 命令速查表
 
-| 命令        | 别名     | 说明         | 是否需要认证             |
-| ----------- | -------- | ------------ | ------------------------ |
-| `pv create` | `pv c`   | 创建图表包   | 可选（登录可注册图表ID） |
-| `pv pack`   | `pv pk`  | 图表库打包   | ❌                       |
-| `pv build`  | `pv b`   | 单个图表打包 | ❌                       |
-| `pv dev`    | `pv d`   | 启动开发环境 | ❌                       |
-| `pv upload` | `pv u`   | 上传图表包   | ✅                       |
-| `pv auth`   | `pv a`   | 用户认证     | ❌                       |
-| `pv tar`    | `pv t`   | tar 打包工具 | ❌                       |
-| `pv config` | `pv set` | 配置管理     | ❌                       |
-| `pv update` | `pv up`  | CLI 更新     | ❌                       |
+| 命令        | 别名     | 说明         |
+| ----------- | -------- | ------------ |
+| `pv create` | `pv c`   | 创建图表包   |
+| `pv build`  | `pv b`   | 单个图表打包 |
+| `pv dev`    | `pv d`   | 启动开发环境 |
+| `pv config` | `pv set` | 配置管理     |
+| `pv update` | `pv up`  | CLI 更新     |
 
 ## 常见问题
 
@@ -576,39 +401,26 @@ sudo npm install -g pangu-vis-cli
 **Windows**：
 以管理员身份运行终端，再执行安装命令。
 
-### 2. 登录认证失败
-
-- 检查用户名和密码是否正确
-- 确认泰合社区账号已激活
-- 失败 3 次后需稍后再试
-
-### 3. 图表包名称重复
+### 2. 图表包名称重复
 
 - 使用自定义前缀避免冲突
-- 遵循命名规则：小写字母开头，仅允许字母、数字、下划线
+- 遵循命名规则：小写字母开头，仅允许小写字母、数字、下划线
 
-### 4. 打包产物找不到
+### 3. 打包产物找不到
 
 - 检查配置 `autoRemove` 是否为 `yes`
 - 打包产物默认在图表包目录下
-- 使用 `pv tar` 手动指定输出目录
-
-### 5. 上传失败
-
-- 确认已通过 `pv auth` 认证
-- 检查网络连接（泰合社区服务器）
-- 确认 tar.gz 文件格式正确
 
-### 6. 版本号不同步
+### 4. 版本号不同步
 
-- CLI 自动同步 `base.json` 和 `package.json` 版本
+- CLI 自动同步 `public/base.json` 和 `package.json` 版本
 - 手动修改版本时需同时更新两个文件
 - 或使用 `pv build` 自动同步
 
-### 7. 开发环境启动失败
+### 5. 开发环境启动失败
 
 - 确认已安装 `pnpm`
-- 检查 `package.json` 中是否有 `dev` 或 `serve` 脚本
+- 检查 `package.json` 中是否有 `dev` 脚本
 - 安装依赖：`pnpm install`
 
 ## 许可证
@@ -622,8 +434,3 @@ Copyright (c) 2023 Jaxon
 **Jaxon**
 
 如有问题或建议，请联系作者或在项目仓库提交 Issue。
-
----
-
-**最后更新**：2026-06-17
-**版本**：1.0.0