pangu-vis-cli 1.0.4 → 1.1.0

package/README.md

@@ -152,8 +152,16 @@ pv create custom_bar_chart
 
 **创建目录结构**：
 
-- 在图表库根目录下：`packages/components/<project-name>/`
-- 在 tailored 目录下：`packages/tailored/<project-name>/`
+图表创建位置取决于当前工作目录：
+
+- **图表库根目录运行**（有 `package.json` + `packages/components` + `packages/tailored`）：
+  - 默认：`packages/components/<project-name>/`
+  - 当前目录包含 "tailored"：`packages/tailored/<project-name>/`
+
+- **其他目录运行**（如子目录、临时目录、独立项目）：
+  - 当前目录下创建：`./<project-name>/`
+
+> 💡 **提示**：在子目录运行时，图表会在当前目录创建，不会跳转到根目录 `packages/`。
 
 **自动执行**：
 
@@ -165,7 +173,7 @@ pv create custom_bar_chart
 
 ### pv build - 单个图表打包
 
-打包单个图表组件为 tar.gz 压缩包，准备上传。
+打包单个图表组件为 tar.gz 压缩包。
 
 **别名**：`pv b`
 
@@ -197,7 +205,7 @@ pv build packages/components/my-chart
 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`）
@@ -410,12 +418,12 @@ pv config
 
 ```json
 {
-  "user": "your-username",
-  "password": "your-password",
-  "token": "your-token",
-  "autoUpload": false,
-  "autoRemove": true,
-  "autoRemoveEs": true
+	"user": "your-username",
+	"password": "your-password",
+	"token": "your-token",
+	"autoUpload": false,
+	"autoRemove": true,
+	"autoRemoveEs": true
 }
 ```
 
@@ -506,7 +514,7 @@ pv auth
 
 ## 使用示例
 
-### 示例 1：创建并发布折线图
+### 示例：创建并打包折线图
 
 完整流程演示：
 
@@ -525,28 +533,6 @@ 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
 ```
 
 ## 命令速查表
@@ -554,7 +540,6 @@ pv build my-chart
 | 命令        | 别名     | 说明         | 是否需要认证             |
 | ----------- | -------- | ------------ | ------------------------ |
 | `pv create` | `pv c`   | 创建图表包   | 可选（登录可注册图表ID） |
-| `pv pack`   | `pv pk`  | 图表库打包   | ❌                       |
 | `pv build`  | `pv b`   | 单个图表打包 | ❌                       |
 | `pv dev`    | `pv d`   | 启动开发环境 | ❌                       |
 | `pv upload` | `pv u`   | 上传图表包   | ✅                       |
@@ -611,6 +596,28 @@ sudo npm install -g pangu-vis-cli
 - 检查 `package.json` 中是否有 `dev` 或 `serve` 脚本
 - 安装依赖：`pnpm install`
 
+## 开发环境（本仓库）
+
+| 项         | 要求/工具                                                                                                                                      |
+| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| Node.js    | `>=20.19.0`（engines 强制）                                                                                                                    |
+| TypeScript | `7.0.2`（原生编译器线，仅类型检查，esbuild 出产物；编辑器语言服务走 VS Code 内置 TS 扩展，原生 LSP 可选装 "TypeScript (Native Preview)" 扩展） |
+| 代码检查   | `oxlint`（配置 `.oxlintrc.json`）                                                                                                              |
+| 代码格式化 | `oxfmt`（配置 `.oxfmtrc.json`，tab 缩进、行宽 100、双引号、分号、ES5 尾逗号）                                                                  |
+| 单元测试   | `vitest`（302 用例）                                                                                                                           |
+| 包管理     | `nub`（兼容 pnpm 参数）                                                                                                                        |
+
+常用开发命令（本仓库统一 `nub`，禁用 npm/pnpm/yarn/npx）：
+
+```bash
+nub install            # 安装依赖
+nub run typecheck      # tsc 7.0.2 类型检查
+nub run test:run       # vitest 全量测试
+nub run lint           # oxlint 检查
+nub run format:check   # oxfmt 格式检查
+nub run build          # esbuild 构建
+```
+
 ## 许可证
 
 [MIT License](./LICENSE)