feng3d-cli 0.0.11 → 0.1.0

package/.claude-skill/prompt.md

@@ -0,0 +1,182 @@
+# feng3d Skill
+
+You are helping users create and manage feng3d projects using the feng3d-cli tool.
+
+## Overview
+
+feng3d-cli is a command-line tool that provides:
+- Unified code standards (ESLint configuration)
+- Unified dependency version management
+- Project templates (LICENSE, .gitignore, tsconfig.json, vite.config.js, etc.)
+- GitHub Actions workflows (CI/CD, GitHub Pages deployment, OSS upload)
+- Git pre-commit hooks (code linting + unit tests)
+
+## Commands
+
+### 1. Create New Project
+
+**Command**: `npx feng3d-cli create <project-name> [options]`
+
+**Description**: Creates a new project following feng3d standards.
+
+**Options**:
+- `-d, --directory <dir>` - Project directory (default: current directory)
+- `--no-examples` - Do not create examples directory
+- `--no-vitest` - Do not include vitest test configuration
+
+**Examples**:
+```bash
+# Create a new project in current directory
+npx feng3d-cli create my-project
+
+# Create project in specific directory
+npx feng3d-cli create my-project -d ./packages
+
+# Create without examples
+npx feng3d-cli create my-project --no-examples
+
+# Create without vitest
+npx feng3d-cli create my-project --no-vitest
+```
+
+**What it creates**:
+- `package.json` with unified dependencies
+- `LICENSE` (MIT in Chinese)
+- `.gitignore`
+- `.cursorrules`
+- `tsconfig.json`
+- `vite.config.js`
+- `vitest.config.ts` (unless --no-vitest)
+- `eslint.config.js`
+- `typedoc.json`
+- `.vscode/settings.json`
+- `.husky/pre-commit` hook
+- `scripts/prepublish.js`, `scripts/postpublish.js`, `scripts/postdocs.js`
+- `.github/workflows/` (pull-request.yml, publish.yml, pages.yml, upload-oss.yml)
+- `src/index.ts`
+- `test/_.test.ts`
+- `examples/` directory (unless --no-examples)
+
+### 2. Update Existing Project
+
+**Command**: `npx feng3d-cli update [options]`
+
+**Description**: Updates all standard configuration files in an existing project.
+
+**Options**:
+- `-d, --directory <dir>` - Project directory (default: current directory)
+
+**Examples**:
+```bash
+# Update current project
+npx feng3d-cli update
+
+# Update specific project
+npx feng3d-cli update -d ./my-project
+```
+
+**What it updates**:
+- All configuration files (ESLint, TypeScript, Vite, etc.)
+- GitHub Actions workflows
+- Scripts
+- Dependencies versions in package.json
+- If `examples` directory exists, automatically adds `examples:dev` and `postdocs` scripts
+
+## Usage Guidelines
+
+### When to use CREATE command:
+- User wants to start a new feng3d project
+- User needs a project with feng3d standards
+- Setting up a new package in a monorepo
+
+### When to use UPDATE command:
+- User wants to sync with latest feng3d standards
+- Project configuration is outdated
+- User wants to adopt new feng3d conventions
+- After feng3d-cli version update
+
+### Important Notes:
+1. **Always use npx**: Run commands with `npx feng3d-cli` to ensure the latest version
+2. **Check directory**: Verify the target directory before creating/updating
+3. **Backup warning**: Warn users that UPDATE will overwrite configuration files
+4. **Git status**: Recommend checking git status before UPDATE
+5. **Examples directory**: If project has `examples/`, UPDATE will automatically configure related scripts
+
+## Code Standards
+
+When working with feng3d projects, follow these 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 Conventions
+- Use Simplified Chinese
+- Follow Conventional Commits format
+- Types: feat, fix, refactor, perf, style, docs, test, chore, build, ci
+
+### Pre-commit Checks
+Before committing, the project automatically runs:
+1. ESLint code style check
+2. Unit tests via vitest
+
+## Unified Versions
+
+The tool maintains unified versions for:
+- TypeScript: 5.8.3
+- ESLint: 9.26.0
+- Vitest: ^3.1.3
+- Vite: ^6.3.5
+- TypeDoc: ^0.28.4
+
+## Implementation
+
+When the user invokes this skill:
+
+1. **Understand the request**: Determine if they want to create or update
+2. **Confirm details**: Ask for project name (for create) or confirm directory
+3. **Execute command**: Use the Bash tool to run `npx feng3d-cli <command>`
+4. **Handle output**: Show the command output to the user
+5. **Next steps**: Suggest running `npm install` after creation, or checking git diff after update
+
+## Example Interactions
+
+### Example 1: Creating a new project
+```
+User: Create a new feng3d project called "my-lib"
+Assistant: I'll create a new feng3d project for you.
+[Uses Bash tool to run: npx feng3d-cli create my-lib]
+[Shows output]
+Assistant: Project created successfully! Next steps:
+1. cd my-lib
+2. npm install
+3. npm run dev
+```
+
+### Example 2: Updating existing project
+```
+User: Update my project to latest feng3d standards
+Assistant: I'll update your project configuration. This will overwrite your configuration files. Make sure you've committed any important changes.
+[Uses Bash tool to run: npx feng3d-cli update]
+[Shows output]
+Assistant: Configuration updated! Review the changes with `git diff` and test your project.
+```
+
+## Error Handling
+
+- If the command fails, show the error message and suggest solutions
+- If directory doesn't exist, suggest creating it or checking the path
+- If package.json is missing for update, suggest running create instead
+- If npm/node is not installed, guide user to install them first
+
+## Additional Resources
+
+- Repository: https://github.com/feng3d-labs/feng3d-cli
+- Documentation: https://feng3d.com/feng3d-cli/

package/.claude-skill/skill.json

@@ -0,0 +1,21 @@
+{
+  "name": "feng3d",
+  "version": "0.1.0",
+  "description": "创建或更新符合 feng3d 规范的项目",
+  "author": "feng",
+  "commands": {
+    "create": {
+      "description": "创建新的 feng3d 项目",
+      "usage": "/feng3d create <project-name> [options]"
+    },
+    "update": {
+      "description": "更新当前项目的 feng3d 规范配置",
+      "usage": "/feng3d update [options]"
+    }
+  },
+  "repository": "https://github.com/feng3d-labs/feng3d-cli",
+  "cli": {
+    "command": "npx feng3d-cli",
+    "package": "feng3d-cli"
+  }
+}

package/README.md

@@ -11,12 +11,46 @@ feng3d 命令行工具，包含项目规范、配置模板等功能。
 
 ## 使用方式
 
+### CLI 命令行使用
+
 推荐使用 `npx` 直接运行，无需安装：
 
 ```bash
 npx feng3d-cli <command>
 ```
 
+或全局安装：
+
+```bash
+npm install -g feng3d-cli
+feng3d-cli <command>
+```
+
+### Claude Code Skill 使用
+
+如果你使用 [Claude Code](https://github.com/anthropics/claude-code)，只需一条命令即可安装：
+
+```bash
+npx feng3d-cli skill
+```
+
+手动安装：
+```bash
+mkdir -p ~/.claude/skills
+cp -r .claude-skill ~/.claude/skills/feng3d
+```
+
+安装后，在 Claude Code 中可以直接使用：
+
+```bash
+/feng3d create my-project
+/feng3d update
+```
+
+或者直接对话："用 feng3d 创建一个新项目"
+
+详细说明见 [.claude-skill/README.md](./.claude-skill/README.md)
+
 ## CLI 命令
 
 ### 创建新项目
@@ -37,6 +71,14 @@ npx feng3d-cli update
 npx feng3d-cli update -d ./my-project  # 指定项目目录
 ```
 
+### 安装 Claude Code Skill
+
+```bash
+npx feng3d-cli skill
+```
+
+> 💡 提示：也可以使用完整命令 `npx feng3d-cli install-skill`
+
 更新项目的所有规范配置文件，包括 ESLint、TypeScript、Vite、GitHub Actions 等。
 
 > 注意：如果项目中存在 `examples` 目录，会自动添加 `examples:dev` 和 `postdocs` 脚本。

package/bin/cli.js

@@ -6,7 +6,7 @@
 
 import { Command } from 'commander';
 import chalk from 'chalk';
-import { createProject, updateProject } from '../dist/index.js';
+import { createProject, updateProject, installSkill } from '../dist/index.js';
 
 const program = new Command();
 
@@ -55,4 +55,21 @@ program
         }
     });
 
+program
+    .command('install-skill')
+    .alias('skill')
+    .description('安装 feng3d Claude Code Skill')
+    .action(async () =>
+    {
+        try
+        {
+            await installSkill();
+        }
+        catch (error)
+        {
+            console.error(chalk.red(`\n❌ 安装失败: ${error}\n`));
+            process.exit(1);
+        }
+    });
+
 program.parse();

package/dist/index.js

@@ -2,8 +2,9 @@ import fs from "fs-extra";
 import path from "path";
 import { fileURLToPath } from "url";
 import chalk from "chalk";
-const __dirname$2 = path.dirname(fileURLToPath(import.meta.url));
-const TEMPLATES_DIR$1 = path.resolve(__dirname$2, "../templates");
+import os from "os";
+const __dirname$3 = path.dirname(fileURLToPath(import.meta.url));
+const TEMPLATES_DIR$1 = path.resolve(__dirname$3, "../templates");
 function loadVersionsFromTemplate() {
   const packageJsonPath = path.join(TEMPLATES_DIR$1, "package.json");
   const packageJson = fs.readJsonSync(packageJsonPath);
@@ -23,8 +24,8 @@ function getDevDependencies(options = {}) {
   }
   return deps;
 }
-const __dirname$1 = path.dirname(fileURLToPath(import.meta.url));
-const TEMPLATES_DIR = path.resolve(__dirname$1, "../templates");
+const __dirname$2 = path.dirname(fileURLToPath(import.meta.url));
+const TEMPLATES_DIR = path.resolve(__dirname$2, "../templates");
 function getGitignoreTemplate() {
   return fs.readFileSync(path.join(TEMPLATES_DIR, "gitignore"), "utf-8");
 }
@@ -202,7 +203,8 @@ const PACKAGE_JSON_FIELD_ORDER = [
   "devDependencies",
   "dependencies",
   "peerDependencies",
-  "lint-staged"
+  "lint-staged",
+  "workspaces"
 ];
 const SCRIPTS_ORDER = [
   "examples:dev",
@@ -287,10 +289,10 @@ async function updateDependencies(projectDir) {
     standardScripts.postdocs = "node scripts/postdocs.js && cd examples && vite build --outDir ../public";
   }
   for (const [key, value] of Object.entries(standardScripts)) {
-    if (packageJson.scripts[key] !== value) {
+    if (!(key in packageJson.scripts)) {
       packageJson.scripts[key] = value;
       updated = true;
-      console.log(chalk.gray(`  更新: scripts.${key}`));
+      console.log(chalk.gray(`  添加: scripts.${key}`));
     }
   }
   if (packageJson.type !== "module") {
@@ -322,6 +324,17 @@ async function updateDependencies(projectDir) {
     updated = true;
     console.log(chalk.gray("  更新: exports"));
   }
+  if (!packageJson.workspaces) {
+    packageJson.workspaces = [
+      ".",
+      "./examples",
+      "./test_web",
+      "packages/*",
+      "packages/*/examples"
+    ];
+    updated = true;
+    console.log(chalk.gray("  添加: workspaces"));
+  }
   if (updated) {
     const orderedPackageJson = reorderPackageJson(packageJson);
     let newContent = JSON.stringify(orderedPackageJson, null, indent);
@@ -477,6 +490,71 @@ function createPackageJson(name, options) {
     })
   };
 }
+const __filename$1 = fileURLToPath(import.meta.url);
+const __dirname$1 = path.dirname(__filename$1);
+async function installSkill() {
+  try {
+    const homeDir = os.homedir();
+    const claudeSkillsDir = path.join(homeDir, ".claude", "skills", "feng3d");
+    const possiblePaths = [
+      // 从当前文件位置向上查找（开发环境）
+      path.resolve(__dirname$1, "../../.claude-skill"),
+      path.resolve(__dirname$1, "../../../.claude-skill"),
+      path.resolve(__dirname$1, "../.claude-skill"),
+      // 从 package.json 所在目录查找
+      path.resolve(process.cwd(), ".claude-skill"),
+      // 从 node_modules 查找（全局安装）
+      path.resolve(__dirname$1, "../../../../feng3d-cli/.claude-skill")
+    ];
+    let sourceDir = "";
+    for (const tryPath of possiblePaths) {
+      if (fs.existsSync(path.join(tryPath, "skill.json"))) {
+        sourceDir = tryPath;
+        break;
+      }
+    }
+    if (!sourceDir) {
+      console.error(chalk.red("❌ 错误：找不到 .claude-skill 目录"));
+      console.log(chalk.yellow("尝试的路径："));
+      possiblePaths.forEach((p) => console.log(`  - ${p}`));
+      console.log(chalk.yellow("\n请确保 feng3d-cli 已正确安装"));
+      process.exit(1);
+    }
+    if (!fs.existsSync(path.join(sourceDir, "skill.json"))) {
+      console.error(chalk.red("❌ 错误：.claude-skill/skill.json 不存在"));
+      process.exit(1);
+    }
+    console.log(chalk.blue("\n📦 开始安装 feng3d Claude Code Skill...\n"));
+    if (fs.existsSync(claudeSkillsDir)) {
+      console.log(chalk.yellow("⚠️  检测到已安装的 skill，将进行覆盖更新..."));
+      await fs.remove(claudeSkillsDir);
+    }
+    await fs.ensureDir(path.dirname(claudeSkillsDir));
+    console.log(chalk.blue("📂 复制 skill 文件..."));
+    await fs.copy(sourceDir, claudeSkillsDir, {
+      overwrite: true,
+      errorOnExist: false
+    });
+    if (fs.existsSync(path.join(claudeSkillsDir, "skill.json"))) {
+      console.log(chalk.green("\n✅ feng3d Skill 安装成功！\n"));
+      console.log(chalk.cyan(`安装位置: ${claudeSkillsDir}
+`));
+      console.log(chalk.yellow("使用方法:"));
+      console.log("  /feng3d create my-project");
+      console.log("  /feng3d update\n");
+      console.log(chalk.yellow('或直接对话: "用 feng3d 创建一个新项目"\n'));
+      console.log(chalk.cyan("💡 提示: 可能需要重启 Claude Code 使 skill 生效\n"));
+    } else {
+      console.error(chalk.red("\n❌ 安装失败：无法验证安装结果\n"));
+      process.exit(1);
+    }
+  } catch (error) {
+    console.error(chalk.red(`
+❌ 安装失败: ${error}
+`));
+    process.exit(1);
+  }
+}
 export {
   VERSIONS,
   createProject,
@@ -502,6 +580,7 @@ export {
   getViteConfigTemplate,
   getVitestConfigTemplate,
   getVscodeSettingsTemplate,
+  installSkill,
   updateProject
 };
 //# sourceMappingURL=index.js.map