@gogenger/go-gen 1.0.0

package/docs/USE_CASES.md

@@ -0,0 +1,247 @@
+# 🎨 使用场景
+
+## 场景 1：快速对接第三方 API
+
+**需求：** 需要调用一个第三方支付接口
+
+```bash
+go-gen fetch
+```
+
+**交互过程：**
+
+```
+🌐 请输入 API URL: https://api.payment.com/v1/orders
+🔧 请求方法: POST
+🔐 是否需要认证? Bearer Token
+🔑 请输入 Bearer Token: sk_test_xxxxx
+📦 该接口是否需要请求体? Yes
+📝 请输入请求体 JSON:
+{
+  "amount": 100,
+  "currency": "USD",
+  "description": "Order #123"
+}
+📝 Response Type 名称: CreateOrderResponse
+📦 API 方法名: createPaymentOrder
+📂 输出目录: 📁 当前目录
+```
+
+**生成结果：** 30 秒内完成接口对接
+
+---
+
+## 场景 2：从 Swagger 文档批量生成
+
+**需求：** 后端提供了 Swagger 文档，需要生成所有用户相关接口
+
+```bash
+go-gen openapi https://api.example.com/swagger.json
+```
+
+**选择批量模式：**
+
+```
+⚡ 批量生成中... (1/15): GET /users
+⚡ 批量生成中... (2/15): POST /users
+⚡ 批量生成中... (3/15): GET /users/{id}
+...
+✅ 批量生成完成！成功: 15，失败: 0
+```
+
+**优势：** 一次性生成所有接口，节省大量时间
+
+---
+
+## 场景 3：团队协作规范化
+
+**场景描述：** 团队有 5 个前端开发，需要统一 API 调用方式
+
+**步骤 1：项目负责人设置规范**
+
+```bash
+cd your-project
+go-gen init
+```
+
+编辑 `.apirc.json`：
+
+```json
+{
+  "requestModule": "@/api/request",
+  "typePrefix": "I",
+  "apiPrefix": "api"
+}
+```
+
+提交配置：
+
+```bash
+git add .apirc.json
+git commit -m "chore: add api generator config"
+git push
+```
+
+**步骤 2：团队成员使用**
+
+```bash
+git pull
+go-gen fetch  # 自动使用团队配置
+```
+
+**效果：** 所有成员生成的代码风格统一，无需口头约定
+
+---
+
+## 场景 4：多项目维护
+
+**场景描述：** 同时维护 3 个项目，每个项目使用不同的 HTTP 库
+
+**项目 A（使用 axios）**
+
+```bash
+cd project-a
+cat .apirc.json
+# { "requestModule": "axios" }
+go-gen fetch
+```
+
+生成的代码：
+
+```typescript
+import axios from 'axios';
+
+export function getUsers() {
+  return axios.get<UserResponse>('/api/users');
+}
+```
+
+**项目 B（使用自定义 request）**
+
+```bash
+cd project-b
+cat .apirc.json
+# { "requestModule": "@/utils/http" }
+go-gen fetch
+```
+
+生成的代码：
+
+```typescript
+import request from '@/utils/http';
+
+export function getUsers() {
+  return request.get<UserResponse>('/api/users');
+}
+```
+
+**项目 C（使用 fetch）**
+
+```bash
+cd project-c
+cat .apirc.json
+# { "requestModule": "@/api/fetch" }
+go-gen fetch
+```
+
+生成的代码：
+
+```typescript
+import request from '@/api/fetch';
+
+export function getUsers() {
+  return request.get<UserResponse>('/api/users');
+}
+```
+
+**优势：** 自动适配各项目规范，无需手动调整
+
+---
+
+## 场景 5：迭代开发增量更新
+
+**场景描述：** 项目已有 10 个接口，现在要新增 2 个
+
+**第一次生成：**
+
+```bash
+go-gen fetch
+# 输出到: src/api/user/
+```
+
+生成文件：
+
+```
+src/api/user/
+├── api.ts        # 10 个 API 方法
+└── types.ts      # 10 个类型定义
+```
+
+**新增接口：**
+
+```bash
+go-gen fetch
+# 输出到: src/api/user/ (相同目录)
+```
+
+**结果：** 新接口自动追加，原有代码不受影响
+
+```typescript
+// api.ts
+export function getUsers() { ... }          // 原有
+export function createUser(data) { ... }    // 原有
+export function updateUser(id, data) { ... } // 新增
+export function deleteUser(id) { ... }       // 新增
+```
+
+---
+
+## 场景 6：处理复杂认证
+
+**场景描述：** 接口需要多个 Header
+
+```bash
+go-gen fetch
+```
+
+```
+🔐 是否需要认证? Bearer Token
+🔑 请输入 Bearer Token: your_token_here
+```
+
+如果需要额外的 Header，可以在生成后手动添加：
+
+```typescript
+export function getUsers() {
+  return request.get<UserResponse>('/api/users', {
+    headers: {
+      'X-Custom-Header': 'value',
+    },
+  });
+}
+```
+
+---
+
+## 场景 7：调试和测试
+
+**场景描述：** 开发环境测试接口
+
+```bash
+go-gen fetch
+```
+
+```
+🌐 请输入 API URL: http://localhost:3000/api/test
+```
+
+生成代码后立即测试：
+
+```typescript
+import { getTest } from './api';
+
+// 立即调用测试
+getTest().then(data => {
+  console.log('API 响应:', data);
+});
+```

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@gogenger/go-gen",
+  "version": "1.0.0",
+  "description": "一款 TypeScript API 代码生成器，支持从 API 响应或 OpenAPI 文档一键生成 TypeScript 接口代码和类型定义",
+  "bin": {
+    "go-gen": "./bin/index.js"
+  },
+  "scripts": {
+    "test": "jest --coverage",
+    "test:watch": "jest --watch",
+    "lint": "eslint core/**/*.js",
+    "prepare": "husky install",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
+  },
+  "keywords": [
+    "quicktype",
+    "api",
+    "typescript",
+    "code-generator",
+    "openapi",
+    "cli"
+  ],
+  "license": "MIT",
+  "author": "goGenger",
+  "email": "bg2582266166@gmail.com",
+  "lint-staged": {
+    "**/*.{js}": [
+      "prettier --write",
+      "eslint --fix"
+    ]
+  },
+  "files": [
+    "core",
+    "utils",
+    "bin",
+    "docs",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "devDependencies": {
+    "eslint": "^8.47.0",
+    "jest": "^29.6.0",
+    "nock": "^13.3.3",
+    "prettier": "^3.7.4",
+    "lint-staged": "^16.2.7",
+    "husky": "^9.1.7",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4"
+  },
+  "dependencies": {
+    "@darkobits/lolcatjs": "3.1.3",
+    "chalk": "^4.1.2",
+    "commander": "^9.5.0",
+    "figlet": "^1.9.4",
+    "inquirer": "^8.2.6",
+    "node-fetch": "^2.7.0",
+    "openapi-sampler": "^1.6.2",
+    "ora": "^5.4.1",
+    "quicktype-core": "^23.2.6",
+    "shelljs": "^0.10.0",
+    "prompts": "^2.4.2"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}

package/utils/load-openapi.js

@@ -0,0 +1,23 @@
+const fs = require('fs');
+const fetch = require('node-fetch');
+
+async function loadOpenAPI(source) {
+  // 如果是 URL
+  if (source.startsWith('http://') || source.startsWith('https://')) {
+    const response = await fetch(source);
+    if (!response.ok) {
+      throw new Error(`Failed to fetch OpenAPI: ${response.statusText}`);
+    }
+    return await response.json();
+  }
+
+  // 如果是本地文件
+  if (fs.existsSync(source)) {
+    const content = fs.readFileSync(source, 'utf-8');
+    return JSON.parse(content);
+  }
+
+  throw new Error('Invalid OpenAPI source: must be URL or file path');
+}
+
+module.exports = loadOpenAPI;

package/utils/name.js

@@ -0,0 +1,17 @@
+function isValidIdentifier(name) {
+  return /^[A-Za-z][A-Za-z0-9]*$/.test(name);
+}
+
+function pascalCase(name) {
+  // 如果用户已经输入了合法 TS 名称，直接返回
+  if (isValidIdentifier(name)) {
+    return name;
+  }
+
+  // 否则才进行 pascalCase
+  return name
+    .replace(/[-_/](.)/g, (_, c) => c.toUpperCase())
+    .replace(/^(.)/, (_, c) => c.toUpperCase());
+}
+
+module.exports = { pascalCase };

package/utils/sampler.js

@@ -0,0 +1,28 @@
+function schemaToSample(schema) {
+  if (!schema) return {};
+  
+  if (schema.type === 'object' && schema.properties) {
+    const sample = {};
+    for (const [key, prop] of Object.entries(schema.properties)) {
+      sample[key] = schemaToSample(prop);
+    }
+    return sample;
+  }
+  
+  if (schema.type === 'array' && schema.items) {
+    return [schemaToSample(schema.items)];
+  }
+  
+  const typeDefaults = {
+    string: 'example',
+    number: 0,
+    integer: 0,
+    boolean: false,
+    object: {},
+    array: [],
+  };
+  
+  return typeDefaults[schema.type] || null;
+}
+
+module.exports = { schemaToSample };