feng3d-cli 0.0.5 → 0.0.7

package/README.md

@@ -1,31 +1,28 @@
-feng3d 命令行工具，包含项目规范、配置模板、OSS 上传等功能。
+feng3d 命令行工具，包含项目规范、配置模板等功能。
 
 ## 功能特性
 
 - 📋 统一的代码规范（ESLint 配置）
 - 📦 统一的依赖版本管理
 - 🛠️ CLI 工具支持创建和更新项目
-- 📝 项目模板（.gitignore, .cursorrules, tsconfig.json 等）
-- 📤 阿里云 OSS 文件上传
+- 📝 项目模板（LICENSE, .gitignore, .cursorrules, tsconfig.json, vite.config.js 等）
+- 🔄 GitHub Actions 工作流模板（CI/CD、GitHub Pages 部署、OSS 上传）
+- ✅ Git pre-commit 钩子（代码规范检查 + 单元测试）
 
-## 安装
+## 使用方式
 
-```bash
-npm install -g feng3d-cli
-```
-
-或作为开发依赖：
+推荐使用 `npx` 直接运行，无需安装：
 
 ```bash
-npm install -D feng3d-cli
+npx feng3d-cli <command>
 ```
 
-## CLI 使用
+## CLI 命令
 
 ### 创建新项目
 
 ```bash
-feng3d-cli create my-project
+npx feng3d-cli create my-project
 ```
 
 选项：
@@ -36,67 +33,70 @@ feng3d-cli create my-project
 ### 更新现有项目
 
 ```bash
-feng3d-cli update
+npx feng3d-cli update
+npx feng3d-cli update -d ./my-project  # 指定项目目录
 ```
 
-选项：
-- `-d, --directory <dir>` - 项目目录（默认：当前目录）
-- `--eslint` - 仅更新 ESLint 配置
-- `--gitignore` - 仅更新 .gitignore
-- `--cursorrules` - 仅更新 .cursorrules
-- `--deps` - 仅更新依赖版本
-- `--all` - 更新所有配置
+更新项目的所有规范配置文件，包括 ESLint、TypeScript、Vite、GitHub Actions 等。
 
-### 上传到阿里云 OSS
-
-```bash
-feng3d-cli oss_upload_dir                           # 上传 ./public 目录
-feng3d-cli oss_upload_dir -l ./dist                 # 指定本地目录
-feng3d-cli oss_upload_dir -l ./public -o my-project # 指定 OSS 目录
-```
-
-选项：
-- `-l, --local_dir <dir>` - 本地目录（默认：./public）
-- `-o, --oss_dir <dir>` - OSS 目录（默认：从 package.json 的 name 获取）
-
-> 注意：需要在 `C:/Users/Administrator/oss_config.json` 配置 OSS 访问密钥
+> 注意：如果项目中存在 `examples` 目录，会自动添加 `examples:dev` 和 `postdocs` 脚本。
 
 ## 编程使用
 
-### 获取统一版本
-
-```typescript
-import { VERSIONS, getDevDependencies } from 'feng3d-cli';
-
-// 获取特定依赖版本
-console.log(VERSIONS.typescript); // '5.8.3'
-console.log(VERSIONS.vitest);     // '^3.1.3'
-
-// 获取完整的 devDependencies
-const deps = getDevDependencies({
-    includeVitest: true,
-    includeCoverage: true,
-    includeTypedoc: true,
-});
-```
-
-### 使用模板
-
 ```typescript
 import {
+    // 版本管理
+    VERSIONS,
+    getDevDependencies,
+    // 模板
     gitignoreTemplate,
     cursorrrulesTemplate,
-    tsconfigTemplate,
-    createTypedocConfig,
+    getTypedocConfig,
+    getLicenseTemplate,
+    getVscodeSettingsTemplate,
+    getTsconfigTemplate,
+    getViteConfigTemplate,
+    // 项目操作
+    createProject,
+    updateProject,
 } from 'feng3d-cli';
-
-// 创建 typedoc 配置
-const config = createTypedocConfig({
-    name: '@feng3d/my-package',
-    repoName: 'my-package',
-});
 ```
 
+## 模板文件
+
+| 文件 | 说明 |
+|------|------|
+| LICENSE | MIT 许可证（中文） |
+| .gitignore | Git 忽略规则 |
+| .cursorrules | Cursor AI 规则 |
+| tsconfig.json | TypeScript 配置 |
+| vite.config.js | Vite 构建配置 |
+| eslint.config.js | ESLint 配置 |
+| typedoc.json | TypeDoc 配置 |
+| .vscode/settings.json | VS Code 设置 |
+| .husky/pre-commit | Git pre-commit 钩子（代码规范 + 单元测试） |
+| scripts/prepublish.js | 发布前脚本 |
+| scripts/postpublish.js | 发布后脚本 |
+| scripts/postdocs.js | 文档生成后处理脚本（移动到 public/doc） |
+
+## GitHub Actions 工作流
+
+| 工作流文件 | 说明 |
+|------|------|
+| pull-request.yml | 代码检查和测试（PR 或推送时触发） |
+| publish.yml | 发布到 npm（创建 Release 时触发） |
+| pages.yml | 部署文档到 GitHub Pages（发布成功后或手动触发） |
+| upload-oss.yml | 上传到阿里云 OSS（发布成功后或手动触发） |
+
+### OSS 上传配置
+
+要启用 OSS 上传功能，需要在 GitHub 仓库的 Settings > Secrets and variables > Actions 中配置以下密钥：
+
+- `OSS_REGION` - OSS 区域（如 `oss-cn-hangzhou`）
+- `OSS_ACCESS_KEY_ID` - 阿里云 AccessKey ID
+- `OSS_ACCESS_KEY_SECRET` - 阿里云 AccessKey Secret
+- `OSS_BUCKET` - OSS Bucket 名称
+
 ## 统一版本
 
 | 依赖 | 版本 |
@@ -125,7 +125,11 @@ const config = createTypedocConfig({
 - 遵循 Conventional Commits 格式
 - 类型：feat, fix, refactor, perf, style, docs, test, chore, build, ci
 
+### Pre-commit 检查
+提交代码前会自动执行：
+1. **代码规范检查** - 使用 ESLint 检查代码风格
+2. **单元测试** - 运行 vitest 确保测试通过
+
 ## 许可证
 
 MIT
-

package/bin/cli.js

@@ -4,10 +4,9 @@
  * feng3d 命令行工具，包含项目规范、OSS 上传等功能
  */
 
-import fs from 'fs';
 import { Command } from 'commander';
 import chalk from 'chalk';
-import { createProject, updateProject, ossUploadDir } from '../dist/index.js';
+import { createProject, updateProject } from '../dist/index.js';
 
 const program = new Command();
 
@@ -41,28 +40,12 @@ program
     .command('update')
     .description('更新当前项目的规范配置')
     .option('-d, --directory <dir>', '项目目录', '.')
-    .option('--config', '仅更新 feng3d.json 配置')
-    .option('--eslint', '仅更新 ESLint 配置')
-    .option('--gitignore', '仅更新 .gitignore')
-    .option('--cursorrules', '仅更新 .cursorrules')
-    .option('--publish', '仅更新 npm publish workflow')
-    .option('--pages', '仅更新 GitHub Pages workflow')
-    .option('--pull-request', '仅更新 Pull Request CI workflow')
-    .option('--typedoc', '仅更新 typedoc.json')
-    .option('--test', '仅更新 test/_.test.ts')
-    .option('--deps', '仅更新依赖版本')
-    .option('--husky', '仅更新 husky pre-commit hook')
-    .option('--license', '仅更新 LICENSE 文件')
-    .option('--vscode', '仅更新 .vscode/settings.json')
-    .option('--tsconfig', '仅更新 tsconfig.json')
-    .option('--vite', '仅更新 vite.config.js')
-    .option('--all', '更新所有配置')
     .action(async (options) =>
     {
         console.log(chalk.blue('\n🔄 更新项目规范配置\n'));
         try
         {
-            await updateProject(options);
+            await updateProject(options.directory);
             console.log(chalk.green('\n✅ 规范配置更新成功！\n'));
         }
         catch (error)
@@ -72,64 +55,4 @@ program
         }
     });
 
-program
-    .command('check')
-    .description('检查当前项目是否符合 feng3d 规范')
-    .option('-d, --directory <dir>', '项目目录', '.')
-    .action(async () =>
-    {
-        console.log(chalk.blue('\n🔍 检查项目规范\n'));
-        // TODO: 实现规范检查
-        console.log(chalk.yellow('暂未实现'));
-    });
-
-program
-    .command('oss_upload_dir')
-    .description('上传文件夹到阿里云 OSS')
-    .option('-l, --local_dir <string>', '本地目录', './public')
-    .option('-o, --oss_dir <string>', 'OSS 目录', '')
-    .action(async (options) =>
-    {
-        const localDir = options.local_dir;
-        let ossDir = options.oss_dir;
-
-        if (!fs.existsSync(localDir))
-        {
-            console.log(chalk.red(`\n❌ 本地目录 ${localDir} 不存在!\n`));
-
-            return;
-        }
-
-        if (!ossDir)
-        {
-            // 获取当前目录下 package.json 的 name 字段
-            try
-            {
-                const packageJson = fs.readFileSync('package.json', 'utf-8');
-                const packageJsonObj = JSON.parse(packageJson);
-
-                ossDir = packageJsonObj.name.split('/').pop();
-            }
-            catch
-            {
-                console.log(chalk.red('\n❌ 无法读取 package.json 获取项目名称\n'));
-
-                return;
-            }
-        }
-
-        console.log(chalk.blue(`\n📤 上传文件夹到阿里云 OSS: ${localDir} -> ${ossDir}\n`));
-
-        try
-        {
-            await ossUploadDir(localDir, ossDir);
-            console.log(chalk.green('\n✅ 上传完成！\n'));
-        }
-        catch (error)
-        {
-            console.error(chalk.red(`\n❌ 上传失败: ${error}\n`));
-            process.exit(1);
-        }
-    });
-
 program.parse();