Release 4.1.0 (#138)

* feat: improve require() function, fix: unexpected token =

* feat: --clean-output option, fix: output folder creation #137 issue

* docs: update CHANGELOG, README

* bump: up project version to 4.1.0

Author: js2me

.prettierignore

@@ -1,4 +1,7 @@
 tests/**/*.ts
 tests/**/schema.js
 tests/**/*.d.js
+swagger-test-cli
+swagger-test-cli.*
+templates
 *.md

CHANGELOG.md

@@ -1,5 +1,17 @@
 # next release  
 
+# 4.1.0  
+
+Features:  
+- Improve `require()` function used in ETA templates (using relative path imports)  
+- `--clean-output` option.  
+  clean output folder before generate api  
+
+Fixes:  
+- Error: `Unexpected token =` (Issue #136, Thanks @jlow-mudbath)  
+- Output folder creation (Issue #137, Thanks @Rinta01)  
+  Create output folder if it is not exist  
+
 # 4.0.5  
 
 BREAKING_CHANGE:  

README.md

@@ -57,6 +57,7 @@ Options:
                                 (example: GET:/fruites/getFruit -> index:0 -> moduleName -> fruites)
   --modular                     generate separated files for http client, data contracts, and routes (default: false)
   --disableStrictSSL            disabled strict SSL (default: false)
+  --clean-output                clean output folder before generate api. WARNING: May cause data loss (default: false)
   -h, --help                    display help for command
 ```
 

index.js

@@ -60,7 +60,12 @@ program
     "determines which path index should be used for routes separation (example: GET:/fruites/getFruit -> index:0 -> moduleName -> fruites)",
     0,
   )
-  .option("--disableStrictSSL", "disabled strict SSL", false);
+  .option("--disableStrictSSL", "disabled strict SSL", false)
+  .option(
+    "--clean-output",
+    "clean output folder before generate api. WARNING: May cause data loss",
+    false,
+  );
 
 program.parse(process.argv);
 
@@ -80,6 +85,7 @@ const {
   extractRequestParams,
   enumNamesAsValues,
   disableStrictSSL,
+  cleanOutput,
 } = program;
 
 generateApi({
@@ -99,4 +105,5 @@ generateApi({
   enumNamesAsValues: enumNamesAsValues,
   moduleNameIndex: +(moduleNameIndex || 0),
   disableStrictSSL: !!disableStrictSSL,
+  cleanOutput: !!cleanOutput,
 });

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "4.0.5",
+  "version": "4.1.0",
   "description": "Create typescript api module from swagger schema",
   "scripts": {
     "cli:json": "node index.js -r -d -p ./swagger-test-cli.json -n swagger-test-cli.ts --extract-request-params --enum-names-as-values",

package.json

@@ -5,13 +5,45 @@ const { filePrefix } = require("./filePrefix");
 
 const getFileContent = (path) => fs.readFileSync(path, { encoding: "UTF-8" });
 
+const pathIsDir = (path) => {
+  if (!path) return false;
+
+  try {
+    const stat = fs.statSync(path);
+    return stat.isDirectory();
+  } catch (e) {
+    return false;
+  }
+};
+
+const removeDir = (path) => {
+  try {
+    fs.rmdirSync(path, { recursive: true });
+  } catch (e) {}
+};
+
+const createDir = (path) => {
+  try {
+    fs.mkdirSync(path);
+  } catch (e) {}
+};
+
+const cleanDir = (path) => {
+  removeDir(path);
+  createDir(path);
+};
+
 const pathIsExist = (path) => path && fs.existsSync(path);
 
 const createFile = (pathTo, fileName, content) =>
   fs.writeFileSync(resolve(__dirname, pathTo, `./${fileName}`), `${filePrefix}${content}`, _.noop);
 
 module.exports = {
   createFile,
+  pathIsDir,
+  cleanDir,
   pathIsExist,
+  createDir,
+  removeDir,
   getFileContent,
 };

src/files.js

@@ -18,13 +18,27 @@ class LanguageServiceHost {
     });
   }
 
-  getNewLine = () => "\n";
-  getScriptFileNames = () => [this.fileName];
-  getCompilationSettings = () => this.compilerOptions;
-  getDefaultLibFileName = () => ts.getDefaultLibFileName(this.getCompilationSettings());
-  getCurrentDirectory = () => process.cwd();
-  getScriptVersion = () => ts.version;
-  getScriptSnapshot = () => ts.ScriptSnapshot.fromString(this.content);
+  getNewLine() {
+    return "\n";
+  }
+  getScriptFileNames() {
+    return [this.fileName];
+  }
+  getCompilationSettings() {
+    return this.compilerOptions;
+  }
+  getDefaultLibFileName() {
+    return ts.getDefaultLibFileName(this.getCompilationSettings());
+  }
+  getCurrentDirectory() {
+    return process.cwd();
+  }
+  getScriptVersion() {
+    return ts.version;
+  }
+  getScriptSnapshot() {
+    return ts.ScriptSnapshot.fromString(this.content);
+  }
 }
 
 const removeUnusedImports = (content) => {

src/formatFileContent.js

@@ -13,7 +13,7 @@ const { createApiConfig } = require("./apiConfig");
 const { prepareModelType } = require("./modelTypes");
 const { getSwaggerObject, fixSwaggerScheme, convertSwaggerObject } = require("./swagger");
 const { createComponentsMap, filterComponentsMap } = require("./components");
-const { createFile, pathIsExist } = require("./files");
+const { createFile, pathIsExist, pathIsDir, createDir, cleanDir } = require("./files");
 const { addToConfig, config } = require("./config");
 const { getTemplates } = require("./templates");
 const constants = require("./constants");
@@ -41,6 +41,7 @@ module.exports = {
     extraTemplates,
     enumNamesAsValues,
     disableStrictSSL = config.disableStrictSSL,
+    cleanOutput,
   }) =>
     new Promise((resolve, reject) => {
       addToConfig({
@@ -57,6 +58,7 @@ module.exports = {
         hooks: _.merge(config.hooks, rawHooks || {}),
         enumNamesAsValues,
         disableStrictSSL,
+        cleanOutput,
       });
       (spec ? convertSwaggerObject(spec) : getSwaggerObject(input, url, disableStrictSSL))
         .then(({ usageSchema, originalSchema }) => {
@@ -110,14 +112,24 @@ module.exports = {
 
           const configuration = config.hooks.onPrepareConfig(rawConfiguration) || rawConfiguration;
 
+          if (pathIsExist(output)) {
+            if (cleanOutput) {
+              cleanDir(output);
+            }
+          } else {
+            createDir(output);
+          }
+
           const files = generateOutputFiles({
             modular,
             templatesToRender,
             configuration,
           });
 
+          const isDirPath = pathIsDir(output);
+
           const generatedFiles = files.map((file) => {
-            if (!pathIsExist(output)) return file;
+            if (!isDirPath) return file;
 
             if (translateToJavaScript) {
               createFile(output, file.name, file.content);

src/index.js

@@ -1,5 +1,8 @@
+const _ = require("lodash");
+const path = require("path");
 const { classNameCase, formatDescription, internalCase } = require("../../common");
 const { getComponentByRef } = require("../../components");
+const { config } = require("../../config");
 const { getInlineParseContent, getParseContent, parseSchema } = require("../../schema");
 const { formatters, inlineExtraFormatters } = require("../../typeFormatters");
 
@@ -14,6 +17,14 @@ module.exports = {
   formatters,
   inlineExtraFormatters,
   fmtToJSDocLine: require("./fmtToJSDocLine"),
-  _: require("lodash"),
-  require: require,
+  _: _,
+  require: (packageOrPath) => {
+    const isPath = _.startsWith(packageOrPath, "./") || _.startsWith(packageOrPath, "../");
+
+    if (isPath) {
+      return require(path.resolve(config.templates, packageOrPath));
+    }
+
+    return require(packageOrPath);
+  },
 };