feng3d-cli 0.0.5 → 0.0.6

package/templates/.github/workflows/upload-oss.yml

@@ -0,0 +1,100 @@
+# 上传文档到 OSS
+# 在 npm 发布成功后自动执行，也可手动触发
+name: Upload to OSS
+
+on:
+  # npm 发布成功后自动触发
+  workflow_run:
+    workflows: ["Publish to NPM"]
+    types:
+      - completed
+
+  # 支持手动触发
+  workflow_dispatch:
+
+jobs:
+  upload:
+    runs-on: ubuntu-latest
+    # 仅在 publish 成功后执行，或手动触发时执行
+    if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build docs
+        run: npm run docs
+
+      - name: Check OSS config
+        id: check_oss
+        run: |
+          if [ -z "${{ secrets.OSS_ACCESS_KEY_ID }}" ]; then
+            echo "OSS 未配置，跳过上传"
+            echo "skip=true" >> $GITHUB_OUTPUT
+          else
+            echo "skip=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Upload to OSS
+        if: steps.check_oss.outputs.skip != 'true'
+        env:
+          OSS_REGION: ${{ secrets.OSS_REGION }}
+          OSS_ACCESS_KEY_ID: ${{ secrets.OSS_ACCESS_KEY_ID }}
+          OSS_ACCESS_KEY_SECRET: ${{ secrets.OSS_ACCESS_KEY_SECRET }}
+          OSS_BUCKET: ${{ secrets.OSS_BUCKET }}
+        run: |
+          # 检查 public 目录是否存在
+          if [ ! -d "public" ]; then
+            echo "public 目录不存在，跳过 OSS 上传"
+            exit 0
+          fi
+
+          # 获取仓库名作为 OSS 目录
+          REPO_NAME=$(node -p "require('./package.json').name.replace(/^@[^/]+\//, '')")
+          echo "上传目录: $REPO_NAME"
+
+          # 安装 ali-oss
+          npm install ali-oss --no-save
+
+          # 执行上传
+          node -e "
+            const OSS = require('ali-oss');
+            const fs = require('fs');
+            const path = require('path');
+
+            const client = new OSS({
+              region: process.env.OSS_REGION,
+              accessKeyId: process.env.OSS_ACCESS_KEY_ID,
+              accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
+              bucket: process.env.OSS_BUCKET,
+            });
+
+            const localDir = 'public';
+            const ossDir = '$REPO_NAME';
+
+            async function uploadDir(dir, ossPath) {
+              const items = fs.readdirSync(dir);
+              for (const item of items) {
+                const localPath = path.join(dir, item);
+                const remotePath = ossPath + '/' + item;
+                if (fs.statSync(localPath).isDirectory()) {
+                  await uploadDir(localPath, remotePath);
+                } else {
+                  await client.put(remotePath, localPath);
+                  console.log('上传: ' + remotePath);
+                }
+              }
+            }
+
+            uploadDir(localDir, ossDir)
+              .then(() => console.log('OSS 上传完成'))
+              .catch(err => { console.error('OSS 上传失败:', err); process.exit(1); });
+          "
+

package/templates/.husky/pre-commit

@@ -1,2 +1,33 @@
-npx lint-staged
+#!/bin/sh
 
+echo ""
+echo "🔍 [1/2] 检查代码规范..."
+echo ""
+
+if ! npx lint-staged --allow-empty; then
+    echo ""
+    echo "❌ 代码规范检查失败！"
+    echo ""
+    echo "请修复以上 ESLint 错误后再提交。"
+    echo "提示: 运行 'npm run lintfix' 可自动修复部分问题。"
+    echo ""
+    exit 1
+fi
+
+echo ""
+echo "🧪 [2/2] 运行单元测试..."
+echo ""
+
+if ! npm test; then
+    echo ""
+    echo "❌ 单元测试失败！"
+    echo ""
+    echo "请修复测试错误后再提交。"
+    echo "提示: 运行 'npm test' 查看详细错误信息。"
+    echo ""
+    exit 1
+fi
+
+echo ""
+echo "✅ 所有检查通过，准备提交！"
+echo ""

package/templates/gitignore

@@ -11,16 +11,3 @@ test_dist
 # 测试覆盖率
 coverage
 
-# 以下文件可由 feng3d-cli 自动生成，无需提交
-# 运行 `feng3d-cli update` 可重新生成
-feng3d.json
-.cursorrules
-eslint.config.js
-typedoc.json
-test/_.test.ts
-.husky/pre-commit
-.vscode/settings.json
-tsconfig.json
-vite.config.js
-scripts/prepublish.js
-scripts/postpublish.js

package/templates/package.json

@@ -0,0 +1,71 @@
+{
+    "name": "{{name}}",
+    "version": "0.0.1",
+    "description": "",
+    "homepage": "https://feng3d.com/{{repoName}}/",
+    "author": "feng",
+    "license": "MIT",
+    "type": "module",
+    "main": "./src/index.ts",
+    "types": "./src/index.ts",
+    "module": "./src/index.ts",
+    "exports": {
+        ".": {
+            "types": "./src/index.ts",
+            "import": "./src/index.ts",
+            "require": "./src/index.ts"
+        }
+    },
+    "scripts": {
+        "examples:dev": "cd examples && npm run dev",
+        "postdocs": "node scripts/postdocs.js && cd examples && vite build --outDir ../public",
+        "clean": "rimraf lib dist public",
+        "build": "vite build && tsc",
+        "watch": "concurrently \"vite build --watch\" \"tsc -w\" \"vitest\"",
+        "test": "vitest run",
+        "lint": "eslint . --ext .js,.ts --max-warnings 0",
+        "lintfix": "npm run lint -- --fix",
+        "docs": "typedoc",
+        "prepublishOnly": "node scripts/prepublish.js",
+        "release": "npm run clean && npm run lint && npm test && npm run build && npm run docs && npm publish",
+        "postpublish": "node scripts/postpublish.js",
+        "prepare": "husky"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/feng3d-labs/{{repoName}}.git"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "files": [
+        "dist/",
+        "lib",
+        "src"
+    ],
+    "devDependencies": {
+        "@eslint/js": "^9.0.0",
+        "@typescript-eslint/eslint-plugin": "8.32.1",
+        "@typescript-eslint/parser": "8.32.1",
+        "concurrently": "^9.1.2",
+        "cross-env": "7.0.3",
+        "eslint": "9.26.0",
+        "globals": "^14.0.0",
+        "husky": "^9.1.7",
+        "lint-staged": "^15.2.10",
+        "rimraf": "6.0.1",
+        "tslib": "^2.8.1",
+        "typedoc": "^0.28.4",
+        "typescript": "5.8.3",
+        "typescript-eslint": "^8.32.1",
+        "vite": "^6.3.5",
+        "vitest": "^3.1.3"
+    },
+    "dependencies": {},
+    "lint-staged": {
+        "*.{js,ts}": [
+            "eslint --fix --max-warnings 0"
+        ]
+    }
+}
+

package/templates/scripts/postdocs.js

@@ -0,0 +1,46 @@
+/**
+ * postdocs 脚本
+ *
+ * 将 typedoc 生成的文档从 public 移动到 public/doc 目录
+ */
+
+import { existsSync, mkdirSync, cpSync, rmSync } from 'fs';
+import { resolve, dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const rootDir = resolve(__dirname, '..');
+
+const publicDir = resolve(rootDir, 'public');
+const tempDir = resolve(rootDir, 'public_temp');
+const docDir = resolve(rootDir, 'public/doc');
+
+// 1. 复制 public 到 public_temp
+if (existsSync(publicDir))
+{
+    // 先删除临时目录（如果存在）
+    if (existsSync(tempDir))
+    {
+        rmSync(tempDir, { recursive: true, force: true });
+    }
+    // 复制 public 到 public_temp
+    cpSync(publicDir, tempDir, { recursive: true });
+    // 删除原 public 目录
+    rmSync(publicDir, { recursive: true, force: true });
+}
+
+// 2. 创建新的 public 目录
+mkdirSync(publicDir, { recursive: true });
+
+// 3. 将 public_temp 移动到 public/doc
+if (existsSync(tempDir))
+{
+    // 复制 public_temp 到 public/doc
+    cpSync(tempDir, docDir, { recursive: true });
+    // 删除 public_temp
+    rmSync(tempDir, { recursive: true, force: true });
+}
+
+console.log('文档已移动到 public/doc 目录');
+

package/templates/src/index.ts

@@ -0,0 +1,6 @@
+/**
+ * {{name}}
+ */
+
+export { };
+

package/templates/vite.config.js

@@ -9,6 +9,7 @@ const external = pkg.standalone ? [] : Object.keys(pkg.dependencies || []);
 const globals = () => namespace;
 
 export default defineConfig({
+    publicDir: false,
     build: {
         lib: {
             // Could also be a dictionary or array of multiple entry points

package/lib/commands/oss.d.ts

@@ -1,11 +0,0 @@
-/**
- * OSS 上传命令
- */
-/**
- * 将本地目录中的所有文件上传到指定的 OSS 目录中。
- *
- * @param localDirPath - 本地目录的路径，包含需要上传的文件。
- * @param ossDirPath - OSS 目录的路径，文件将被上传到此目录。
- */
-export declare function ossUploadDir(localDirPath: string, ossDirPath: string): Promise<void>;
-//# sourceMappingURL=oss.d.ts.map

package/lib/commands/oss.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"oss.d.ts","sourceRoot":"","sources":["../../src/commands/oss.ts"],"names":[],"mappings":"AAAA;;GAEG;AASH;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAsC1F"}

package/lib/types/config.d.ts

@@ -1,113 +0,0 @@
-/**
- * feng3d 项目配置类型定义
- */
-/**
- * ESLint 配置选项
- */
-export interface EslintConfig {
-    /** 是否启用 ESLint */
-    enabled?: boolean;
-    /** 额外需要忽略的目录 */
-    ignores?: string[];
-    /** 额外的规则覆盖 */
-    rules?: Record<string, unknown>;
-}
-/**
- * Vitest 配置选项
- */
-export interface VitestConfig {
-    /** 是否启用 vitest */
-    enabled?: boolean;
-    /** 测试超时时间（0 表示无限制） */
-    testTimeout?: number;
-}
-/**
- * TypeDoc 配置选项
- */
-export interface TypedocConfig {
-    /** 是否启用 typedoc */
-    enabled?: boolean;
-    /** 输出目录 */
-    outDir?: string;
-}
-/**
- * OSS 上传配置
- */
-export interface OssConfig {
-    /** 本地目录 */
-    localDir?: string;
-    /** OSS 目录（默认使用 package.json 的 name） */
-    ossDir?: string;
-}
-/**
- * 项目模板选项
- */
-export interface TemplatesConfig {
-    /** 是否创建示例目录 */
-    examples?: boolean;
-    /** 是否创建测试目录 */
-    test?: boolean;
-}
-/**
- * 更新配置选项
- */
-export interface UpdateConfig {
-    /** 是否更新 feng3d.json 配置 */
-    config?: boolean;
-    /** 是否更新 ESLint 配置 */
-    eslint?: boolean;
-    /** 是否更新 .gitignore */
-    gitignore?: boolean;
-    /** 是否更新 .cursorrules */
-    cursorrules?: boolean;
-    /** 是否更新 npm publish workflow */
-    publish?: boolean;
-    /** 是否更新 GitHub Pages workflow */
-    pages?: boolean;
-    /** 是否更新 Pull Request CI workflow */
-    pullRequest?: boolean;
-    /** 是否更新 typedoc.json */
-    typedoc?: boolean;
-    /** 是否更新 test/_.test.ts */
-    test?: boolean;
-    /** 是否更新依赖版本 */
-    deps?: boolean;
-    /** 是否更新 husky pre-commit hook */
-    husky?: boolean;
-    /** 是否更新 LICENSE 文件 */
-    license?: boolean;
-    /** 是否更新 .vscode/settings.json */
-    vscode?: boolean;
-    /** 是否更新 tsconfig.json */
-    tsconfig?: boolean;
-    /** 是否更新 vite.config.js */
-    vite?: boolean;
-}
-/**
- * feng3d 项目配置
- */
-export interface Feng3dConfig {
-    /** 项目名称 */
-    name?: string;
-    /** ESLint 配置 */
-    eslint?: EslintConfig;
-    /** Vitest 配置 */
-    vitest?: VitestConfig;
-    /** TypeDoc 配置 */
-    typedoc?: TypedocConfig;
-    /** OSS 配置 */
-    oss?: OssConfig;
-    /** 模板配置 */
-    templates?: TemplatesConfig;
-    /** 更新配置（指定 feng3d-cli update 时默认更新哪些项目） */
-    update?: UpdateConfig;
-}
-/**
- * 默认更新配置（全部启用）
- */
-export declare const DEFAULT_UPDATE_CONFIG: UpdateConfig;
-/**
- * 默认配置
- */
-export declare const DEFAULT_CONFIG: Feng3dConfig;
-//# sourceMappingURL=config.d.ts.map

package/lib/types/config.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/types/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,kBAAkB;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gBAAgB;IAChB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,cAAc;IACd,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,kBAAkB;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,sBAAsB;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,mBAAmB;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,WAAW;IACX,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,eAAe;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,eAAe;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,0BAA0B;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,qBAAqB;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,sBAAsB;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,wBAAwB;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,iCAAiC;IACjC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,oCAAoC;IACpC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,wBAAwB;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0BAA0B;IAC1B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,eAAe;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,iCAAiC;IACjC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,sBAAsB;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,iCAAiC;IACjC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,yBAAyB;IACzB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,0BAA0B;IAC1B,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gBAAgB;IAChB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,gBAAgB;IAChB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,iBAAiB;IACjB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,aAAa;IACb,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,WAAW;IACX,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,2CAA2C;IAC3C,MAAM,CAAC,EAAE,YAAY,CAAC;CACzB;AAED;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,YAgBnC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,YAuB5B,CAAC"}

package/schemas/feng3d.schema.json

@@ -1,196 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "feng3d.schema.json",
-    "title": "feng3d 项目配置",
-    "description": "feng3d 项目配置文件，用于自定义项目规范和 CLI 行为",
-    "type": "object",
-    "properties": {
-        "$schema": {
-            "type": "string",
-            "description": "JSON Schema 引用"
-        },
-        "name": {
-            "type": "string",
-            "description": "项目名称"
-        },
-        "eslint": {
-            "type": "object",
-            "description": "ESLint 配置选项",
-            "properties": {
-                "enabled": {
-                    "type": "boolean",
-                    "description": "是否启用 ESLint",
-                    "default": true
-                },
-                "ignores": {
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    },
-                    "description": "额外需要忽略的目录",
-                    "default": []
-                },
-                "rules": {
-                    "type": "object",
-                    "description": "额外的规则覆盖",
-                    "additionalProperties": true,
-                    "default": {}
-                }
-            },
-            "additionalProperties": false
-        },
-        "vitest": {
-            "type": "object",
-            "description": "Vitest 测试配置选项",
-            "properties": {
-                "enabled": {
-                    "type": "boolean",
-                    "description": "是否启用 vitest",
-                    "default": true
-                },
-                "testTimeout": {
-                    "type": "number",
-                    "description": "测试超时时间（毫秒，0 表示无限制）",
-                    "default": 0,
-                    "minimum": 0
-                }
-            },
-            "additionalProperties": false
-        },
-        "typedoc": {
-            "type": "object",
-            "description": "TypeDoc 文档配置选项",
-            "properties": {
-                "enabled": {
-                    "type": "boolean",
-                    "description": "是否启用 typedoc",
-                    "default": true
-                },
-                "outDir": {
-                    "type": "string",
-                    "description": "文档输出目录",
-                    "default": "public/docs"
-                }
-            },
-            "additionalProperties": false
-        },
-        "oss": {
-            "type": "object",
-            "description": "OSS 上传配置",
-            "properties": {
-                "localDir": {
-                    "type": "string",
-                    "description": "本地目录",
-                    "default": "./public"
-                },
-                "ossDir": {
-                    "type": "string",
-                    "description": "OSS 目录（默认使用 package.json 的 name）",
-                    "default": ""
-                }
-            },
-            "additionalProperties": false
-        },
-        "templates": {
-            "type": "object",
-            "description": "项目模板选项",
-            "properties": {
-                "examples": {
-                    "type": "boolean",
-                    "description": "是否创建示例目录",
-                    "default": true
-                },
-                "test": {
-                    "type": "boolean",
-                    "description": "是否创建测试目录",
-                    "default": true
-                }
-            },
-            "additionalProperties": false
-        },
-        "update": {
-            "type": "object",
-            "description": "更新配置（指定 feng3d-cli update 时默认更新哪些项目）",
-            "properties": {
-                "config": {
-                    "type": "boolean",
-                    "description": "是否更新 feng3d.json 配置",
-                    "default": true
-                },
-                "eslint": {
-                    "type": "boolean",
-                    "description": "是否更新 ESLint 配置",
-                    "default": true
-                },
-                "gitignore": {
-                    "type": "boolean",
-                    "description": "是否更新 .gitignore",
-                    "default": true
-                },
-                "cursorrules": {
-                    "type": "boolean",
-                    "description": "是否更新 .cursorrules",
-                    "default": true
-                },
-                "publish": {
-                    "type": "boolean",
-                    "description": "是否更新 npm publish workflow",
-                    "default": true
-                },
-                "pages": {
-                    "type": "boolean",
-                    "description": "是否更新 GitHub Pages workflow",
-                    "default": true
-                },
-                "pullRequest": {
-                    "type": "boolean",
-                    "description": "是否更新 Pull Request CI workflow",
-                    "default": true
-                },
-                "typedoc": {
-                    "type": "boolean",
-                    "description": "是否更新 typedoc.json",
-                    "default": true
-                },
-                "test": {
-                    "type": "boolean",
-                    "description": "是否更新 test/_.test.ts",
-                    "default": true
-                },
-                "deps": {
-                    "type": "boolean",
-                    "description": "是否更新依赖版本",
-                    "default": true
-                },
-                "husky": {
-                    "type": "boolean",
-                    "description": "是否更新 husky pre-commit hook",
-                    "default": true
-                },
-                "license": {
-                    "type": "boolean",
-                    "description": "是否更新 LICENSE 文件",
-                    "default": true
-                },
-                "vscode": {
-                    "type": "boolean",
-                    "description": "是否更新 .vscode/settings.json",
-                    "default": true
-                },
-                "tsconfig": {
-                    "type": "boolean",
-                    "description": "是否更新 tsconfig.json",
-                    "default": true
-                },
-                "vite": {
-                    "type": "boolean",
-                    "description": "是否更新 vite.config.js",
-                    "default": true
-                }
-            },
-            "additionalProperties": false
-        }
-    },
-    "additionalProperties": false
-}
-

package/templates/feng3d.json

@@ -1,43 +0,0 @@
-{
-    "$schema": "./node_modules/feng3d-cli/schemas/feng3d.schema.json",
-    "name": "{{name}}",
-    "eslint": {
-        "enabled": true,
-        "ignores": [],
-        "rules": {}
-    },
-    "vitest": {
-        "enabled": true,
-        "testTimeout": 0
-    },
-    "typedoc": {
-        "enabled": true,
-        "outDir": "public"
-    },
-    "oss": {
-        "localDir": "./public",
-        "ossDir": ""
-    },
-    "templates": {
-        "examples": true,
-        "test": true
-    },
-    "update": {
-        "config": true,
-        "eslint": true,
-        "gitignore": true,
-        "cursorrules": true,
-        "publish": true,
-        "pages": true,
-        "pullRequest": true,
-        "typedoc": true,
-        "test": true,
-        "deps": true,
-        "husky": true,
-        "license": true,
-        "vscode": true,
-        "tsconfig": true,
-        "vite": true
-    }
-}
-