@coze-arch/cli 0.0.9 → 0.0.10-alpha.1717be

package/lib/__templates__/cli/.coze

@@ -0,0 +1,11 @@
+[project]
+requires = ["nodejs-24"]
+
+[dev]
+run = ["bash", "./scripts/dev.sh"]
+deps = ["git"] # -> apt install git
+
+[deploy]
+build = ["bash","./scripts/build.sh"]
+run = ["bash","./scripts/publish.sh"]
+deps = ["git"] # -> apt install git

package/lib/__templates__/cli/AGENTS.md

@@ -0,0 +1,46 @@
+# 项目上下文
+
+### 版本技术栈
+
+- **Framework**: Node.js CLI
+- **Command Parser**: Commander.js 12
+- **Interactive Prompts**: Inquirer.js 5 (@inquirer/prompts)
+- **Visuals**: Chalk 4, Ora 8
+- **Language**: TypeScript 5
+
+## 目录结构
+
+```
+├── scripts/                # 构建与启动脚本
+│   ├── build.sh            # 构建脚本
+│   ├── dev.sh              # 开发环境启动脚本
+│   ├── prepare.sh          # 预处理与全局链接脚本
+│   └── start.sh            # 生产环境执行脚本
+├── src/
+│   └── index.ts            # CLI 入口文件与核心逻辑
+├── .coze                   # Coze 部署与运行配置
+├── package.json            # 项目依赖管理
+└── tsconfig.json           # TypeScript 配置
+```
+
+- 项目源代码默认存放在 `src/` 目录下。
+- 编译产物默认输出到 `dist/` 目录下。
+
+## 包管理规范
+
+**仅允许使用 pnpm** 作为包管理器，**严禁使用 npm 或 yarn**。
+**常用命令**：
+- 安装依赖：`pnpm add <package>`
+- 安装开发依赖：`pnpm add -D <package>`
+- 安装所有依赖：`pnpm install`
+- 移除依赖：`pnpm remove <package>`
+
+## 开发规范
+
+- **项目理解加速**：优先阅读 `package.json` 的 `bin` 和 `scripts` 字段，以及 `src/index.ts` 入口文件来理解 CLI 命令的挂载点。
+- **CLI 交互设计**：
+  - 尽量使用 `@inquirer/prompts` 提供交互式问询，提升用户体验。
+  - 对于耗时任务，必须使用 `ora` 提供明确的 Loading 状态。
+  - 对于成功/失败/警告信息，使用 `chalk` 进行颜色区分输出。
+- **参数解析**：使用 `commander` 来声明参数、选项和自动生成帮助文档（`--help`）。避免手动解析 `process.argv`。
+- **本地调试**：由于 CLI 涉及到全局命令注册，开发过程中使用 `scripts/dev.sh`（内部使用了 `tsc --watch` 监听并编译代码，配合初始化的 `pnpm link --global`）来进行热更新调试。

package/lib/__templates__/cli/README.md

@@ -0,0 +1,19 @@
+# <%= appName %>
+
+A standard CLI application built with [Commander.js](https://github.com/tj/commander.js) and [Inquirer.js](https://github.com/SBoudrias/Inquirer.js).
+
+## Getting Started
+
+```bash
+# Install dependencies
+pnpm install
+
+# Start development (watch mode)
+pnpm dev
+
+# Build the CLI
+pnpm build
+
+# Run the built CLI
+pnpm start
+```

package/lib/__templates__/cli/_gitignore

@@ -0,0 +1,59 @@
+# Dependencies
+node_modules/
+.pnp
+.pnp.js
+
+# Production build
+dist/
+build/
+out/
+
+# Testing
+coverage/
+*.lcov
+.nyc_output
+
+# Environment variables
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Logs
+logs/
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+!.vscode/settings.json
+.idea/
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+*.swp
+*.swo
+*~
+
+# OS files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+Desktop.ini
+
+# TypeScript
+*.tsbuildinfo
+
+.coze-logs

package/lib/__templates__/cli/_npmrc

@@ -0,0 +1,3 @@
+registry=https://registry.npmmirror.com
+strict-peer-dependencies=false
+auto-install-peers=true

package/lib/__templates__/cli/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "<%= appName %>",
+  "version": "1.0.0",
+  "private": true,
+  "description": "CLI Tool Template",
+  "type": "module",
+  "bin": {
+    "<%= appName %>": "dist/index.js"
+  },
+  "scripts": {
+    "build": "bash ./scripts/build.sh",
+    "dev": "bash ./scripts/dev.sh",
+    "preinstall": "npx only-allow pnpm",
+    "lint": "eslint",
+    "publish": "bash ./scripts/publish.sh"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^5.0.7",
+    "chalk": "^4.1.2",
+    "commander": "~12.1.0",
+    "ora": "^8.0.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.9",
+    "only-allow": "^1.2.2",
+    "typescript": "^5.5.2"
+  },
+  "packageManager": "pnpm@9.0.0",
+  "engines": {
+    "pnpm": ">=9.0.0"
+  }
+}