feng3d-cli 0.0.2 → 0.0.4

package/templates/eslint.config.js

@@ -10,12 +10,12 @@ export default [
     // 忽略检查的文件和目录
     {
         ignores: [
-            '**/node_modules/**',
-            '**/dist/**',
-            '**/lib/**',
-            '**/public/**',
-            '**/coverage/**',
-            '**/.git/**',
+            '**/node_modules/**',    // 忽略所有 node_modules 目录
+            '**/dist/**',            // 忽略所有 dist 目录
+            '**/lib/**',             // 忽略所有 lib 目录
+            '**/public/**',          // 忽略所有 public 目录
+            '**/coverage/**',        // 忽略所有 coverage 目录
+            '**/.git/**',            // 忽略所有 .git 目录
         ],
     },
     // 使用 ESLint 推荐配置
@@ -25,84 +25,135 @@ export default [
     {
         // 语言选项配置
         languageOptions: {
+            // 全局变量配置
             globals: {
-                ...globals.browser,
-                ...globals.node,
-                ...globals.es2021,
-                global: false,
+                ...globals.browser,   // 浏览器环境全局变量
+                ...globals.node,      // Node.js 环境全局变量
+                ...globals.es2021,    // ES2021 全局变量
+                global: false,        // 禁用 global 全局变量
             },
+            // 解析器选项
             parserOptions: {
-                ecmaVersion: 2021,
-                sourceType: 'module',
-                tsconfigRootDir: import.meta.dirname,
+                ecmaVersion: 2021,    // 使用 ES2021 语法
+                sourceType: 'module', // 使用 ES 模块
+                tsconfigRootDir: import.meta.dirname, // 明确指定 tsconfig 根目录
             },
         },
         rules: {
-            '@typescript-eslint/no-unused-vars': 'off',
-            '@typescript-eslint/no-explicit-any': 'off',
-            'no-prototype-builtins': 'off',
-            '@typescript-eslint/ban-ts-comment': 'off',
-            '@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',
-            'prefer-const': 'off',
-            'no-fallthrough': 'off',
-            'no-constant-binary-expression': 'off',
+            '@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 },
+                'line': {
+                    'markers': ['/'],              // 以 / 开头的注释需要空格
+                    'exceptions': ['-', '+'],      // 允许以 - 和 + 开头的注释不需要空格
+                },
+                'block': {
+                    'markers': ['!'],              // 以 ! 开头的块级注释需要空格
+                    'exceptions': ['*'],           // 允许以 * 开头的块级注释不需要空格
+                    'balanced': true,              // 要求块级注释的 * 对齐
+                },
             }],
 
             // 空格和换行规则
-            'no-trailing-spaces': ['warn', { 'skipBlankLines': false, 'ignoreComments': false }],
-            'no-multiple-empty-lines': ['warn', { 'max': 1, 'maxEOF': 1, 'maxBOF': 0 }],
-            'lines-between-class-members': ['warn', 'always', { 'exceptAfterSingleLine': true }],
-            'padding-line-between-statements': [
+            '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' },
-                { 'blankLine': 'any', 'prev': ['const', 'let', 'var'], 'next': ['const', 'let', 'var'] },
+                { 'blankLine': 'always', 'prev': '*', 'next': 'return' },  // return 前需要空行
+                { 'blankLine': 'always', 'prev': ['const', 'let', 'var'], 'next': '*' },  // 变量声明后需要空行
+                { 'blankLine': 'any', 'prev': ['const', 'let', 'var'], 'next': ['const', 'let', 'var'] },  // 变量声明之间可以没有空行
             ],
 
-            // 缩进规则 - 4 空格
-            'indent': ['warn', 4, {
-                'SwitchCase': 1,
-                'VariableDeclarator': 'first',
-                'outerIIFEBody': 1,
-                'MemberExpression': 1,
-                'FunctionDeclaration': { 'parameters': 1, 'body': 1 },
-                'FunctionExpression': { 'parameters': 1, 'body': 1 },
-                'CallExpression': { 'arguments': 1 },
-                'ArrayExpression': 1,
-                'ObjectExpression': 1,
-                'ImportDeclaration': 1,
-                'flatTernaryExpressions': false,
-                'ignoreComments': false,
+            // 缩进规则
+            '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 }],
+            // 引号规则
+            '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'],
-            '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 }],
+            '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

@@ -1,19 +1,20 @@
 {
     "compilerOptions": {
-        "target": "ES5",
-        "module": "CommonJS",
-        "noImplicitAny": false,
-        "sourceMap": true,
-        "declarationMap": true,
-        "declaration": true,
-        "experimentalDecorators": true,
+        "target": "ESNext",
+        "module": "ESNext",
+        "moduleResolution": "bundler",
+        "lib": ["ESNext", "DOM", "DOM.Iterable"],
         "emitDeclarationOnly": true,
-        "skipLibCheck": true,
+        "declaration": true,
+        "declarationMap": true,
+        "outDir": "lib",
         "esModuleInterop": true,
-        "downlevelIteration": true,
-        "lib": ["ES2015", "ES2017", "ES2020", "DOM"],
-        "outDir": "lib"
+        "allowSyntheticDefaultImports": true,
+        "forceConsistentCasingInFileNames": true,
+        "skipLibCheck": true,
+        "resolveJsonModule": true,
+        "isolatedModules": true
     },
-    "include": ["src/**/*.ts"]
+    "include": ["src/**/*.ts"],
+    "exclude": ["node_modules", "dist", "lib", "public"]
 }
-

package/templates/typedoc.json

@@ -1,8 +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/docs"
+    "out": "public",
+    "includeVersion": true
 }