feat: 丰富命令行操作

Author: cloudcome

README.md

@@ -33,11 +33,10 @@ npm i -D openapi-axios
 const { defineConfig } = require('openapi-axios');
 
 module.exports = defineConfig({
-  modules: {
-      // 将会生成 src/apis/petStore3.ts 文件
-      'petStore3': 'https://petstore31.swagger.io/api/v31/openapi.json'
+    modules: {
+        // 将会生成 src/apis/petStore3.ts 文件
+        'petStore3': 'https://petstore31.swagger.io/api/v31/openapi.json'
     },
-  ],
 });
 ```
 

bin/index.cjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
 
-const { run } = require('../dist/index.cjs');
+const { createCLI } = require('../dist/index.cjs');
 
-run();
+createCLI();

package-lock.json

@@ -64,6 +64,7 @@
     "license": "MIT",
     "dependencies": {
         "chalk": "^4.1.2",
+        "commander": "^12.1.0",
         "prettier": "^3.3.2",
         "strict-event-emitter": "^0.5.1",
         "try-flatten": "^1.3.2"

package.json

@@ -0,0 +1,55 @@
+import { Command } from 'commander';
+import fs from 'fs';
+import path from 'path';
+import { description } from '../package.json';
+import { pkgName, pkgVersion } from './const';
+import { resolveConfigFile, run } from './generators/command';
+
+export function createCLI() {
+    const program = new Command();
+
+    program
+        .name(pkgName)
+        .version(pkgVersion)
+        .description(description)
+        .action((options, command) => {
+            if (command.args.length === 0) return run();
+
+            program.help();
+        });
+
+    program
+        .command('init')
+        .description('初始化配置文件')
+        .action(async () => {
+            const configFile = resolveConfigFile(process.cwd());
+
+            if (configFile) {
+                console.log(`配置文件已存在`, path.relative(process.cwd(), configFile));
+                return;
+            }
+
+            const configFilename = 'openapi.config.cjs';
+            const configFilePath = path.join(process.cwd(), configFilename);
+
+            fs.writeFileSync(
+                configFilePath,
+                `
+/**
+ * openapi-axios config
+ * @link https://github.com/FrontEndDev-org/openapi-axios
+ */
+
+const { defineConfig } = require('openapi-axios');
+
+module.exports = defineConfig({
+    modules: {
+        'petStore3': 'https://petstore31.swagger.io/api/v31/openapi.json'
+    },
+});`.trim() + '\n',
+            );
+            console.log('生成配置文件', configFilename);
+        });
+
+    program.parse();
+}

src/cli.ts

@@ -30,7 +30,7 @@ export function resolveConfig(cwd: string): GeneratorOptions {
     const configFile = resolveConfigFile(cwd);
 
     if (!configFile) {
-        throw new Error(`配置文件未找到，配置文件可以是 ${configFileNameOrder.join('、')} 之一`);
+        throw new Error(`配置文件未找到，配置文件可以是 ${configFileNameOrder.join('、')} 之一\n可以使用 npx openapi-axios init 自动生成`);
     }
 
     const [err, config] = tryFlatten(() => {

src/generators/command.ts

@@ -1,7 +1,6 @@
+export { defineConfig } from './generators/command';
+export { createCLI } from './cli';
 export * from './const';
-export { Printer } from './printer';
-export { Generator } from './generators/Generator';
-export * from './generators/command';
 
 // types
 export type * from './types/openapi';

src/index.ts

@@ -1,4 +1,4 @@
-import { Printer } from '../../src';
+import { Printer } from '../../src/printer';
 
 test('ref-parameter', () => {
     const printer = new Printer({

test/printer/ref-parameter.test.ts

@@ -1,4 +1,4 @@
-import { Printer } from '../../src';
+import { Printer } from '../../src/printer';
 
 test('ref-request', () => {
     const printer = new Printer({

test/printer/ref-request.test.ts

@@ -1,4 +1,4 @@
-import { Printer } from '../../src';
+import { Printer } from '../../src/printer';
 
 test('ref-response', () => {
     const printer = new Printer({