clean: rm tmp file and get original file back

Author: wwayne

package.json

@@ -9,7 +9,7 @@
   "scripts": {
     "lint": "eslint .",
     "lint-fix": "eslint . --fix",
-    "test": "env TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' mocha -r ts-node/register '**/*.test.*'",
+    "test": "env TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' mocha -r ts-node/register 'test/*.test.*'",
     "prebuild": "rimraf lib",
     "build": "tsc --build",
     "prepublishOnly": "npm run build"

src/APICollector.ts

@@ -267,7 +267,7 @@ export default class APICollector implements APICollectorInterface {
     if (!url) throw new Error('No url found');
     const method = this.extractMethod(serverResponse);
     const operationObj: OpenAPIV3_1.OperationObject = {};
-    const methodsHasReqBody = ['post', 'put']
+    const methodsHasReqBody = ['post', 'put'];
 
     if (statusCode < 400) {
       const headers = this.extractHeaders(serverResponse);

src/APIGenerator.ts

@@ -41,19 +41,19 @@ export default class APIGenerator {
     const output = opts.output || 'api.yaml';
     const fileFormat = path.extname(output);
     if (!SUPPORTED_FORMAT.includes(fileFormat)) {
-      throw new Error(`${fileFormat} file not supported`)
+      throw new Error(`${fileFormat} file not supported`);
     }
 
     await mkdir(path.dirname(output), { recursive: true });
     switch (fileFormat) {
       case ".json": {
         await writeFile(output, JSON.stringify(apiDoc, null, 2));
-        break
+        break;
       }
       case ".yaml": {
-        const yamlData = YAML.stringify(apiDoc)
+        const yamlData = YAML.stringify(apiDoc);
         await writeFile(output, yamlData);
-        break
+        break;
       }
     }
   }

src/index.ts

@@ -1,11 +1,11 @@
 import { spawn } from 'child_process';
 import fsPromises from 'fs/promises';
-import { existsSync } from 'fs'
+import { existsSync } from 'fs';
 
 import {
   PREFIX_RESPONSE_BODY_DATA,
   PREFIX_SERVER_RESPONSE
-} from './constants'
+} from './constants';
 import RequestHook from './RequestHook';
 import APICollector from './APICollector';
 import APIGenerator from './APIGenerator';
@@ -27,69 +27,65 @@ export async function runner (
   }
 
   const projectCWD = process.cwd();
-  const packageJSONStr = await fsPromises.readFile(projectCWD + '/package.json', 'utf8')
-  const packageJSON = JSON.parse(packageJSONStr)
-  const mainFilePath = packageJSON?.outdoc?.main || packageJSON?.main
-  if (!mainFilePath) throw new Error('Please define main or outdoc.main in package.json')
+  const packageJSONStr = await fsPromises.readFile(projectCWD + '/package.json', 'utf8');
+  const packageJSON = JSON.parse(packageJSONStr);
+  const mainFilePath = packageJSON?.outdoc?.main || packageJSON?.main;
+  if (!mainFilePath) throw new Error('Please define main or outdoc.main in package.json');
 
-  const mainFileAbsolutePath = `${projectCWD}/${mainFilePath}`
+  const mainFileAbsolutePath = projectCWD + "/" + mainFilePath;
+  const tmpFileAbsoluteath = projectCWD + "/outdoc_tmp_file";
   const apiCollector = new APICollector();
   const requestHook = new RequestHook(apiCollector);
 
-  const injectedCodes = RequestHook.getInjectedCodes()
-  await fsPromises.copyFile(mainFileAbsolutePath, projectCWD + "/outdoc_tmp_file")
-  await fsPromises.writeFile(mainFileAbsolutePath, injectedCodes, { flag: "a" })
-  await fsPromises.appendFile(mainFileAbsolutePath, "// @ts-nocheck")
+  const injectedCodes = RequestHook.getInjectedCodes();
+  await fsPromises.copyFile(mainFileAbsolutePath, projectCWD + "/outdoc_tmp_file");
+  await fsPromises.writeFile(mainFileAbsolutePath, injectedCodes, { flag: "a" });
+  await fsPromises.appendFile(mainFileAbsolutePath, "// @ts-nocheck");
 
   const childProcess = spawn(args[0], args.slice(1), {
     detached: true,
     stdio: ["inherit", "pipe", "inherit"]
   });
 
   childProcess.stdout.on('data', (data) => {
-    const dataStr = data.toString()
+    const dataStr = data.toString();
 
     if (dataStr.startsWith(PREFIX_RESPONSE_BODY_DATA)) {
       try {
-        const res = JSON.parse(dataStr.substr(PREFIX_RESPONSE_BODY_DATA.length))
+        const res = JSON.parse(dataStr.substr(PREFIX_RESPONSE_BODY_DATA.length));
         if (res.data?.encoding === 'buffer') {
-          res.data.chunk = new Buffer(res.data.chunk)
+          res.data.chunk = new Buffer(res.data.chunk);
         }
-        requestHook.handleResponseBodyData(res)
+        requestHook.handleResponseBodyData(res);
       } catch (err) {
         if (err instanceof Error) {
-          process.stderr.write(err.message)
+          process.stderr.write(err.message);
         }
       }
-      return
+      return;
     }
 
     if (dataStr.startsWith(PREFIX_SERVER_RESPONSE)) {
       try {
-        const res = JSON.parse(dataStr.substr(PREFIX_SERVER_RESPONSE.length))
+        const res = JSON.parse(dataStr.substr(PREFIX_SERVER_RESPONSE.length));
         if (res.data?.req?._readableState) {
-          const headData = res.data.req._readableState.buffer.head.data
-          res.data.req._readableState.buffer.head.data = new Buffer(headData)
+          const headData = res.data.req._readableState.buffer.head.data;
+          res.data.req._readableState.buffer.head.data = new Buffer(headData);
         }
-        requestHook.handleServerResponse(res)
+        requestHook.handleServerResponse(res);
       } catch (err) {
         if (err instanceof Error) {
-          process.stderr.write(err.message)
+          process.stderr.write(err.message);
         }
       }
-      return
+      return;
     }
 
-    process.stdout.write(data.toString())
-  })
+    process.stdout.write(data.toString());
+  });
 
   childProcess.on('close', async (code) => {
-    const tmpFilePath = projectCWD + "/outdoc_tmp_file"
-    if (existsSync(tmpFilePath)) {
-      await fsPromises.copyFile(projectCWD + "/outdoc_tmp_file", mainFileAbsolutePath)
-      await fsPromises.rm(projectCWD + "/outdoc_tmp_file")
-    }
-
+    await rmTmpFileAndGetOriginalBack(tmpFileAbsoluteath, mainFileAbsolutePath);
     if (code === 0) {
       try {
         await APIGenerator.generate(
@@ -111,10 +107,16 @@ export async function runner (
   });
 
   process.on('SIGINT', async () => {
-    const tmpFilePath = projectCWD + "/outdoc_tmp_file"
-    if (existsSync(tmpFilePath)) {
-      await fsPromises.copyFile(tmpFilePath, mainFileAbsolutePath)
-      await fsPromises.rm(tmpFilePath)
-    }
-});
+    await rmTmpFileAndGetOriginalBack(tmpFileAbsoluteath, mainFileAbsolutePath);
+  });
 }
+
+const rmTmpFileAndGetOriginalBack = async (
+  tmpFilePath: string,
+  mainFilePath: string
+) => {
+  if (existsSync(tmpFilePath)) {
+    await fsPromises.copyFile(tmpFilePath, mainFilePath);
+    await fsPromises.rm(tmpFilePath);
+  }
+};