feat: add prettier for output typescript api module; fix: problem with array type; bump: up version to 1.5.0

Author: svolkov

CHANGELOG.md

@@ -1,5 +1,15 @@
 # next release
 
+# 1.5.0
+
+Features:
+
+- Add `prettier` for beautify output typescript api module
+
+Fixes:
+
+- Fix problem with array `type` definitions without `type` property([#26](https://github.com/acacode/swagger-typescript-api/issues/26))
+
 # 1.4.1
 
 Fixes:

package-lock.json

@@ -1,10 +1,10 @@
 {
   "name": "swagger-typescript-api",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Create typescript api module from swagger schema",
   "scripts": {
     "cli": "node index.js -d -p ./swagger-test-cli.json -n swagger-test-cli.ts",
-    "cli:debug": "node  --nolazy --inspect-brk=9229 index.js -p ./tests/schemas/v2.0/adafruit.yaml -n swagger-test-cli.ts",
+    "cli:debug": "node  --nolazy --inspect-brk=9229 index.js -p ./swagger-test-cli.json -n swagger-test-cli.ts",
     "cli:help": "node index.js -h",
     "test:all": "npm-run-all generate validate test:routeTypes test:noClient test:defaultAsSuccess test:responses --continue-on-error",
     "generate": "node tests/generate.js",
@@ -23,9 +23,9 @@
   "devDependencies": {
     "@types/lodash": "^4.14.149",
     "@types/mustache": "^4.0.0",
+    "@types/prettier": "^1.19.0",
     "husky": "^4.2.3",
     "npm-run-all": "^4.1.5",
-    "prettier": "^1.19.1",
     "pretty-quick": "^2.0.1",
     "typescript": "^3.7.4"
   },
@@ -35,7 +35,8 @@
     "js-yaml": "^3.13.1",
     "lodash": "^4.17.15",
     "mustache": "^4.0.0",
-    "swagger2openapi": "^5.3.3"
+    "swagger2openapi": "^5.3.3",
+    "prettier": "^1.19.1"
   },
   "bin": {
     "swagger-typescript-api": "index.js",

package.json

@@ -7,17 +7,25 @@
 // Repository https://github.com/acacode/swagger-typescript-api
 
 const mustache = require("mustache");
+const prettier = require("prettier");
 const _ = require("lodash");
-const { parseSchemas } = require('./schema');
-const { parseRoutes, groupRoutes } = require('./routes');
-const { createApiConfig } = require('./apiConfig');
-const { getModelType } = require('./modelTypes');
-const { getSwaggerObject } = require('./swagger');
+const { parseSchemas } = require("./schema");
+const { parseRoutes, groupRoutes } = require("./routes");
+const { createApiConfig } = require("./apiConfig");
+const { getModelType } = require("./modelTypes");
+const { getSwaggerObject } = require("./swagger");
 const { createComponentsMap, filterComponentsMap } = require("./components");
-const { getTemplate, createFile, pathIsExist } = require('./files');
+const { getTemplate, createFile, pathIsExist } = require("./files");
 const { addToConfig, config: defaults } = require("./config");
 
-mustache.escape = value => value
+mustache.escape = value => value;
+
+const prettierConfig = {
+  printWidth: 120,
+  tabWidth: 2,
+  trailingComma: "all",
+  parser: "typescript",
+};
 
 module.exports = {
   generateApi: ({
@@ -29,58 +37,68 @@ module.exports = {
     defaultResponseAsSuccess = defaults.defaultResponseAsSuccess,
     generateRouteTypes = defaults.generateRouteTypes,
     generateClient = defaults.generateClient,
-  }) => new Promise((resolve, reject) => {
-    addToConfig({
-      defaultResponseAsSuccess,
-      generateRouteTypes,
-      generateClient,
-      generateResponses,
-    })
-    getSwaggerObject(input, url).then(swaggerSchema => {
-      console.log('☄️  start generating your typescript api')
-      
-      addToConfig({ swaggerSchema });
+  }) =>
+    new Promise((resolve, reject) => {
+      addToConfig({
+        defaultResponseAsSuccess,
+        generateRouteTypes,
+        generateClient,
+        generateResponses,
+      });
+      getSwaggerObject(input, url)
+        .then(swaggerSchema => {
+          console.log("☄️  start generating your typescript api");
 
-      const { info, paths, servers, components } = swaggerSchema;
+          addToConfig({ swaggerSchema });
 
-      const apiTemplate = getTemplate('api');
-      const clientTemplate = getTemplate('client');
-      const routeTypesTemplate = getTemplate('route-types');
+          const { info, paths, servers, components } = swaggerSchema;
 
-      const componentsMap = createComponentsMap(components);
-      const schemasMap = filterComponentsMap(componentsMap, "schemas")
+          const apiTemplate = getTemplate("api");
+          const clientTemplate = getTemplate("client");
+          const routeTypesTemplate = getTemplate("route-types");
 
-      const parsedSchemas = parseSchemas(components);
-      const routes = parseRoutes(swaggerSchema, parsedSchemas, componentsMap, components);
-      const hasSecurityRoutes = routes.some(route => route.security);
-      const hasQueryRoutes = routes.some(route => route.hasQuery);
-      const apiConfig = createApiConfig({ info, servers }, hasSecurityRoutes);
-    
-      const configuration = {
-        apiConfig,
-        modelTypes: _.map(schemasMap, getModelType),
-        hasSecurityRoutes,
-        hasQueryRoutes,
-        generateResponses,
-        routes: groupRoutes(routes),
-      };
-    
-      const sourceFile = [
-        mustache.render(apiTemplate, configuration),
-        generateRouteTypes ? mustache.render(routeTypesTemplate, configuration) : '',
-        generateClient ? mustache.render(clientTemplate, configuration) : '',
-      ].join('');
+          const componentsMap = createComponentsMap(components);
+          const schemasMap = filterComponentsMap(componentsMap, "schemas");
+
+          const parsedSchemas = parseSchemas(components);
+          const routes = parseRoutes(swaggerSchema, parsedSchemas, componentsMap, components);
+          const hasSecurityRoutes = routes.some(route => route.security);
+          const hasQueryRoutes = routes.some(route => route.hasQuery);
+          const apiConfig = createApiConfig({ info, servers }, hasSecurityRoutes);
+
+          const configuration = {
+            apiConfig,
+            modelTypes: _.map(schemasMap, getModelType),
+            hasSecurityRoutes,
+            hasQueryRoutes,
+            generateResponses,
+            routes: groupRoutes(routes),
+          };
 
-      if (pathIsExist(output)) {
-        createFile(output, name, sourceFile);
-        console.log(`✔️  your typescript api file created in "${output}"`)
-      }
+          const sourceFile = prettier.format(
+            [
+              mustache.render(apiTemplate, configuration),
+              generateRouteTypes ? mustache.render(routeTypesTemplate, configuration) : "",
+              generateClient ? mustache.render(clientTemplate, configuration) : "",
+            ].join(""),
+            {
+              printWidth: 120,
+              tabWidth: 2,
+              trailingComma: "all",
+              parser: "typescript",
+            },
+          );
 
-      resolve(sourceFile);
-    }).catch(e =>{
-      reject(e);
-      throw new Error('Swagger schema parse error!\r\n ' + e)
-    })
-  })
-}
+          if (pathIsExist(output)) {
+            createFile(output, name, sourceFile);
+            console.log(`✔️  your typescript api file created in "${output}"`);
+          }
 
+          resolve(sourceFile);
+        })
+        .catch(e => {
+          reject(e);
+          throw new Error("Swagger schema parse error!\r\n " + e);
+        });
+    }),
+};

src/index.js

@@ -151,11 +151,20 @@ const schemaParsers = {
   },
 };
 
+const checkAndFixSchema = schema => {
+  if (schema.items && !schema.type) {
+    schema.type = "array";
+  }
+
+  return schema;
+};
+
 /** @returns {{ type, typeIdentifier, name, description, content }} */
-const parseSchema = (schema, typeName, formattersMap) => {
-  if (!schema) return schemaParsers.primitive(null, typeName);
-  const schemaType = findSchemaType(schema);
-  const parsedSchema = schemaParsers[schemaType](schema, typeName);
+const parseSchema = (rawSchema, typeName, formattersMap) => {
+  if (!rawSchema) return schemaParsers.primitive(null, typeName);
+  const fixedRawSchema = checkAndFixSchema(rawSchema);
+  const schemaType = findSchemaType(fixedRawSchema);
+  const parsedSchema = schemaParsers[schemaType](fixedRawSchema, typeName);
   return (
     (formattersMap && formattersMap[schemaType] && formattersMap[schemaType](parsedSchema)) ||
     parsedSchema