Merge pull request #219 from dlid/option-to-use-system-temporary-directory

Option to use system temporary directory

Author: luisfpg

lib/ng-openapi-gen.ts

@@ -3,6 +3,7 @@ import fs from 'fs-extra';
 import $RefParser, { HTTPResolverOptions } from '@apidevtools/json-schema-ref-parser';
 import mkdirp from 'mkdirp';
 import path from 'path';
+import os from 'os';
 import { parseOptions } from './cmd-args';
 import { HTTP_METHODS, methodName, simpleName, syncDirs, deleteDirRecursive } from './gen-utils';
 import { Globals } from './globals';
@@ -39,6 +40,7 @@ export class NgOpenApiGen {
     }
     this.tempDir = this.outDir + '$';
 
+    this.initTempDir();
     this.initHandlebars();
     this.readTemplates();
     this.readModels();
@@ -50,6 +52,16 @@ export class NgOpenApiGen {
     }
   }
 
+  /**
+   * Set the temp dir to a system temporary directory if option useTempDir is set
+   */
+  initTempDir(): void {
+    if (this.options.useTempDir === true) {
+      const systemTempDir = path.join(os.tmpdir(), `ng-openapi-gen-${path.basename(this.outDir)}$`);
+      this.tempDir = systemTempDir;
+    }
+  }
+
   /**
    * Actually generates the files
    */

lib/options.ts

@@ -102,4 +102,7 @@ export interface Options {
       toUse: 'arraybuffer' | 'blob' | 'json' | 'document'
     }
   };
+
+  /** When specified, will create temporary files in system temporary folder instead of next to output folder. */
+  useTempDir?: boolean;
 }

ng-openapi-gen-schema.json

@@ -191,6 +191,11 @@
           }
         }
       }
+    },
+    "useTempDir": {
+      "description": "When specified, will create temporary files in system temporary folder instead of output folder",
+      "default": false,
+      "type": "boolean"
     }
   }
 }

test/useTempDir.config.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "../ng-openapi-gen-schema.json",
+  "input": "test/useTempDir.json",
+  "output": "out/useTempDir",
+  "useTempDir": true
+}

test/useTempDir.json

@@ -0,0 +1,25 @@
+{
+  "openapi": "3.0",
+  "info": {
+    "title": "Test with useTempDir",
+    "version": "1.0"
+  },
+  "paths": {
+    "/foo": {
+      "get": {
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string"
+                }
+              },
+              "text/plain": {}
+            }
+          }
+        }
+      }
+    }
+  }
+}

test/useTempDir.spec.ts

@@ -0,0 +1,34 @@
+import { OpenAPIObject } from 'openapi3-ts';
+import { NgOpenApiGen } from '../lib/ng-openapi-gen';
+import options from './useTempDir.config.json';
+import templatesSpec from './useTempDir.json';
+import os from 'os';
+
+describe('Generation tests using system temporary directory', () => {
+
+  it('Use system temp folder when useTempDir is true', () => {
+
+    const gen = new NgOpenApiGen(templatesSpec as OpenAPIObject, options);
+    gen.generate();
+
+    const tempDirectory = os.tmpdir();
+
+    expect(gen.tempDir.startsWith(tempDirectory)).toBeTrue();
+    expect(gen.tempDir.endsWith('useTempDir$')).toBeTrue();
+
+  });
+
+  it('Do not use system temp folder when useTempDir is false', () => {
+
+    const optionsWithoutTempDir = { ...options };
+    optionsWithoutTempDir.useTempDir = false;
+
+    const gen = new NgOpenApiGen(templatesSpec as OpenAPIObject, optionsWithoutTempDir);
+    gen.generate();
+
+    const tempDirectory = os.tmpdir();
+    expect(gen.tempDir.startsWith(tempDirectory)).toBeFalse();
+
+  });
+
+});