feng3d-cli 0.0.1

package/dist/templates.js

@@ -0,0 +1,146 @@
+/**
+ * 项目模板文件内容
+ */
+/**
+ * .gitignore 模板
+ */
+export const gitignoreTemplate = `node_modules
+dist
+lib
+public
+out
+/package-lock.json
+# 自动生成的测试配置文件
+**/test-config.ts
+# 测试构建输出目录
+test_dist
+# 测试覆盖率
+coverage
+`;
+/**
+ * .cursorrules 模板
+ */
+export const cursorrrulesTemplate = `# Cursor 项目规则
+
+## Git 提交信息规范
+
+当生成 Git 提交信息时：
+
+1. **语言**：始终使用简体中文
+
+2. **格式**：遵循约定式提交（Conventional Commits）格式
+   \`\`\`
+   <类型>(<范围>): <简短描述>
+
+   [可选的详细说明]
+
+   [可选的脚注]
+   \`\`\`
+
+3. **提交类型**（中文描述）：
+   - \`feat\`: 新增功能
+   - \`fix\`: 修复问题
+   - \`refactor\`: 代码重构（不改变功能）
+   - \`perf\`: 性能优化
+   - \`style\`: 代码格式调整（不影响代码含义）
+   - \`docs\`: 文档更新
+   - \`test\`: 测试相关
+   - \`chore\`: 构建过程或辅助工具的变动
+   - \`build\`: 构建系统或外部依赖项的更改
+   - \`ci\`: CI 配置文件和脚本的更改
+
+4. **范围**（可选）：可以是模块、组件或功能区域
+
+5. **提交信息要求**：
+   - 第一行简短描述，不超过 50 个字符
+   - 使用祈使句，如"添加"、"修复"、"优化"
+   - 描述要清晰、具体、有意义
+
+## 代码风格
+
+- 优先使用 TypeScript
+- 遵循现有代码的命名约定和格式
+- 添加必要的中文注释以提高代码可读性
+- 使用 ESLint 保持代码格式一致
+- 提交前必须通过 lint 检查
+- 避免使用 \`any\` 类型，优先使用明确的类型定义
+
+## 命名规范
+
+- **变量和函数**：使用驼峰命名（camelCase）
+- **类和接口**：使用帕斯卡命名（PascalCase）
+- **常量**：使用全大写下划线分隔（UPPER_SNAKE_CASE）
+- **文件名**：使用小写字母和连字符（kebab-case）或与导出的主要类/函数同名
+
+## 注释规范
+
+- 公共 API 必须添加 JSDoc 注释
+- 复杂逻辑必须添加中文注释说明
+- 临时解决方案或待优化代码必须添加 TODO 注释
+- 注释应该解释"为什么"而不是"是什么"
+
+## 模块结构
+
+- 避免使用默认导出，优先使用命名导出
+- 每个文件应该有一个明确的职责
+- 每个文件应该不超过 300 行代码
+- 相关功能应该组织在同一个目录下
+
+## 测试规范
+
+- 新功能必须包含相应的测试
+- 修复 bug 时必须添加回归测试
+- 测试覆盖率应该保持在合理水平（建议 > 80%）
+- 测试应该清晰、独立、可重复
+
+## Agent 规则
+
+- 没有正确修复问题时重新修复时，尽量还原上次修改的内容后再进行修复
+- 每次完成代码修改后，必须检查并处理编译错误
+- 确保所有测试通过后再告知用户任务完成
+`;
+/**
+ * tsconfig.json 模板
+ */
+export const tsconfigTemplate = {
+    compilerOptions: {
+        target: 'ES5',
+        module: 'CommonJS',
+        noImplicitAny: false,
+        sourceMap: true,
+        declarationMap: true,
+        declaration: true,
+        experimentalDecorators: true,
+        emitDeclarationOnly: true,
+        skipLibCheck: true,
+        esModuleInterop: true,
+        downlevelIteration: true,
+        lib: ['ES2015', 'ES2017', 'ES2020', 'DOM'],
+        outDir: 'lib',
+    },
+    include: ['src/**/*.ts'],
+};
+/**
+ * vitest.config.ts 模板
+ */
+export const vitestConfigTemplate = `import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+    test: {
+        testTimeout: 0,
+    },
+});
+`;
+/**
+ * typedoc.json 模板
+ */
+export function createTypedocConfig(options) {
+    return {
+        name: options.name,
+        $schema: 'https://typedoc.org/schema.json',
+        entryPoints: ['src/index.ts'],
+        sourceLinkTemplate: `https://github.com/feng3d-labs/${options.repoName}/tree/master/{path}#L{line}`,
+        out: 'public/docs',
+    };
+}
+//# sourceMappingURL=templates.js.map

package/dist/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;;;;;;;;;;;;CAYhC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8EnC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC5B,eAAe,EAAE;QACb,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,UAAU;QAClB,aAAa,EAAE,KAAK;QACpB,SAAS,EAAE,IAAI;QACf,cAAc,EAAE,IAAI;QACpB,WAAW,EAAE,IAAI;QACjB,sBAAsB,EAAE,IAAI;QAC5B,mBAAmB,EAAE,IAAI;QACzB,YAAY,EAAE,IAAI;QAClB,eAAe,EAAE,IAAI;QACrB,kBAAkB,EAAE,IAAI;QACxB,GAAG,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC;QAC1C,MAAM,EAAE,KAAK;KAChB;IACD,OAAO,EAAE,CAAC,aAAa,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;;;;;;;CAOnC,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAGnC;IAEG,OAAO;QACH,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,OAAO,EAAE,iCAAiC;QAC1C,WAAW,EAAE,CAAC,cAAc,CAAC;QAC7B,kBAAkB,EAAE,kCAAkC,OAAO,CAAC,QAAQ,6BAA6B;QACnG,GAAG,EAAE,aAAa;KACrB,CAAC;AACN,CAAC"}

package/dist/versions.d.ts

@@ -0,0 +1,29 @@
+/**
+ * feng3d 项目统一依赖版本
+ */
+export declare const VERSIONS: {
+    readonly typescript: "5.8.3";
+    readonly tslib: "^2.8.1";
+    readonly eslint: "9.26.0";
+    readonly '@eslint/js': "^9.0.0";
+    readonly '@typescript-eslint/eslint-plugin': "8.32.1";
+    readonly '@typescript-eslint/parser': "8.32.1";
+    readonly 'typescript-eslint': "^8.32.1";
+    readonly globals: "^14.0.0";
+    readonly vitest: "^3.1.3";
+    readonly '@vitest/coverage-v8': "^3.2.4";
+    readonly 'happy-dom': "^20.0.11";
+    readonly vite: "^6.3.5";
+    readonly rimraf: "6.0.1";
+    readonly 'cross-env': "7.0.3";
+    readonly typedoc: "^0.28.4";
+};
+/**
+ * 获取 devDependencies 配置
+ */
+export declare function getDevDependencies(options?: {
+    includeVitest?: boolean;
+    includeTypedoc?: boolean;
+    includeCoverage?: boolean;
+}): Record<string, string>;
+//# sourceMappingURL=versions.d.ts.map

package/dist/versions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions.d.ts","sourceRoot":"","sources":["../src/versions.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;CAyBX,CAAC;AAEX;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,GAAE;IACxC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,OAAO,CAAC;CACxB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAgC9B"}

package/dist/versions.js

@@ -0,0 +1,54 @@
+/**
+ * feng3d 项目统一依赖版本
+ */
+export const VERSIONS = {
+    // TypeScript 相关
+    typescript: '5.8.3',
+    tslib: '^2.8.1',
+    // ESLint 相关
+    eslint: '9.26.0',
+    '@eslint/js': '^9.0.0',
+    '@typescript-eslint/eslint-plugin': '8.32.1',
+    '@typescript-eslint/parser': '8.32.1',
+    'typescript-eslint': '^8.32.1',
+    globals: '^14.0.0',
+    // 测试相关
+    vitest: '^3.1.3',
+    '@vitest/coverage-v8': '^3.2.4',
+    'happy-dom': '^20.0.11',
+    // 构建工具
+    vite: '^6.3.5',
+    rimraf: '6.0.1',
+    'cross-env': '7.0.3',
+    // 文档
+    typedoc: '^0.28.4',
+};
+/**
+ * 获取 devDependencies 配置
+ */
+export function getDevDependencies(options = {}) {
+    const deps = {
+        '@eslint/js': VERSIONS['@eslint/js'],
+        '@typescript-eslint/eslint-plugin': VERSIONS['@typescript-eslint/eslint-plugin'],
+        '@typescript-eslint/parser': VERSIONS['@typescript-eslint/parser'],
+        'cross-env': VERSIONS['cross-env'],
+        eslint: VERSIONS.eslint,
+        globals: VERSIONS.globals,
+        rimraf: VERSIONS.rimraf,
+        tslib: VERSIONS.tslib,
+        typescript: VERSIONS.typescript,
+        'typescript-eslint': VERSIONS['typescript-eslint'],
+        vite: VERSIONS.vite,
+    };
+    if (options.includeVitest !== false) {
+        deps.vitest = VERSIONS.vitest;
+    }
+    if (options.includeCoverage) {
+        deps['@vitest/coverage-v8'] = VERSIONS['@vitest/coverage-v8'];
+    }
+    if (options.includeTypedoc !== false) {
+        deps.typedoc = VERSIONS.typedoc;
+    }
+    return deps;
+}
+//# sourceMappingURL=versions.js.map

package/dist/versions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions.js","sourceRoot":"","sources":["../src/versions.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACpB,gBAAgB;IAChB,UAAU,EAAE,OAAO;IACnB,KAAK,EAAE,QAAQ;IAEf,YAAY;IACZ,MAAM,EAAE,QAAQ;IAChB,YAAY,EAAE,QAAQ;IACtB,kCAAkC,EAAE,QAAQ;IAC5C,2BAA2B,EAAE,QAAQ;IACrC,mBAAmB,EAAE,SAAS;IAC9B,OAAO,EAAE,SAAS;IAElB,OAAO;IACP,MAAM,EAAE,QAAQ;IAChB,qBAAqB,EAAE,QAAQ;IAC/B,WAAW,EAAE,UAAU;IAEvB,OAAO;IACP,IAAI,EAAE,QAAQ;IACd,MAAM,EAAE,OAAO;IACf,WAAW,EAAE,OAAO;IAEpB,KAAK;IACL,OAAO,EAAE,SAAS;CACZ,CAAC;AAEX;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,UAI/B,EAAE;IAEF,MAAM,IAAI,GAA2B;QACjC,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;QACpC,kCAAkC,EAAE,QAAQ,CAAC,kCAAkC,CAAC;QAChF,2BAA2B,EAAE,QAAQ,CAAC,2BAA2B,CAAC;QAClE,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC;QAClC,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;QAClD,IAAI,EAAE,QAAQ,CAAC,IAAI;KACtB,CAAC;IAEF,IAAI,OAAO,CAAC,aAAa,KAAK,KAAK,EACnC,CAAC;QACG,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;IAClC,CAAC;IAED,IAAI,OAAO,CAAC,eAAe,EAC3B,CAAC;QACG,IAAI,CAAC,qBAAqB,CAAC,GAAG,QAAQ,CAAC,qBAAqB,CAAC,CAAC;IAClE,CAAC;IAED,IAAI,OAAO,CAAC,cAAc,KAAK,KAAK,EACpC,CAAC;QACG,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;IACpC,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/package.json

@@ -0,0 +1,68 @@
+{
+    "name": "feng3d-cli",
+    "version": "0.0.1",
+    "description": "feng3d 项目通用标准，包含代码规范、配置模板和 CLI 工具",
+    "homepage": "https://github.com/feng3d-labs/feng3d-cli",
+    "author": "feng",
+    "license": "MIT",
+    "type": "module",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "bin": {
+        "feng3d-cli": "./dist/cli.js"
+    },
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js"
+        },
+        "./eslint": {
+            "types": "./dist/eslint.d.ts",
+            "import": "./dist/eslint.js"
+        }
+    },
+    "scripts": {
+        "build": "tsc",
+        "dev": "tsc -w",
+        "test": "vitest run",
+        "test:watch": "vitest",
+        "lint": "eslint . --ext .js,.ts --max-warnings 0",
+        "lintfix": "npm run lint -- --fix",
+        "update-rules": "node dist/cli.js update --all",
+        "prepublishOnly": "npm run lint && npm test && npm run build",
+        "publish:manual": "npm publish"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/feng3d-labs/feng3d-cli.git"
+    },
+    "files": [
+        "dist",
+        "templates"
+    ],
+    "dependencies": {
+        "ali-oss": "^6.22.0",
+        "chalk": "^5.3.0",
+        "commander": "^12.1.0",
+        "fs-extra": "^11.2.0"
+    },
+    "devDependencies": {
+        "@eslint/js": "^9.0.0",
+        "@types/fs-extra": "^11.0.4",
+        "@types/node": "^22.10.2",
+        "@typescript-eslint/eslint-plugin": "8.32.1",
+        "@typescript-eslint/parser": "8.32.1",
+        "eslint": "9.26.0",
+        "globals": "^14.0.0",
+        "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"
+    }
+}

package/templates/.cursorrules

@@ -0,0 +1,79 @@
+# Cursor 项目规则
+
+## Git 提交信息规范
+
+当生成 Git 提交信息时：
+
+1. **语言**：始终使用简体中文
+
+2. **格式**：遵循约定式提交（Conventional Commits）格式
+   ```
+   <类型>(<范围>): <简短描述>
+
+   [可选的详细说明]
+
+   [可选的脚注]
+   ```
+
+3. **提交类型**（中文描述）：
+   - `feat`: 新增功能
+   - `fix`: 修复问题
+   - `refactor`: 代码重构（不改变功能）
+   - `perf`: 性能优化
+   - `style`: 代码格式调整（不影响代码含义）
+   - `docs`: 文档更新
+   - `test`: 测试相关
+   - `chore`: 构建过程或辅助工具的变动
+   - `build`: 构建系统或外部依赖项的更改
+   - `ci`: CI 配置文件和脚本的更改
+
+4. **范围**（可选）：可以是模块、组件或功能区域
+
+5. **提交信息要求**：
+   - 第一行简短描述，不超过 50 个字符
+   - 使用祈使句，如"添加"、"修复"、"优化"
+   - 描述要清晰、具体、有意义
+
+## 代码风格
+
+- 优先使用 TypeScript
+- 遵循现有代码的命名约定和格式
+- 添加必要的中文注释以提高代码可读性
+- 使用 ESLint 保持代码格式一致
+- 提交前必须通过 lint 检查
+- 避免使用 `any` 类型，优先使用明确的类型定义
+
+## 命名规范
+
+- **变量和函数**：使用驼峰命名（camelCase）
+- **类和接口**：使用帕斯卡命名（PascalCase）
+- **常量**：使用全大写下划线分隔（UPPER_SNAKE_CASE）
+- **文件名**：使用小写字母和连字符（kebab-case）或与导出的主要类/函数同名
+
+## 注释规范
+
+- 公共 API 必须添加 JSDoc 注释
+- 复杂逻辑必须添加中文注释说明
+- 临时解决方案或待优化代码必须添加 TODO 注释
+- 注释应该解释"为什么"而不是"是什么"
+
+## 模块结构
+
+- 避免使用默认导出，优先使用命名导出
+- 每个文件应该有一个明确的职责
+- 每个文件应该不超过 300 行代码
+- 相关功能应该组织在同一个目录下
+
+## 测试规范
+
+- 新功能必须包含相应的测试
+- 修复 bug 时必须添加回归测试
+- 测试覆盖率应该保持在合理水平（建议 > 80%）
+- 测试应该清晰、独立、可重复
+
+## Agent 规则
+
+- 没有正确修复问题时重新修复时，尽量还原上次修改的内容后再进行修复
+- 每次完成代码修改后，必须检查并处理编译错误
+- 确保所有测试通过后再告知用户任务完成
+