feat: add axios, consola, magicast, and nypm dependencies; implement init command for genapi configuration; enhance CLI with improved command handling and error messages

Author: hairyf

docs/.docs/.data/content/contents.sqlite

@@ -4,10 +4,23 @@ genapi is a powerful API generator that converts OpenAPI (v2~v3) and other input
 
 ## Installation
 
-You can install genapi and presets via npm:
+推荐使用 `init` 命令快速生成 genapi 配置文件：
+
+:pm-x{command="genapi init"}
+
+Or 手动安装依赖：
 
 :pm-install{name="@genapi/core @genapi/presets"}
 
+执行 init 后会进入交互式向导：
+
+1. **选择 Preset**：axios、fetch、ky、got、ofetch、uni
+2. **选择输出模式**：TS、JS 或 Schema（仅 fetch、ofetch 支持 Schema）
+3. **覆盖确认**：若已存在配置文件，会询问是否覆盖
+4. **依赖安装**：可选择立即安装所需依赖，或稍后手动安装
+
+完成后会在项目根目录生成 `genapi.config.ts` 或 `genapi.config.js`，随后只需修改 `input` 为你的 API 文档地址即可使用。
+
 ## Basic Usage
 
 Create a configuration file `genapi.config.ts` in your project root:

docs/1.guide/1.index.md

@@ -4,11 +4,22 @@ genapi is a powerful API generator that converts OpenAPI (v2~v3) and other input
 
 ## Installation
 
-You can install genapi via npm:
+Use the `init` command to quickly scaffold a genapi configuration file:
 
-```bash
-npm i @genapi/core @genapi/presets
-```
+:pm-x{command="genapi init"}
+
+Or install manually:
+
+:pm-install{name="@genapi/core @genapi/presets"}
+
+The init command runs an interactive wizard:
+
+1. **Select Preset**: axios, fetch, ky, got, ofetch, uni
+2. **Select Mode**: TS, JS, or Schema (Schema mode available only for fetch and ofetch)
+3. **Overwrite Confirmation**: If a config file already exists, you'll be prompted to overwrite
+4. **Install Dependencies**: Choose to install required dependencies now, or manually later
+
+After completion, `genapi.config.ts` or `genapi.config.js` will be created in your project root. Update the `input` field with your API documentation URL to get started.
 
 ## Basic Usage
 

docs/en/1.guide/1.index.md

@@ -38,12 +38,17 @@
     "prepublishOnly": "nr build"
   },
   "dependencies": {
+    "@clack/prompts": "catalog:runtime",
     "@genapi/shared": "workspace:*",
     "@hairy/utils": "catalog:runtime",
     "cac": "catalog:runtime",
     "chalk": "catalog:runtime",
+    "consola": "catalog:runtime",
     "fs-extra": "catalog:runtime",
     "jiti": "catalog:runtime",
+    "knitwork-x": "catalog:runtime",
+    "magicast": "catalog:runtime",
+    "nypm": "catalog:runtime",
     "ora": "catalog:runtime",
     "unconfig": "catalog:runtime"
   },

packages/core/package.json

@@ -1,8 +1,10 @@
 import type { ApiPipeline } from '@genapi/shared'
+import process from 'node:process'
 import { merge } from '@hairy/utils'
 import cac from 'cac'
 import { loadConfig } from 'unconfig'
 import { operatePipelineGenerator } from '../generator'
+import { initCommand } from './init'
 import * as parser from './parser'
 
 const cli = cac('genapi')
@@ -12,13 +14,34 @@ cli
   .option('--input <source>', 'The incoming string resolves to a uri or json path.')
   .option('--outfile <path>', 'genapi output file options')
 
+cli
+  .command('init', '初始化 genapi 配置文件')
+  .action(async () => {
+    await initCommand()
+    // initCommand 会自己退出进程
+  })
+
 parser.readpack(cli)
 
-main()
+// 在解析之前检查是否是 init 命令
+const rawArgs = process.argv.slice(2)
+const isInitCommand = rawArgs[0] === 'init'
+
+if (isInitCommand) {
+  // 如果是 init 命令，只调用 parse 来触发 action，不执行 main
+  // initCommand 会在 action 中执行并退出进程
+  cli.parse()
+}
+else {
+  // 只有在不是 init 命令时才执行 main 逻辑
+  const parsed = cli.parse()
+  main(parsed)
+}
 
-async function main() {
-  const options = cli.parse().options
-  if (options.help)
+async function main(parsed: ReturnType<typeof cli.parse>) {
+  const { options } = parsed
+
+  if (options.help || options.version)
     return
 
   const { config } = await loadConfig<ApiPipeline.DefineConfig>({
@@ -28,6 +51,13 @@ async function main() {
     },
   })
 
+  // 如果配置文件不存在或为空，提示用户
+  if (!config) {
+    console.error('错误: 未找到 genapi 配置文件')
+    console.log('\n提示: 运行 "genapi init" 来创建配置文件\n')
+    process.exit(1)
+  }
+
   const servers = parser.servers(config)
   await operatePipelineGenerator(servers)
 }

packages/core/src/cli/index.ts

@@ -0,0 +1,79 @@
+import { existsSync, writeFileSync } from 'node:fs'
+import { join } from 'node:path'
+import process from 'node:process'
+import { cancel, confirm, intro, isCancel, outro, select } from '@clack/prompts'
+import consola from 'consola'
+import { addDependency, addDevDependency, detectPackageManager } from 'nypm'
+
+const logger = consola.withTag('genapi:init')
+
+const CONFIG = {
+  presets: {
+    axios: { deps: ['axios'], schema: false },
+    fetch: { deps: [], schema: true },
+    ky: { deps: ['ky'], schema: false },
+    got: { deps: ['got'], schema: false },
+    ofetch: { deps: ['ofetch'], schema: true },
+    uni: { deps: ['@uni-helper/uni-network'], schema: false },
+  } as Record<string, { deps: string[], schema: boolean }>,
+}
+
+async function mandate<T>(promise: Promise<any>): Promise<T> {
+  const res = await promise
+  if (isCancel(res)) {
+    cancel('Operation cancelled')
+    process.exit(0)
+  }
+  return res as T
+}
+
+export async function initCommand() {
+  intro('🚀 genapi init')
+
+  const preset = await mandate<keyof typeof CONFIG.presets>(select({
+    message: 'Select preset:',
+    options: Object.keys(CONFIG.presets).map(v => ({ value: v, label: v })),
+  }))
+
+  const mode = await mandate<('ts' | 'js' | 'schema')>(select({
+    message: 'Select mode:',
+    options: [
+      { value: 'ts', label: 'TS' },
+      { value: 'js', label: 'JS' },
+      ...(CONFIG.presets[preset].schema ? [{ value: 'schema', label: 'Schema' }] : []),
+    ],
+  }))
+
+  const isTS = mode !== 'js'
+  const fileName = `genapi.config.${isTS ? 'ts' : 'js'}`
+  const presetValue = `${preset}.${mode}`
+  const content = isTS
+    ? `import { defineConfig } from '@genapi/core'
+import { ${preset} } from '@genapi/presets'
+
+export default defineConfig({ preset: ${presetValue}, input: '...', output: { main: 'src/api/index.ts' } })`
+    : `const { defineConfig } = require('@genapi/core')
+const { ${preset} } = require('@genapi/presets')
+
+module.exports = defineConfig({ preset: ${presetValue}, input: '...', output: { main: 'src/api/index.ts' } })`
+
+  if (existsSync(join(process.cwd(), fileName)) && !await mandate(confirm({ message: 'Overwrite?' })))
+    return
+
+  writeFileSync(join(process.cwd(), fileName), content)
+
+  // 3. 依赖闭环
+  const deps = CONFIG.presets[preset].deps
+  const devDeps = ['@genapi/core', '@genapi/presets', ...(mode === 'schema' ? ['fetchdts'] : [])]
+
+  if (await mandate(confirm({ message: 'Install now?' }))) {
+    addDependency(deps, { cwd: process.cwd() })
+    addDevDependency(devDeps, { cwd: process.cwd() })
+  }
+  else {
+    const pm = (await detectPackageManager(process.cwd()))?.name || 'npm'
+    logger.info(`Manual: ${pm} add -D ${deps.join(' ')}`)
+  }
+
+  outro('✨ Success')
+}

packages/core/src/cli/init.ts

@@ -36,7 +36,10 @@ export function options(options: any): Partial<ApiPipeline.Config> {
   return config
 }
 
-export function servers(config: ApiPipeline.DefineConfig): ApiPipeline.Config[] {
+export function servers(config: ApiPipeline.DefineConfig | undefined): ApiPipeline.Config[] {
+  if (!config)
+    return []
+
   if (isUndefined((config as ApiPipeline.ConfigServers).servers))
     (config as ApiPipeline.ConfigServers).servers = []
 

packages/core/src/cli/parser.ts

@@ -1,18 +1,11 @@
 import { defineConfig } from '@genapi/core'
-// create an API pipeline generator using the pipeline provided by genapi
-// each pipeline exposes corresponding methods, which can be reused and reorganized
-// import pipeline from '@genapi/pipeline'
 import { ofetch } from '@genapi/presets'
 
-const config = defineConfig({
+export default defineConfig({
   preset: ofetch.schema,
-
-  input: 'https://petstore.swagger.io/v2/swagger.json',
+  input: 'http://example.com/api-docs',
   output: {
-    main: 'dist/index.ts',
-    type: 'dist/index.type.ts',
+    main: 'src/api/index.ts',
+    type: 'src/api/index.type.ts',
   },
-
 })
-
-export default config

playground/genapi.config.ts

@@ -3,18 +3,19 @@
   "type": "module",
   "private": true,
   "scripts": {
-    "build": "genapi"
+    "build": "genapi",
+    "init": "genapi init"
   },
   "dependencies": {
-    "@genapi/core": "workspace:*",
     "@genapi/pipeline": "workspace:*",
-    "@genapi/presets": "workspace:*",
     "@genapi/transform": "workspace:*",
     "wpapi-to-swagger": "catalog:playground"
   },
   "devDependencies": {
+    "@genapi/core": "workspace:*",
+    "@genapi/presets": "workspace:*",
     "@uni-helper/uni-network": "catalog:playground",
-    "fetchdts": "catalog:inlined",
-    "ofetch": "catalog:inlined"
+    "axios": "catalog:",
+    "fetchdts": "catalog:inlined"
   }
 }