feng3d-cli 0.0.12 → 0.1.0

package/.claude-skill/README.md

@@ -0,0 +1,260 @@
+# feng3d Claude Code Skill
+
+这是 feng3d-cli 的 Claude Code Skill 配置，允许你在 Claude Code 中直接使用 feng3d-cli 功能。
+
+## 快速安装 🚀
+
+### 方法 1：一条命令安装（最简单）⭐
+
+```bash
+npx feng3d-cli skill
+```
+
+**就这么简单！** 这条命令会：
+- ✅ 自动下载 feng3d-cli（如果未安装）
+- ✅ 将 skill 复制到 `~/.claude/skills/feng3d`
+- ✅ 无需额外配置或权限
+
+> 💡 提示：也可以使用完整命令 `npx feng3d-cli install-skill`
+
+如果你需要经常使用，可以先全局安装：
+
+```bash
+npm install -g feng3d-cli
+feng3d-cli skill
+```
+
+### 方法 2：一键安装脚本
+
+**macOS / Linux**：
+```bash
+curl -fsSL https://raw.githubusercontent.com/feng3d-labs/feng3d-cli/master/.claude-skill/install.sh | bash
+```
+
+或者手动下载并执行：
+```bash
+wget https://raw.githubusercontent.com/feng3d-labs/feng3d-cli/master/.claude-skill/install.sh
+chmod +x install.sh
+./install.sh
+```
+
+**Windows (PowerShell)**：
+```powershell
+irm https://raw.githubusercontent.com/feng3d-labs/feng3d-cli/master/.claude-skill/install.ps1 | iex
+```
+
+或者手动下载并执行：
+```powershell
+Invoke-WebRequest -Uri "https://raw.githubusercontent.com/feng3d-labs/feng3d-cli/master/.claude-skill/install.ps1" -OutFile "install.ps1"
+.\install.ps1
+```
+
+---
+
+## 手动安装方法
+
+### 方式 1：本地安装（推荐用于开发）
+
+将此 skill 复制到你的 Claude Code skills 目录：
+
+```bash
+# 创建 skills 目录（如果不存在）
+mkdir -p ~/.claude/skills
+
+# 复制 skill 到 Claude 配置目录
+cp -r .claude-skill ~/.claude/skills/feng3d
+```
+
+### 方式 2：作为 npm 包发布（推荐用于团队使用）
+
+1. 在项目中添加 skill 相关文件到 npm 包：
+
+```json
+// package.json
+{
+  "files": [
+    "bin",
+    "dist",
+    "lib",
+    "templates",
+    ".claude-skill"
+  ]
+}
+```
+
+2. 发布到 npm（如果还没发布）：
+
+```bash
+npm publish
+```
+
+3. 用户安装后，创建符号链接：
+
+```bash
+npm install -g feng3d-cli
+ln -s $(npm root -g)/feng3d-cli/.claude-skill ~/.claude/skills/feng3d
+```
+
+### 方式 3：直接从 GitHub 使用
+
+```bash
+mkdir -p ~/.claude/skills
+git clone https://github.com/feng3d-labs/feng3d-cli.git /tmp/feng3d-cli
+cp -r /tmp/feng3d-cli/.claude-skill ~/.claude/skills/feng3d
+```
+
+## 使用方法
+
+安装后，在 Claude Code 中可以通过以下方式使用：
+
+### 方法 1：使用 /feng3d 命令（推荐）
+
+```bash
+# 创建新项目
+/feng3d create my-project
+
+# 更新当前项目
+/feng3d update
+
+# 创建项目（带选项）
+/feng3d create my-lib --no-examples
+```
+
+### 方法 2：直接对话
+
+你也可以直接告诉 Claude：
+
+- "用 feng3d 创建一个新项目"
+- "更新我的项目到最新的 feng3d 规范"
+- "帮我初始化一个 feng3d 项目"
+
+Claude 会自动调用 feng3d skill 来完成任务。
+
+## 功能说明
+
+### 创建项目 (create)
+
+创建一个符合 feng3d 规范的新项目，包含：
+
+- 统一的项目结构
+- 代码规范配置（ESLint）
+- TypeScript 配置
+- Vite 构建配置
+- Vitest 测试配置
+- GitHub Actions 工作流
+- Git pre-commit 钩子
+- 文档生成配置
+
+**选项**：
+- `-d, --directory <dir>` - 指定项目目录
+- `--no-examples` - 不创建 examples 目录
+- `--no-vitest` - 不包含 vitest 配置
+
+### 更新项目 (update)
+
+更新现有项目到最新的 feng3d 规范，会更新：
+
+- 所有配置文件
+- 依赖版本
+- GitHub Actions 工作流
+- 脚本文件
+
+**选项**：
+- `-d, --directory <dir>` - 指定项目目录
+
+## 示例对话
+
+### 示例 1：创建新项目
+
+```
+你：创建一个新的 feng3d 项目叫 my-library
+
+Claude：我会为你创建一个 feng3d 项目。
+[执行: npx feng3d-cli create my-library]
+
+项目创建成功！接下来你需要：
+1. cd my-library
+2. npm install
+3. npm run dev
+```
+
+### 示例 2：更新现有项目
+
+```
+你：更新当前项目到最新的 feng3d 标准
+
+Claude：我会更新你的项目配置。建议先提交当前更改，这样可以清楚地看到更新了哪些文件。
+[执行: npx feng3d-cli update]
+
+配置已更新！建议：
+1. 运行 git diff 查看更改
+2. 运行 npm install 安装新依赖
+3. 运行 npm test 确保测试通过
+```
+
+## 文件结构
+
+```
+.claude-skill/
+├── skill.json       # Skill 元数据配置
+├── prompt.md        # Skill 提示词指令
+└── README.md        # 使用文档（本文件）
+```
+
+## 开发和贡献
+
+如果你想改进这个 skill：
+
+1. 修改 [prompt.md](./prompt.md) 来调整 Claude 的行为
+2. 更新 [skill.json](./skill.json) 来修改元数据
+3. 测试 skill 是否正常工作
+4. 提交 Pull Request
+
+## 技术细节
+
+### 工作原理
+
+这个 skill 是一个"包装器"skill，它：
+
+1. 接收用户的指令
+2. 通过 Claude 的 Bash 工具调用 `npx feng3d-cli`
+3. 展示命令输出
+4. 提供后续建议
+
+### 与 feng3d-cli 的关系
+
+- Skill 不修改 feng3d-cli 的核心代码
+- 所有功能都通过调用 CLI 实现
+- feng3d-cli 可以独立使用，不依赖 skill
+- Skill 只是让在 Claude Code 中使用更方便
+
+## 常见问题
+
+### Q: 如何验证 skill 已安装？
+
+A: 在 Claude Code 中输入 `/help`，应该能看到 feng3d skill 列出。
+
+### Q: Skill 不工作怎么办？
+
+A: 检查：
+1. skill 文件是否正确复制到 `~/.claude/skills/feng3d/`
+2. skill.json 格式是否正确
+3. 重启 Claude Code
+
+### Q: 可以自定义 skill 的行为吗？
+
+A: 可以！编辑 `prompt.md` 文件来调整 Claude 的行为。
+
+### Q: 这个 skill 会随 feng3d-cli 更新吗？
+
+A: 如果使用方式 1 或 3，需要手动更新。如果使用方式 2（npm 包），运行 `npm update -g feng3d-cli` 后重新创建符号链接。
+
+## 相关链接
+
+- [feng3d-cli GitHub](https://github.com/feng3d-labs/feng3d-cli)
+- [feng3d-cli 文档](https://feng3d.com/feng3d-cli/)
+- [Claude Code 文档](https://github.com/anthropics/claude-code)
+
+## 许可证
+
+MIT

package/.claude-skill/SKILL.md

@@ -0,0 +1,188 @@
+---
+name: "feng3d-cli"
+description: "Create and update feng3d projects with unified standards, including ESLint, TypeScript, Vite, GitHub Actions, and pre-commit hooks. Automate project setup and configuration management for feng3d development."
+version: "0.1.0"
+author: "feng"
+category: "Development"
+tags:
+  - project-setup
+  - scaffolding
+  - standards
+  - typescript
+  - vite
+  - eslint
+  - automation
+  - cli
+complexity: "simple"
+repository: "https://github.com/feng3d-labs/feng3d-cli"
+---
+
+# feng3d-cli Skill
+
+Automate the creation and management of feng3d projects with unified standards.
+
+## What This Skill Does
+
+This skill enables Claude to help you:
+- Create new feng3d projects with complete standard configurations
+- Update existing projects to latest feng3d standards
+- Manage unified dependency versions across projects
+- Set up GitHub Actions workflows (CI/CD, Pages deployment, OSS upload)
+- Configure development tools (ESLint, TypeScript, Vite, Vitest, Husky)
+
+## When to Use This Skill
+
+Use this skill when:
+- Starting a new feng3d project
+- Updating project configurations to match team standards
+- Standardizing multiple projects across a monorepo
+- Setting up CI/CD pipelines for feng3d projects
+
+## Commands
+
+### Create New Project
+```bash
+npx feng3d-cli create <project-name> [options]
+```
+
+Options:
+- `-d, --directory <dir>` - Project directory (default: current directory)
+- `--no-examples` - Don't create examples directory
+- `--no-vitest` - Don't include vitest test configuration
+
+### Update Existing Project
+```bash
+npx feng3d-cli update [options]
+```
+
+Options:
+- `-d, --directory <dir>` - Project directory (default: current directory)
+
+### Install This Skill
+```bash
+npx feng3d-cli skill
+```
+
+## What Gets Created/Updated
+
+### Project Structure
+- `package.json` - Unified dependencies and scripts
+- `tsconfig.json` - TypeScript configuration
+- `vite.config.js` - Vite build configuration
+- `vitest.config.ts` - Vitest test configuration
+- `eslint.config.js` - ESLint linting rules
+- `typedoc.json` - Documentation generation
+
+### Templates
+- `LICENSE` - MIT license (Chinese)
+- `.gitignore` - Git ignore rules
+- `.cursorrules` - Cursor AI rules
+- `.vscode/settings.json` - VS Code settings
+- `.husky/pre-commit` - Pre-commit hooks (lint + test)
+
+### Scripts
+- `scripts/prepublish.js` - Pre-publish script
+- `scripts/postpublish.js` - Post-publish script
+- `scripts/postdocs.js` - Post-documentation script
+
+### GitHub Actions
+- `.github/workflows/pull-request.yml` - PR checks
+- `.github/workflows/publish.yml` - Publish to npm
+- `.github/workflows/pages.yml` - Deploy docs to GitHub Pages
+- `.github/workflows/upload-oss.yml` - Upload to Aliyun OSS
+
+## Code Standards
+
+### Indentation
+- Use 4 spaces
+
+### Quotes
+- Use single quotes
+
+### Naming Conventions
+- Variables and functions: camelCase
+- Classes and interfaces: PascalCase
+- Constants: UPPER_SNAKE_CASE
+
+### Git Commit Convention
+- Use Simplified Chinese
+- Follow Conventional Commits format
+- Types: feat, fix, refactor, perf, style, docs, test, chore, build, ci
+
+### Pre-commit Checks
+Before committing, automatically runs:
+1. ESLint code style check
+2. Unit tests via vitest
+
+## Unified Versions
+
+| Dependency | Version |
+|------------|---------|
+| TypeScript | 5.8.3 |
+| ESLint | 9.26.0 |
+| Vitest | ^3.1.3 |
+| Vite | ^6.3.5 |
+| TypeDoc | ^0.28.4 |
+
+## Examples
+
+### Example 1: Create a new library project
+```
+User: Create a feng3d library project called "my-3d-engine"
+
+Claude: I'll create a new feng3d project for you.
+[Executes: npx feng3d-cli create my-3d-engine]
+
+Project created! Next steps:
+1. cd my-3d-engine
+2. npm install
+3. npm run dev
+```
+
+### Example 2: Update project standards
+```
+User: Update my current project to latest feng3d standards
+
+Claude: I'll update your project configuration. Make sure you've committed changes first.
+[Executes: npx feng3d-cli update]
+
+Configuration updated! Review changes with `git diff`.
+```
+
+### Example 3: Create without examples
+```
+User: Create a feng3d project without the examples directory
+
+Claude: [Executes: npx feng3d-cli create my-project --no-examples]
+```
+
+## OSS Upload Configuration
+
+To enable OSS upload in GitHub Actions, configure these secrets in your repository:
+- `OSS_REGION` - OSS region (e.g., `oss-cn-hangzhou`)
+- `OSS_ACCESS_KEY_ID` - Aliyun AccessKey ID
+- `OSS_ACCESS_KEY_SECRET` - Aliyun AccessKey Secret
+- `OSS_BUCKET` - OSS Bucket name
+
+## Installation
+
+### Quick Install
+```bash
+npx feng3d-cli skill
+```
+
+### Manual Install
+```bash
+mkdir -p ~/.claude/skills
+cp -r .claude-skill ~/.claude/skills/feng3d
+```
+
+## Resources
+
+- [GitHub Repository](https://github.com/feng3d-labs/feng3d-cli)
+- [Documentation](https://feng3d.com/feng3d-cli/)
+- [npm Package](https://www.npmjs.com/package/feng3d-cli)
+
+## License
+
+MIT

package/.claude-skill/install.ps1

@@ -0,0 +1,76 @@
+# feng3d Skill 安装脚本（Windows PowerShell）
+
+$ErrorActionPreference = "Stop"
+
+$SkillDir = "$env:USERPROFILE\.claude\skills\feng3d"
+$RepoUrl = "https://github.com/feng3d-labs/feng3d-cli.git"
+
+Write-Host "📦 开始安装 feng3d Claude Code Skill..." -ForegroundColor Cyan
+
+# 创建 skills 目录
+Write-Host "1. 创建 skills 目录..." -ForegroundColor Yellow
+New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.claude\skills" | Out-Null
+
+# 检查是否已安装
+if (Test-Path $SkillDir) {
+    Write-Host "⚠️  检测到已安装的 skill，将进行更新..." -ForegroundColor Yellow
+    Remove-Item -Recurse -Force $SkillDir
+}
+
+# 检测安装方式
+if ((Test-Path ".git") -and (Test-Path ".claude-skill\skill.json")) {
+    # 本地仓库
+    Write-Host "2. 从本地仓库复制..." -ForegroundColor Yellow
+    Copy-Item -Path ".claude-skill" -Destination $SkillDir -Recurse -Force
+}
+elseif (Get-Command npm -ErrorAction SilentlyContinue) {
+    # 尝试从 npm 安装
+    Write-Host "2. 尝试从 npm 包安装..." -ForegroundColor Yellow
+    try {
+        $npmRoot = npm root -g 2>$null
+        $npmSkillPath = Join-Path $npmRoot "feng3d-cli\.claude-skill"
+
+        if (Test-Path $npmSkillPath) {
+            Copy-Item -Path $npmSkillPath -Destination $SkillDir -Recurse -Force
+        }
+        else {
+            throw "npm 包未找到"
+        }
+    }
+    catch {
+        Write-Host "   npm 包未找到，从 GitHub 克隆..." -ForegroundColor Yellow
+        $TempDir = Join-Path $env:TEMP "feng3d-cli-$(Get-Random)"
+        git clone --depth 1 $RepoUrl $TempDir
+        Copy-Item -Path "$TempDir\.claude-skill" -Destination $SkillDir -Recurse -Force
+        Remove-Item -Recurse -Force $TempDir
+    }
+}
+else {
+    # 从 GitHub 克隆
+    Write-Host "2. 从 GitHub 克隆..." -ForegroundColor Yellow
+    $TempDir = Join-Path $env:TEMP "feng3d-cli-$(Get-Random)"
+    git clone --depth 1 $RepoUrl $TempDir
+    Copy-Item -Path "$TempDir\.claude-skill" -Destination $SkillDir -Recurse -Force
+    Remove-Item -Recurse -Force $TempDir
+}
+
+# 验证安装
+if (Test-Path "$SkillDir\skill.json") {
+    Write-Host ""
+    Write-Host "✅ feng3d Skill 安装成功！" -ForegroundColor Green
+    Write-Host ""
+    Write-Host "安装位置: $SkillDir" -ForegroundColor Cyan
+    Write-Host ""
+    Write-Host "使用方法:" -ForegroundColor Yellow
+    Write-Host "  /feng3d create my-project"
+    Write-Host "  /feng3d update"
+    Write-Host ""
+    Write-Host "或直接对话: `"用 feng3d 创建一个新项目`"" -ForegroundColor Yellow
+    Write-Host ""
+    Write-Host "💡 提示: 可能需要重启 Claude Code 使 skill 生效" -ForegroundColor Cyan
+}
+else {
+    Write-Host ""
+    Write-Host "❌ 安装失败，请检查错误信息" -ForegroundColor Red
+    exit 1
+}

package/.claude-skill/install.sh

@@ -0,0 +1,66 @@
+#!/bin/bash
+# feng3d Skill 安装脚本（macOS/Linux）
+
+set -e
+
+SKILL_DIR="$HOME/.claude/skills/feng3d"
+REPO_URL="https://github.com/feng3d-labs/feng3d-cli.git"
+
+echo "📦 开始安装 feng3d Claude Code Skill..."
+
+# 创建 skills 目录
+echo "1. 创建 skills 目录..."
+mkdir -p "$HOME/.claude/skills"
+
+# 检查是否已安装
+if [ -d "$SKILL_DIR" ]; then
+    echo "⚠️  检测到已安装的 skill，将进行更新..."
+    rm -rf "$SKILL_DIR"
+fi
+
+# 检测安装方式
+if [ -d ".git" ] && [ -f ".claude-skill/skill.json" ]; then
+    # 本地仓库
+    echo "2. 从本地仓库复制..."
+    cp -r .claude-skill "$SKILL_DIR"
+elif command -v npm &> /dev/null; then
+    # 尝试从 npm 安装
+    echo "2. 尝试从 npm 包安装..."
+    npm_root=$(npm root -g 2>/dev/null || echo "")
+    if [ -n "$npm_root" ] && [ -d "$npm_root/feng3d-cli/.claude-skill" ]; then
+        cp -r "$npm_root/feng3d-cli/.claude-skill" "$SKILL_DIR"
+    else
+        echo "   npm 包未找到，从 GitHub 克隆..."
+        TEMP_DIR=$(mktemp -d)
+        git clone --depth 1 "$REPO_URL" "$TEMP_DIR"
+        cp -r "$TEMP_DIR/.claude-skill" "$SKILL_DIR"
+        rm -rf "$TEMP_DIR"
+    fi
+else
+    # 从 GitHub 克隆
+    echo "2. 从 GitHub 克隆..."
+    TEMP_DIR=$(mktemp -d)
+    git clone --depth 1 "$REPO_URL" "$TEMP_DIR"
+    cp -r "$TEMP_DIR/.claude-skill" "$SKILL_DIR"
+    rm -rf "$TEMP_DIR"
+fi
+
+# 验证安装
+if [ -f "$SKILL_DIR/skill.json" ]; then
+    echo ""
+    echo "✅ feng3d Skill 安装成功！"
+    echo ""
+    echo "安装位置: $SKILL_DIR"
+    echo ""
+    echo "使用方法:"
+    echo "  /feng3d create my-project"
+    echo "  /feng3d update"
+    echo ""
+    echo "或直接对话: \"用 feng3d 创建一个新项目\""
+    echo ""
+    echo "💡 提示: 可能需要重启 Claude Code 使 skill 生效"
+else
+    echo ""
+    echo "❌ 安装失败，请检查错误信息"
+    exit 1
+fi