express-hale/dist/templates/config-templates.js

🚀 Interactive Express.js scaffold CLI with comprehensive error handling, TypeScript/JavaScript, database integrations, Git Flow, and development tools

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ConfigTemplates = void 0;
const base_renderer_1 = require("./base-renderer");
class ConfigTemplates extends base_renderer_1.BaseRenderer {
    renderNodemonConfig() {
        return JSON.stringify({
            watch: ['src'],
            ext: 'ts,js,json',
            ignore: ['src/**/*.spec.ts', 'src/**/*.test.ts'],
            exec: 'ts-node src/index.ts',
            env: {
                NODE_ENV: 'development',
            },
            delay: 1000,
        }, null, 2);
    }
    renderEnvFile(config) {
        let content = `# Server Configuration
PORT=3000
NODE_ENV=development

`;
        if (config.databases.includes('mysql')) {
            content += `# MySQL Configuration
MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_USER=root
MYSQL_PASSWORD=your_password
MYSQL_DATABASE=your_database

`;
        }
        if (config.databases.includes('mongodb')) {
            content += `# MongoDB Configuration
MONGODB_URI=mongodb://localhost:27017/your_database

`;
        }
        if (config.databases.includes('redis')) {
            content += `# Redis Configuration
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=your_redis_password

`;
        }
        content += `# JWT Secret (generate a strong secret in production)
JWT_SECRET=your_jwt_secret_key

# API Configuration
API_VERSION=v1
API_BASE_URL=http://localhost:3000`;
        return content;
    }
    renderEnvExampleFile(config) {
        return this.renderEnvFile(config).replace(/=.+$/gm, '=');
    }
    renderTsConfig() {
        return JSON.stringify({
            compilerOptions: {
                target: 'ES2020',
                module: 'commonjs',
                lib: ['ES2020'],
                outDir: './dist',
                rootDir: './src',
                strict: true,
                esModuleInterop: true,
                skipLibCheck: true,
                forceConsistentCasingInFileNames: true,
                declaration: true,
                sourceMap: true,
                resolveJsonModule: true,
                moduleResolution: 'node',
            },
            include: ['src/**/*'],
            exclude: ['node_modules', 'dist', '**/*.test.ts'],
        }, null, 2);
    }
    renderEslintConfig(config) {
        if (config.language === 'typescript') {
            return `const js = require('@eslint/js');
const tseslint = require('@typescript-eslint/eslint-plugin');
const tsparser = require('@typescript-eslint/parser');${config.prettier ? "\nconst prettier = require('eslint-plugin-prettier');\nconst prettierConfig = require('eslint-config-prettier');" : ''}

module.exports = [
  js.configs.recommended,
  {
    files: ['**/*.ts', '**/*.tsx'],
    languageOptions: {
      parser: tsparser,
      parserOptions: {
        ecmaVersion: 2020,
        sourceType: 'module',
      },
      globals: {
        console: 'readonly',
        process: 'readonly',
        Buffer: 'readonly',
        __dirname: 'readonly',
        __filename: 'readonly',
        exports: 'writable',
        module: 'writable',
        require: 'readonly',
        global: 'readonly',
        setTimeout: 'readonly',
        clearTimeout: 'readonly',
        setInterval: 'readonly',
        clearInterval: 'readonly',
      },
    },
    plugins: {
      '@typescript-eslint': tseslint${config.prettier ? ",\n      'prettier': prettier" : ''}
    },
    rules: {
      ...tseslint.configs.recommended.rules,
      '@typescript-eslint/no-unused-vars': 'error',
      '@typescript-eslint/explicit-function-return-type': 'off',
      '@typescript-eslint/no-explicit-any': 'warn'${config.prettier ? ",\n      'prettier/prettier': 'error'" : ''}
    },
  }${config.prettier ? ',\n  prettierConfig' : ''}
];`;
        }
        else {
            return `const js = require('@eslint/js');${config.prettier ? "\nconst prettier = require('eslint-plugin-prettier');\nconst prettierConfig = require('eslint-config-prettier');" : ''}

module.exports = [
  js.configs.recommended,
  {
    files: ['**/*.js', '**/*.mjs'],
    languageOptions: {
      ecmaVersion: 2020,
      sourceType: 'module',
      globals: {
        console: 'readonly',
        process: 'readonly',
        Buffer: 'readonly',
        __dirname: 'readonly',
        __filename: 'readonly',
        exports: 'writable',
        module: 'writable',
        require: 'readonly',
        global: 'readonly',
        setTimeout: 'readonly',
        clearTimeout: 'readonly',
        setInterval: 'readonly',
        clearInterval: 'readonly',
      },
    }${config.prettier ? ",\n    plugins: {\n      'prettier': prettier\n    }" : ''},
    rules: {
      'no-unused-vars': 'error',
      'no-console': 'off'${config.prettier ? ",\n      'prettier/prettier': 'error'" : ''}
    },
  }${config.prettier ? ',\n  prettierConfig' : ''}
];`;
        }
    }
    renderPrettierConfig() {
        return JSON.stringify({
            semi: true,
            trailingComma: 'es5',
            singleQuote: true,
            printWidth: 80,
            tabWidth: 2,
            useTabs: false,
        }, null, 2);
    }
    renderJestConfig(config) {
        if (config.language === 'typescript') {
            return `module.exports = {
  preset: 'ts-jest',
  testEnvironment: 'node',
  roots: ['<rootDir>/src', '<rootDir>/tests'],
  testMatch: ['**/__tests__/**/*.ts', '**/?(*.)+(spec|test).ts'],
  transform: {
    '^.+\\.ts$': 'ts-jest'
  },
  collectCoverageFrom: [
    'src/**/*.ts',
    '!src/**/*.d.ts'
  ],
  coverageDirectory: 'coverage',
  coverageReporters: ['text', 'lcov', 'html']
};`;
        }
        else {
            return `module.exports = {
  testEnvironment: 'node',
  roots: ['<rootDir>/src', '<rootDir>/tests'],
  testMatch: ['**/__tests__/**/*.js', '**/?(*.)+(spec|test).js'],
  collectCoverageFrom: [
    'src/**/*.js'
  ],
  coverageDirectory: 'coverage',
  coverageReporters: ['text', 'lcov', 'html']
};`;
        }
    }
    renderReadme(projectName, config) {
        const features = [];
        // Add language feature
        features.push(`- 🚀 **${config.language === 'typescript' ? 'TypeScript' : 'JavaScript'}** 支持`);
        // Add database features
        if (config.databases.includes('mysql'))
            features.push('- 🗄️ **MySQL** 数据库集成');
        if (config.databases.includes('mongodb'))
            features.push('- 🍃 **MongoDB** 数据库集成');
        if (config.databases.includes('redis'))
            features.push('- 🔴 **Redis** 缓存集成');
        // Add development tools
        if (config.eslint)
            features.push('- 🔍 **ESLint** 代码检查');
        if (config.prettier)
            features.push('- 💅 **Prettier** 代码格式化');
        if (config.testing === 'jest')
            features.push('- 🧪 **Jest** 单元测试');
        if (config.docker)
            features.push('- 🐳 **Docker** 容器化支持');
        if (config.gitFlow)
            features.push('- 🌊 **Git Flow** 工作流');
        // Add built-in features
        features.push('- 🛡️ **安全中间件** (Helmet, CORS)');
        features.push('- 📝 **请求日志** 彩色可视化显示');
        features.push('- ⚡ **异步错误处理** 完整的错误处理机制');
        features.push('- 🔄 **优雅关闭** 进程信号处理');
        features.push('- 📊 **健康检查** 内置健康检查端点');
        features.push('- 🎯 **错误监控** 生产环境错误追踪');
        return `# ${projectName}

> 🚀 基于 Express.js 的现代化 Web 应用程序，使用 express-hale CLI 生成

## ✨ 特性

${features.join('\n')}

## 🛠️ 技术栈

- **框架**: Express.js
- **语言**: ${config.language === 'typescript' ? 'TypeScript' : 'JavaScript'}
${config.databases.length > 0 ? `- **数据库**: ${config.databases.map(db => db.charAt(0).toUpperCase() + db.slice(1)).join(', ')}` : ''}
- **开发工具**: ${[
            config.eslint && 'ESLint',
            config.prettier && 'Prettier',
            config.testing === 'jest' && 'Jest',
            'Nodemon'
        ].filter(Boolean).join(', ')}
${config.docker ? '- **容器化**: Docker & Docker Compose' : ''}

## 🚀 快速开始

### 安装依赖

\`\`\`bash
npm install
\`\`\`

### 环境配置

复制环境变量模板文件：

\`\`\`bash
cp .env.example .env
\`\`\`

编辑 \`.env\` 文件，配置你的环境变量。

### 开发模式

\`\`\`bash
npm run dev
\`\`\`

应用将在 [http://localhost:3000](http://localhost:3000) 启动

### 生产模式

${config.language === 'typescript' ? `\`\`\`bash
# 构建项目
npm run build

# 启动生产服务
npm start
\`\`\`` : `\`\`\`bash
npm start
\`\`\``}

## 📁 项目结构

\`\`\`
${projectName}/
├── src/
│   ├── config/          # 数据库配置
│   ├── middleware/      # 中间件
│   ├── routes/          # 路由定义
│   ├── utils/           # 工具函数
│   └── index.${config.language === 'typescript' ? 'ts' : 'js'}         # 应用入口
├── tests/               # 测试文件
${config.docker ? '├── docker-compose.yml   # Docker 编排文件\n├── Dockerfile          # Docker 镜像配置' : ''}
├── .env.example        # 环境变量模板
├── package.json        # 项目配置
${config.language === 'typescript' ? '├── tsconfig.json       # TypeScript 配置' : ''}
${config.eslint ? '├── eslint.config.js     # ESLint 配置' : ''}
${config.prettier ? '├── .prettierrc        # Prettier 配置' : ''}
${config.testing === 'jest' ? '├── jest.config.js      # Jest 配置' : ''}
${config.gitFlow ? '└── GIT_FLOW.md        # Git Flow 工作流说明' : ''}
\`\`\`

## 🔧 可用脚本

- \`npm run dev\` - 启动开发服务器
${config.language === 'typescript' ? '- `npm run build` - 构建生产版本' : ''}
- \`npm start\` - 启动生产服务器
${config.testing === 'jest' ? '- `npm test` - 运行测试' : ''}
${config.eslint ? '- `npm run lint` - 代码检查' : ''}
${config.prettier ? '- `npm run format` - 代码格式化' : ''}

## 🌐 API 端点

### 健康检查
- **GET** \`/health\` - 应用健康状态检查

### 示例 API
- **GET** \`/api/users\` - 获取用户列表
- **POST** \`/api/users\` - 创建新用户
- **GET** \`/api/error-test\` - 错误处理测试

## 📊 请求日志

应用内置了彩色可视化的请求日志系统：

\`\`\`
┌─────────────────────────────────────────────────────────────────────────────────
│ 🌐 HTTP REQUEST LOG
├─────────────────────────────────────────────────────────────────────────────────
│ ⏰ Time:     2025/08/10 20:48:08
│ 🔗 Method:   GET
│ 📍 Path:     /health
│ 📊 Status:   200
│ ⚡ Duration:  1ms
│ 📦 Size:     156 bytes
│ 🌍 Client:   ::1
│ 🔧 Agent:    PostmanRuntime/7.45.0
└─────────────────────────────────────────────────────────────────────────────────
\`\`\`

## 🛡️ 安全特性

- **Helmet**: 设置各种 HTTP 头来保护应用
- **CORS**: 跨域资源共享配置
- **请求大小限制**: 防止大型请求攻击
- **错误处理**: 生产环境下隐藏敏感错误信息

## 🔄 错误处理

应用包含完整的错误处理机制：

- **异步错误包装器**: 自动捕获异步路由中的错误
- **全局错误处理器**: 统一的错误响应格式
- **404 处理器**: 优雅处理未找到的路由
- **错误监控**: 生产环境错误追踪和报告

${config.databases.length > 0 ? `## 🗄️ 数据库配置

${config.databases.includes('mysql') ? `### MySQL
\`\`\`bash
MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_USER=root
MYSQL_PASSWORD=your_password
MYSQL_DATABASE=your_database
\`\`\`

` : ''}${config.databases.includes('mongodb') ? `### MongoDB
\`\`\`bash
MONGODB_URI=mongodb://localhost:27017/your_database
\`\`\`

` : ''}${config.databases.includes('redis') ? `### Redis
\`\`\`bash
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=your_redis_password
\`\`\`

` : ''}` : ''}${config.docker ? `## 🐳 Docker 支持

### 使用 Docker Compose

\`\`\`bash
# 启动所有服务
docker-compose up -d

# 查看日志
docker-compose logs -f

# 停止服务
docker-compose down
\`\`\`

### 单独使用 Docker

\`\`\`bash
# 构建镜像
docker build -t ${projectName.toLowerCase()} .

# 运行容器
docker run -p 3000:3000 ${projectName.toLowerCase()}
\`\`\`

` : ''}${config.gitFlow ? `## 🌊 Git Flow 工作流

本项目使用 Git Flow 工作流进行版本管理。详细说明请查看 [GIT_FLOW.md](./GIT_FLOW.md)。

### 快速命令

\`\`\`bash
# 开始新功能
npm run git:feature <feature-name>

# 完成功能开发
npm run git:feature:finish <feature-name>

# 开始发布
npm run git:release <version>

# 完成发布
npm run git:release:finish <version>
\`\`\`

` : ''}## 🤝 贡献

1. Fork 本仓库
2. 创建你的特性分支 (\`git checkout -b feature/AmazingFeature\`)
3. 提交你的修改 (\`git commit -m 'Add some AmazingFeature'\`)
4. 推送到分支 (\`git push origin feature/AmazingFeature\`)
5. 打开一个 Pull Request

## 📄 许可证

本项目基于 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情

## 🙏 致谢

- [Express.js](https://expressjs.com/) - 快速、开放、极简的 Web 框架
- [express-hale](https://www.npmjs.com/package/express-hale) - 现代化的 Express.js 项目生成器

---

⭐ 如果这个项目对你有帮助，请给它一个星标！`;
    }
    renderGitignore() {
        return `# Dependencies
node_modules/
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Coverage directory used by tools like istanbul
coverage/
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage
.grunt

# Bower dependency directory
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript output
dist/
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test
.env.local
.env.production

# parcel-bundler cache
.cache
.parcel-cache

# Next.js build output
.next

# Nuxt.js build / generate output
.nuxt

# Gatsby files
.cache/
public

# Storybook build outputs
.out
.storybook-out

# Temporary folders
tmp/
temp/

# Logs
logs
*.log

# Editor directories and files
.vscode/
.idea/
*.swp
*.swo
*~

# OS generated files
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db`;
    }
}
exports.ConfigTemplates = ConfigTemplates;
//# sourceMappingURL=config-templates.js.map