feng3d-cli 0.0.1 → 0.0.3

package/templates/.github/workflows/publish.yml

@@ -0,0 +1,128 @@
+# 当 package.json 中的版本在 npm 不存在时自动发布
+name: Publish to NPM
+
+on:
+  push:
+    branches:
+      - master
+      - main
+  workflow_dispatch:  # 支持手动触发
+
+jobs:
+  check-version:
+    runs-on: ubuntu-latest
+    outputs:
+      should_publish: ${{ steps.check.outputs.should_publish }}
+      version: ${{ steps.check.outputs.version }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Check if version exists on npm
+        id: check
+        run: |
+          # 获取包名和当前版本
+          PACKAGE_NAME=$(node -p "require('./package.json').name")
+          CURRENT_VERSION=$(node -p "require('./package.json').version")
+          echo "Package: $PACKAGE_NAME"
+          echo "Current version: $CURRENT_VERSION"
+
+          # 检查该版本是否已在 npm 上存在
+          HTTP_STATUS=$(curl -s -o /dev/null -w "%{http_code}" "https://registry.npmjs.org/$PACKAGE_NAME/$CURRENT_VERSION")
+
+          if [ "$HTTP_STATUS" = "404" ]; then
+            echo "Version $CURRENT_VERSION not found on npm, will publish"
+            echo "should_publish=true" >> $GITHUB_OUTPUT
+            echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
+          else
+            echo "Version $CURRENT_VERSION already exists on npm (HTTP $HTTP_STATUS)"
+            echo "should_publish=false" >> $GITHUB_OUTPUT
+          fi
+
+  publish:
+    needs: check-version
+    if: needs.check-version.outputs.should_publish == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # 获取完整历史以生成更新日志
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
+      - name: Run lint
+        run: npm run lint
+
+      - name: Run tests
+        run: npm test
+
+      - name: Publish to NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Create Git Tag
+        run: |
+          VERSION=${{ needs.check-version.outputs.version }}
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git tag -a "v$VERSION" -m "Release v$VERSION"
+          git push origin "v$VERSION"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Generate Release Notes
+        id: release_notes
+        run: |
+          VERSION=${{ needs.check-version.outputs.version }}
+
+          # 获取上一个版本的 tag
+          PREVIOUS_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "")
+
+          echo "Previous tag: $PREVIOUS_TAG"
+
+          # 生成更新日志
+          if [ -n "$PREVIOUS_TAG" ]; then
+            echo "## 更新内容" > release_notes.md
+            echo "" >> release_notes.md
+            echo "与 $PREVIOUS_TAG 相比的变更：" >> release_notes.md
+            echo "" >> release_notes.md
+
+            # 获取提交日志
+            git log --pretty=format:"- %s (%h)" $PREVIOUS_TAG..HEAD >> release_notes.md
+          else
+            echo "## 更新内容" > release_notes.md
+            echo "" >> release_notes.md
+            echo "首次发布" >> release_notes.md
+            echo "" >> release_notes.md
+
+            # 获取所有提交日志
+            git log --pretty=format:"- %s (%h)" >> release_notes.md
+          fi
+
+          echo "" >> release_notes.md
+
+          # 输出生成的内容
+          echo "Generated release notes:"
+          cat release_notes.md
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: v${{ needs.check-version.outputs.version }}
+          name: Release v${{ needs.check-version.outputs.version }}
+          body_path: release_notes.md
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

package/templates/.github/workflows/pull-request.yml

@@ -0,0 +1,31 @@
+# 合并请求 CI - 运行单元测试
+name: Pull Request CI
+
+on:
+  pull_request:
+    branches:
+      - master
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    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: Run lint
+        run: npm run lint
+
+      - name: Run unit tests
+        run: npm test
+

package/templates/.husky/pre-commit

@@ -0,0 +1,2 @@
+npx lint-staged
+

package/templates/.vscode/settings.json

@@ -0,0 +1,10 @@
+// 将设置放入此文件中以覆盖默认值和用户设置。
+{
+    // 定义函数的左大括号是否放置在新的一行。
+    "typescript.format.placeOpenBraceOnNewLineForFunctions": true,
+    // 定义控制块的左括号是否放置在新的一行。
+    "typescript.format.placeOpenBraceOnNewLineForControlBlocks": true,
+    "javascript.format.placeOpenBraceOnNewLineForFunctions": true,
+    "javascript.format.placeOpenBraceOnNewLineForControlBlocks": true
+}
+

package/templates/LICENSE

@@ -0,0 +1,15 @@
+MIT 许可证
+
+版权所有 (c) {{year}} feng
+
+特此授予任何获得本软件及相关文档文件（"软件"）副本的人免费许可，
+可以不受限制地处理本软件，包括但不限于使用、复制、修改、合并、
+发布、分发、再许可和/或销售本软件的副本，并允许向其提供本软件的
+人这样做，但须符合以下条件：
+
+上述版权声明和本许可声明应包含在本软件的所有副本或主要部分中。
+
+本软件按"原样"提供，不提供任何明示或暗示的保证，包括但不限于对
+适销性、特定用途适用性和非侵权性的保证。在任何情况下，作者或版权
+持有人均不对因本软件或本软件的使用或其他交易而产生的任何索赔、
+损害或其他责任负责，无论是在合同诉讼、侵权诉讼还是其他诉讼中。

package/templates/eslint.config.js

@@ -0,0 +1,159 @@
+// 导入 ESLint 核心模块
+import eslint from '@eslint/js';
+// 导入 TypeScript ESLint 配置
+import tseslint from 'typescript-eslint';
+// 导入全局变量定义
+import globals from 'globals';
+
+// 导出 ESLint 配置
+export default [
+    // 忽略检查的文件和目录
+    {
+        ignores: [
+            '**/node_modules/**',    // 忽略所有 node_modules 目录
+            '**/dist/**',            // 忽略所有 dist 目录
+            '**/lib/**',             // 忽略所有 lib 目录
+            '**/public/**',          // 忽略所有 public 目录
+            '**/coverage/**',        // 忽略所有 coverage 目录
+            '**/.git/**',            // 忽略所有 .git 目录
+        ],
+    },
+    // 使用 ESLint 推荐配置
+    eslint.configs.recommended,
+    // 使用 TypeScript ESLint 推荐配置
+    ...tseslint.configs.recommended,
+    {
+        // 语言选项配置
+        languageOptions: {
+            // 全局变量配置
+            globals: {
+                ...globals.browser,   // 浏览器环境全局变量
+                ...globals.node,      // Node.js 环境全局变量
+                ...globals.es2021,    // ES2021 全局变量
+                global: false,        // 禁用 global 全局变量
+            },
+            // 解析器选项
+            parserOptions: {
+                ecmaVersion: 2021,    // 使用 ES2021 语法
+                sourceType: 'module', // 使用 ES 模块
+                tsconfigRootDir: import.meta.dirname, // 明确指定 tsconfig 根目录
+            },
+        },
+        rules: {
+            '@typescript-eslint/no-unused-vars': 'off',           // 允许未使用的变量
+            '@typescript-eslint/no-explicit-any': 'off',          // 允许使用 any 类型
+            'no-prototype-builtins': 'off',                       // 允许直接使用 Object.prototype 方法
+            '@typescript-eslint/ban-ts-comment': 'off',           // 允许使用 @ts 注释
+            '@typescript-eslint/no-unused-expressions': 'off',    // 允许未使用的表达式
+            '@typescript-eslint/no-empty-object-type': 'off',     // 允许空对象类型
+            '@typescript-eslint/no-unsafe-declaration-merging': 'off', // 允许不安全的声明合并
+            '@typescript-eslint/no-unsafe-function-type': 'off',  // 允许不安全的函数类型
+            '@typescript-eslint/no-this-alias': 'off',            // 允许 this 别名
+            'prefer-const': 'off',                                // 不强制使用 const
+            'no-fallthrough': 'off',                              // 允许 fallthrough
+            'no-constant-binary-expression': 'off',              // 允许常量二进制表达式
+
+            // 注释格式规则
+            'spaced-comment': ['warn', 'always', {
+                'line': {
+                    'markers': ['/'],              // 以 / 开头的注释需要空格
+                    'exceptions': ['-', '+'],      // 允许以 - 和 + 开头的注释不需要空格
+                },
+                'block': {
+                    'markers': ['!'],              // 以 ! 开头的块级注释需要空格
+                    'exceptions': ['*'],           // 允许以 * 开头的块级注释不需要空格
+                    'balanced': true,              // 要求块级注释的 * 对齐
+                },
+            }],
+
+            // 空格和换行规则
+            'no-trailing-spaces': ['warn', {       // 禁止行尾空格
+                'skipBlankLines': false,           // 不跳过空行
+                'ignoreComments': false,           // 不忽略注释
+            }],
+            'no-multiple-empty-lines': ['warn', {  // 限制空行数量
+                'max': 1,                          // 最多允许 1 个空行
+                'maxEOF': 1,                       // 文件末尾最多 1 个空行
+                'maxBOF': 0,                       // 文件开头不允许空行
+            }],
+            'lines-between-class-members': ['warn', 'always', {  // 类成员之间需要空行
+                'exceptAfterSingleLine': true,     // 单行成员后可以没有空行
+            }],
+            'padding-line-between-statements': [   // 语句之间的空行规则
+                'warn',
+                { 'blankLine': 'always', 'prev': '*', 'next': 'return' },  // return 前需要空行
+                { 'blankLine': 'always', 'prev': ['const', 'let', 'var'], 'next': '*' },  // 变量声明后需要空行
+                { 'blankLine': 'any', 'prev': ['const', 'let', 'var'], 'next': ['const', 'let', 'var'] },  // 变量声明之间可以没有空行
+            ],
+
+            // 缩进规则
+            'indent': ['warn', 4, {               // 使用 4 空格缩进
+                'SwitchCase': 1,                  // switch case 缩进 1 级
+                'VariableDeclarator': 'first',    // 变量声明对齐到第一个变量
+                'outerIIFEBody': 1,               // 外层 IIFE 缩进 1 级
+                'MemberExpression': 1,            // 成员表达式缩进 1 级
+                'FunctionDeclaration': {          // 函数声明缩进规则
+                    'parameters': 1,              // 参数缩进 1 级
+                    'body': 1,                    // 函数体缩进 1 级
+                },
+                'FunctionExpression': {           // 函数表达式缩进规则
+                    'parameters': 1,              // 参数缩进 1 级
+                    'body': 1,                    // 函数体缩进 1 级
+                },
+                'CallExpression': {               // 函数调用缩进规则
+                    'arguments': 1,               // 参数缩进 1 级
+                },
+                'ArrayExpression': 1,             // 数组表达式缩进 1 级
+                'ObjectExpression': 1,            // 对象表达式缩进 1 级
+                'ImportDeclaration': 1,           // import 声明缩进 1 级
+                'flatTernaryExpressions': false,  // 不扁平化三元表达式
+                'ignoreComments': false,          // 不忽略注释
+            }],
+
+            // 引号规则
+            'quotes': ['warn', 'single', {        // 使用单引号
+                'avoidEscape': true,              // 允许使用转义字符
+                'allowTemplateLiterals': true,    // 允许使用模板字符串
+            }],
+
+            // 其他格式规则
+            'semi': ['off'],           // 要求使用分号
+            'comma-dangle': ['warn', 'always-multiline'],  // 多行时要求尾随逗号
+            'object-curly-spacing': ['warn', 'always'],    // 对象括号内要求空格
+            'array-bracket-spacing': ['warn', 'never'],    // 数组括号内不允许空格
+            'arrow-spacing': ['warn', {           // 箭头函数空格规则
+                'before': true,                   // 箭头前需要空格
+                'after': true,                    // 箭头后需要空格
+            }],
+            'block-spacing': ['warn', 'always'],  // 块级代码需要空格
+            'brace-style': ['warn', 'allman', {   // 大括号风格
+                'allowSingleLine': false,         // 不允许单行大括号
+            }],
+            'comma-spacing': ['warn', {           // 逗号空格规则
+                'before': false,                  // 逗号前不允许空格
+                'after': true,                    // 逗号后需要空格
+            }],
+            'comma-style': ['warn', 'last'],      // 逗号放在行尾
+            'key-spacing': ['warn', {             // 对象键值对空格规则
+                'beforeColon': false,             // 冒号前不允许空格
+                'afterColon': true,               // 冒号后需要空格
+            }],
+            'keyword-spacing': ['warn', {         // 关键字空格规则
+                'before': true,                   // 关键字前需要空格
+                'after': true,                    // 关键字后需要空格
+            }],
+            'space-before-blocks': ['warn', 'always'],  // 块级代码前需要空格
+            'space-before-function-paren': ['warn', {    // 函数括号前空格规则
+                'anonymous': 'always',            // 匿名函数括号前需要空格
+                'named': 'never',                 // 命名函数括号前不允许空格
+                'asyncArrow': 'always',           // 异步箭头函数括号前需要空格
+            }],
+            'space-in-parens': ['warn', 'never'], // 括号内不允许空格
+            'space-infix-ops': ['warn'],          // 操作符前后需要空格
+            'space-unary-ops': ['warn', {         // 一元操作符空格规则
+                'words': true,                    // 单词类操作符需要空格
+                'nonwords': false,                // 非单词类操作符不需要空格
+            }],
+        },
+    },
+];

package/templates/feng3d.json

@@ -0,0 +1,42 @@
+{
+    "$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
+    }
+}
+

package/templates/gitignore

@@ -0,0 +1,23 @@
+node_modules
+package-lock.json
+dist
+lib
+public
+out
+# 自动生成的测试配置文件
+**/test-config.ts
+# 测试构建输出目录
+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

package/templates/test/_.test.ts

@@ -0,0 +1,5 @@
+import { test } from 'vitest';
+
+test('_', () =>
+{ });
+

package/templates/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "target": "ESNext",
+        "module": "ESNext",
+        "moduleResolution": "bundler",
+        "lib": ["ESNext", "DOM", "DOM.Iterable"],
+        "emitDeclarationOnly": true,
+        "declaration": true,
+        "declarationMap": true,
+        "outDir": "lib",
+        "esModuleInterop": true,
+        "allowSyntheticDefaultImports": true,
+        "forceConsistentCasingInFileNames": true,
+        "skipLibCheck": true,
+        "resolveJsonModule": true,
+        "isolatedModules": true
+    },
+    "include": ["src/**/*.ts"],
+    "exclude": ["node_modules", "dist", "lib", "public"]
+}

package/templates/typedoc.json

@@ -0,0 +1,8 @@
+{
+    "name": "{{name}}",
+    "$schema": "https://typedoc.org/schema.json",
+    "entryPoints": ["src/index.ts"],
+    "sourceLinkTemplate": "https://github.com/feng3d-labs/{{repoName}}/tree/master/{path}#L{line}",
+    "out": "public"
+}
+

package/templates/vitest.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+    test: {
+        testTimeout: 0,
+    },
+});
+