@qlover/create-app 0.7.5 → 0.7.7

package/dist/templates/next-app/docs/env.md

@@ -0,0 +1,94 @@
+# 环境配置指南
+
+本项目使用 Next.js 内置的环境变量系统来管理不同环境的配置。
+
+## 环境文件
+
+项目支持以下环境配置文件：
+
+- `.env` - 默认环境配置，适用于所有环境
+- `.env.local` - 本地环境配置，会覆盖 `.env`（不应提交到版本控制）
+- `.env.development` - 开发环境配置
+- `.env.production` - 生产环境配置
+- `.env.test` - 测试环境配置
+
+加载优先级（从高到低）：
+
+1. `.env.local`
+2. `.env.[environment]`
+3. `.env`
+
+## 使用方法
+
+1. 复制 `.env.template` 创建对应环境的配置文件：
+
+```bash
+# 开发环境
+cp .env.template .env.development
+
+# 生产环境
+cp .env.template .env.production
+
+# 测试环境
+cp .env.template .env.test
+```
+
+2. 修改对应环境的配置文件内容
+
+3. 启动应用时指定环境：
+
+```bash
+# 开发环境
+APP_ENV=development npm run dev
+
+# 生产环境
+APP_ENV=production npm run build
+APP_ENV=production npm run start
+
+# 测试环境
+APP_ENV=test npm run test
+```
+
+## 在代码中使用环境变量
+
+1. 服务端和客户端都可访问的变量：
+
+```typescript
+// 在 .env 文件中定义
+PUBLIC_API_URL=http://api.example.com
+
+// 在代码中使用
+console.log(process.env.PUBLIC_API_URL)
+```
+
+2. 仅服务端可访问的变量：
+
+```typescript
+// 在 .env 文件中定义（以 PRIVATE_ 开头）
+PRIVATE_API_KEY = secret_key;
+
+// 在服务端代码中使用
+console.log(process.env.PRIVATE_API_KEY);
+```
+
+3. 使用运行时配置：
+
+```typescript
+import getConfig from 'next/config';
+
+const { serverRuntimeConfig, publicRuntimeConfig } = getConfig();
+
+// 服务端配置
+console.log(serverRuntimeConfig.mySecret);
+
+// 公共配置
+console.log(publicRuntimeConfig.appEnv);
+```
+
+## 注意事项
+
+1. 不要将包含敏感信息的 `.env` 文件提交到版本控制
+2. 确保 `.env.local` 和 `*.env` 文件在 `.gitignore` 中
+3. 使用 `.env.template` 作为配置模板
+4. 环境变量命名推荐使用大写字母和下划线
+5. 在 CI/CD 中使用环境变量时，直接在平台中配置，不要使用 .env 文件

package/dist/templates/next-app/eslint.config.mjs

@@ -0,0 +1,181 @@
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+import { FlatCompat } from '@eslint/eslintrc';
+import importPlugin from 'eslint-plugin-import';
+import prettierPlugin from 'eslint-plugin-prettier';
+import unusedImports from 'eslint-plugin-unused-imports';
+import qloverEslint from '@qlover/eslint-plugin';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const compat = new FlatCompat({ baseDirectory: __dirname });
+
+const eslintConfig = [
+  ...compat.extends(
+    'next/core-web-vitals',
+    'next/typescript',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
+    'plugin:prettier/recommended' // 添加 prettier 推荐配置
+  ),
+  {
+    ignores: [
+      // dependencies
+      'node_modules/**',
+      '.pnp/**',
+      '.pnp.js',
+
+      // testing
+      'coverage/**',
+      'test-results/**',
+
+      // next.js
+      '.next/**',
+      'out/**',
+      'build/**',
+      'dist/**',
+
+      // misc
+      '*.pem',
+
+      // debug
+      'npm-debug.log*',
+      'yarn-debug.log*',
+      'yarn-error.log*',
+
+      // env files
+      '.env*',
+
+      // vercel
+      '.vercel/**',
+
+      // typescript
+      '*.tsbuildinfo',
+      'next-env.d.ts',
+
+      // cache
+      '.cache/**',
+      '.eslintcache',
+
+      // IDE
+      '.idea/**',
+      '.vscode/**',
+
+      // package manager
+      'package-lock.json',
+      'yarn.lock',
+      'pnpm-lock.yaml',
+
+      // config files
+      '*.config.js',
+      '*.config.mjs',
+      '*.config.cjs',
+      'postcss.config.*',
+      'tailwind.config.*',
+      'next.config.*',
+      'jest.config.*',
+      'babel.config.*',
+
+      // static assets
+      'public/**',
+      '**/*.min.js',
+      '**/*.bundle.js',
+      '**/vendor/**',
+
+      // generated files
+      'coverage/**',
+      '.nyc_output/**',
+      'storybook-static/**'
+    ]
+  },
+  {
+    plugins: {
+      'unused-imports': unusedImports,
+      import: importPlugin,
+      prettier: prettierPlugin,
+      '@qlover-eslint': qloverEslint
+    },
+    rules: {
+      '@qlover-eslint/ts-class-method-return': 'error',
+      '@qlover-eslint/require-root-testid': 'error',
+      // 禁用原始的 no-unused-vars，使用 unused-imports 的规则替代
+      '@typescript-eslint/no-unused-vars': 'off',
+      // 强制使用 import type 导入类型
+      '@typescript-eslint/consistent-type-imports': [
+        'error',
+        {
+          prefer: 'type-imports',
+          disallowTypeAnnotations: true,
+          fixStyle: 'separate-type-imports'
+        }
+      ],
+      // 检查未使用的导入
+      'unused-imports/no-unused-imports': 'error',
+      // 检查未使用的变量，但允许以下划线开头的变量
+      'unused-imports/no-unused-vars': [
+        'error',
+        {
+          vars: 'all',
+          varsIgnorePattern: '^_',
+          args: 'after-used',
+          argsIgnorePattern: '^_'
+        }
+      ],
+      // import 语句排序规则
+      'import/order': [
+        'error',
+        {
+          groups: [
+            'builtin', // Node.js 内置模块
+            'external', // 第三方模块
+            'internal', // 内部模块（使用 alias 的导入）
+            ['parent', 'sibling'], // 父级和同级模块
+            'index', // 当前目录下的模块
+            'object', // 对象导入
+            'type' // 类型导入
+          ],
+          pathGroups: [
+            {
+              pattern: '@/**',
+              group: 'internal',
+              position: 'after'
+            }
+          ],
+          // "newlines-between": "always", // 不同组之间空一行
+          alphabetize: {
+            order: 'asc', // 按字母顺序排序
+            caseInsensitive: true // 排序时忽略大小写
+          }
+        }
+      ],
+      // Prettier 配置
+      'prettier/prettier': [
+        'error',
+        {
+          singleQuote: true,
+          trailingComma: 'none',
+          endOfLine: 'lf'
+        }
+      ],
+      // 默认禁用 export default
+      'import/no-default-export': 'error',
+    }
+  },
+  // 为特定文件允许 default export
+  {
+    files: [
+      'src/app/**/page.tsx',
+      'src/app/**/layout.tsx',
+      'src/app/**/not-found.tsx',
+      'src/i18n/request.ts',
+      'src/middleware.ts',
+      '**/*.config.*'
+    ],
+    rules: {
+      'import/no-default-export': 'off'
+    }
+  }
+];
+
+export default eslintConfig;

package/dist/templates/next-app/next.config.ts

@@ -0,0 +1,21 @@
+import createNextIntlPlugin from 'next-intl/plugin';
+import { generateLocales } from './build/generateLocales';
+import type { NextConfig } from 'next';
+
+const withNextIntl = createNextIntlPlugin();
+
+// 在构建开始时生成本地化文件
+generateLocales().catch((error) => {
+  console.error('Failed to generate locales:', error);
+});
+
+const nextConfig: NextConfig = {
+  turbopack: {
+    root: __dirname // 明确指定根目录
+  },
+  env: {
+    APP_ENV: process.env.APP_ENV
+  }
+};
+
+export default withNextIntl(nextConfig);

package/dist/templates/next-app/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "next-app",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "cross-env APP_ENV=localhost next dev --turbopack",
+    "dev:staging": "cross-env APP_ENV=staging next dev --turbopack",
+    "dev:prod": "cross-env APP_ENV=production next dev --turbopack",
+    "build": "cross-env APP_ENV=localhost next build --turbopack",
+    "build:staging": "cross-env APP_ENV=staging next build --turbopack",
+    "build:prod": "cross-env APP_ENV=production next build --turbopack",
+    "start": "next start",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --ext .ts,.tsx --fix",
+    "format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,css,scss,md}\"",
+    "format:check": "prettier --check \"**/*.{js,jsx,ts,tsx,json,css,scss,md}\"",
+    "fix": "npm run lint:fix && npm run format"
+  },
+  "dependencies": {
+    "@ant-design/icons": "^6.0.0",
+    "@ant-design/nextjs-registry": "^1.1.0",
+    "@ant-design/v5-patch-for-react-19": "^1.0.3",
+    "@brain-toolkit/antd-theme-override": "^0.0.3",
+    "@brain-toolkit/bridge": "^0.0.1",
+    "@qlover/corekit-bridge": "^1.6.4",
+    "@qlover/fe-corekit": "^2.1.0",
+    "@qlover/slice-store-react": "^1.4.1",
+    "antd": "^5.27.1",
+    "clsx": "^2.1.1",
+    "inversify": "^7.8.1",
+    "lodash": "^4.17.21",
+    "next": "15.5.0",
+    "next-intl": "^4.3.5",
+    "next-themes": "^0.4.6",
+    "react": "19.1.0",
+    "react-dom": "19.1.0"
+  },
+  "devDependencies": {
+    "@brain-toolkit/ts2locales": "^0.2.3",
+    "@eslint/eslintrc": "^3",
+    "@tailwindcss/postcss": "^4",
+    "@types/lodash": "^4.17.20",
+    "@types/node": "^20",
+    "@types/react": "^19",
+    "@types/react-dom": "^19",
+    "@qlover/eslint-plugin": "file:../../../packages/eslint-plugin",
+    "cross-env": "^7.0.3",
+    "eslint": "^9",
+    "eslint-config-next": "15.5.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-unused-imports": "^4.2.0",
+    "prettier": "^3.6.2",
+    "tailwindcss": "^4",
+    "typescript": "^5"
+  }
+}

package/dist/templates/next-app/plugins/eslint-plugin-testid.mjs

@@ -0,0 +1,94 @@
+export const eslintPluginTestId = {
+  rules: {
+    'require-root-testid': {
+      meta: {
+        type: 'problem',
+        docs: {
+          description:
+            'Enforce data-testid attribute on root elements of TSX components',
+          category: 'Best Practices',
+          recommended: true
+        },
+        fixable: 'code',
+        schema: []
+      },
+      create(context) {
+        return {
+          JSXElement(node) {
+            // 检查是否是组件的根元素
+            const isRootElement = (node) => {
+              const parent = node.parent;
+              if (!parent) return false;
+
+              // 如果父节点是 return 语句或者是箭头函数的主体，说明这是根元素
+              if (
+                parent.type === 'ReturnStatement' ||
+                (parent.type === 'ArrowFunctionExpression' &&
+                  parent.body === node)
+              ) {
+                return true;
+              }
+
+              return false;
+            };
+
+            if (isRootElement(node)) {
+              const hasTestId = node.openingElement.attributes.some(
+                (attr) =>
+                  attr.type === 'JSXAttribute' &&
+                  attr.name.name === 'data-testid'
+              );
+
+              if (!hasTestId) {
+                context.report({
+                  node: node.openingElement,
+                  message:
+                    'Root element of a component must have a data-testid attribute',
+                  fix(fixer) {
+                    // 获取组件名称作为 testid 的默认值
+                    let componentName = '';
+                    let current = node;
+                    while (current) {
+                      if (
+                        current.type === 'FunctionDeclaration' ||
+                        current.type === 'VariableDeclarator'
+                      ) {
+                        componentName = current.id?.name || '';
+                        break;
+                      }
+                      current = current.parent;
+                    }
+
+                    const sourceCode = context.getSourceCode();
+                    const openingElement = node.openingElement;
+                    const tagToken = sourceCode.getFirstToken(openingElement);
+                    const hasAttributes = openingElement.attributes.length > 0;
+
+                    if (hasAttributes) {
+                      // 如果有其他属性，在第一个属性前添加
+                      const firstAttribute = openingElement.attributes[0];
+                      const indent = sourceCode
+                        .getText()
+                        .slice(0, firstAttribute.range[0])
+                        .match(/\s*$/)[0];
+                      return fixer.insertTextBefore(
+                        firstAttribute,
+                        `data-testid='${componentName || 'component'}'${indent}`
+                      );
+                    } else {
+                      // 如果没有其他属性，在标签名后面添加
+                      return fixer.insertTextAfter(
+                        tagToken,
+                        ` data-testid='${componentName || 'component'}'`
+                      );
+                    }
+                  }
+                });
+              }
+            }
+          }
+        };
+      }
+    }
+  }
+};

package/dist/templates/next-app/plugins/generateLocalesPlugin.ts

@@ -0,0 +1,33 @@
+import { generateLocales } from '../build/generateLocales';
+import type { NextConfig } from 'next';
+
+export function withGenerateLocales(nextConfig: NextConfig = {}) {
+  return {
+    ...nextConfig,
+    onDevelopmentStart: async () => {
+      try {
+        await generateLocales();
+        console.log('✅ Locales generated successfully');
+      } catch (error) {
+        console.error('❌ Failed to generate locales:', error);
+      }
+    },
+    webpack: (config, options) => {
+      const { dev, isServer } = options;
+
+      // 在生产构建开始时生成本地化文件
+      if (!dev && isServer) {
+        generateLocales().catch((error) => {
+          console.error('❌ Failed to generate locales:', error);
+        });
+      }
+
+      // 如果原配置有 webpack 配置，则调用它
+      if (typeof nextConfig.webpack === 'function') {
+        return nextConfig.webpack(config, options);
+      }
+
+      return config;
+    }
+  };
+}

package/dist/templates/next-app/postcss.config.mjs

@@ -0,0 +1,5 @@
+const config = {
+  plugins: ["@tailwindcss/postcss"],
+};
+
+export default config;

package/dist/templates/next-app/public/file.svg

@@ -0,0 +1 @@
+<svg fill="none" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"><path d="M14.5 13.5V5.41a1 1 0 0 0-.3-.7L9.8.29A1 1 0 0 0 9.08 0H1.5v13.5A2.5 2.5 0 0 0 4 16h8a2.5 2.5 0 0 0 2.5-2.5m-1.5 0v-7H8v-5H3v12a1 1 0 0 0 1 1h8a1 1 0 0 0 1-1M9.5 5V2.12L12.38 5zM5.13 5h-.62v1.25h2.12V5zm-.62 3h7.12v1.25H4.5zm.62 3h-.62v1.25h7.12V11z" clip-rule="evenodd" fill="#666" fill-rule="evenodd"/></svg>

package/dist/templates/next-app/public/globe.svg

@@ -0,0 +1 @@
+<svg fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><g clip-path="url(#a)"><path fill-rule="evenodd" clip-rule="evenodd" d="M10.27 14.1a6.5 6.5 0 0 0 3.67-3.45q-1.24.21-2.7.34-.31 1.83-.97 3.1M8 16A8 8 0 1 0 8 0a8 8 0 0 0 0 16m.48-1.52a7 7 0 0 1-.96 0H7.5a4 4 0 0 1-.84-1.32q-.38-.89-.63-2.08a40 40 0 0 0 3.92 0q-.25 1.2-.63 2.08a4 4 0 0 1-.84 1.31zm2.94-4.76q1.66-.15 2.95-.43a7 7 0 0 0 0-2.58q-1.3-.27-2.95-.43a18 18 0 0 1 0 3.44m-1.27-3.54a17 17 0 0 1 0 3.64 39 39 0 0 1-4.3 0 17 17 0 0 1 0-3.64 39 39 0 0 1 4.3 0m1.1-1.17q1.45.13 2.69.34a6.5 6.5 0 0 0-3.67-3.44q.65 1.26.98 3.1M8.48 1.5l.01.02q.41.37.84 1.31.38.89.63 2.08a40 40 0 0 0-3.92 0q.25-1.2.63-2.08a4 4 0 0 1 .85-1.32 7 7 0 0 1 .96 0m-2.75.4a6.5 6.5 0 0 0-3.67 3.44 29 29 0 0 1 2.7-.34q.31-1.83.97-3.1M4.58 6.28q-1.66.16-2.95.43a7 7 0 0 0 0 2.58q1.3.27 2.95.43a18 18 0 0 1 0-3.44m.17 4.71q-1.45-.12-2.69-.34a6.5 6.5 0 0 0 3.67 3.44q-.65-1.27-.98-3.1" fill="#666"/></g><defs><clipPath id="a"><path fill="#fff" d="M0 0h16v16H0z"/></clipPath></defs></svg>