feat: @summary, @description comments at each route; fix: @description (parse all lines); fix: parsing schema without routes; internal: add debug script

Author: svolkov

.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Launch via npm",
+      "type": "node",
+      "request": "launch",
+      "cwd": "${workspaceFolder}",
+      "runtimeExecutable": "npm",
+      "runtimeArgs": ["run-script", "generate:debug"],
+      "port": 9229
+    }
+  ]
+}

package.json

@@ -5,6 +5,7 @@
   "scripts": {
     "cli": "node index.js -p ./tests/schemas/v3.0/personal-api-example.json -o ./tests/generated/v3.0/ -n personal-api-example.ts",
     "generate": "node tests/generate.js",
+    "generate:debug": "node --nolazy --inspect-brk=9229 tests/generate.js",
     "validate": "node tests/validate.js"
   },
   "author": "acacode",

src/routes.js

@@ -31,7 +31,7 @@ const getRouteName = (operationId, method, route, moduleName) => {
 }
 
 const parseRoutes = (routes, parsedSchemas) =>
-  Object.entries(routes)
+  _.entries(routes)
     .reduce((routes, [route, requestInfoByMethodsMap]) => {
       parameters = _.get(requestInfoByMethodsMap, 'parameters');
 
@@ -119,11 +119,11 @@ const parseRoutes = (routes, parsedSchemas) =>
           const comments = [
             tags && tags.length && `@tags ${tags.join(', ')}`,
             `@name ${routeName}`,
-            (description || summary) && `@description ${_.replace(summary || description, /\n/g, '')}`,
+            summary && `@summary ${summary}`,
             `@request ${_.upperCase(method)}:${route}`,
             // requestBody && requestBody.description && `@body ${requestBody.description}`,
-            hasSecurity && `@security true`,
-            // ...responsesInfos,
+            hasSecurity && `@secure`,
+            description && `@description ${_.replace(description, /\n/g, '. ')}`,
           ].filter(Boolean);
 
           return {

src/schema.js

@@ -1,6 +1,9 @@
 const _ = require("lodash");
 const { inlineExtraFormatters } = require("./typeFormatters");
 
+const jsTypes = ['number', 'boolean', 'string', 'object'];
+const jsEmptyTypes = ['null', 'undefined'];
+
 const findSchemaType = schema => {
   if (schema.enum) return 'enum';
   if (schema.properties) return 'object';
@@ -46,7 +49,6 @@ const complexSchemaParsers = {
   },
   'allOf': (schema) => {
     // T1 & T2
-    // const { description, }
     return _.map(schema.allOf, complexTypeGetter).join(' & ')
   },
   'anyOf': (schema) => {
@@ -55,16 +57,18 @@ const complexSchemaParsers = {
     return `${combined.join(' | ')}` + (combined.length > 1 ? ` | (${combined.join(' & ')})` : '');
   },
   // TODO
-  // 'not': (schema) => {
-  //   // TODO
-  // }
+  'not': (schema) => {
+    // TODO
+  }
 }
 
 const getComplexType = (schema) => {
   if (schema.oneOf) return 'oneOf';
   if (schema.allOf) return 'allOf';
   if (schema.anyOf) return 'anyOf';
-  // if (schema.not) return 'not';
+  if (schema.not) return 'not';
+
+  throw new Error("Uknown complex type")
 }
 
 const schemaParsers = {
@@ -102,6 +106,7 @@ const schemaParsers = {
   },
   'complex': (schema, typeName) => {
     const complexType = getComplexType(schema);
+
     return {
       type: 'type',
       typeIdentifier: 'type',

src/swagger.js

@@ -36,8 +36,9 @@ const getSwaggerObject = (pathToSwagger, urlToSwagger) =>
           rbname: "requestBodyName",
         }, function(err, options){
           const swaggerSchema = _.get(err, 'options.openapi', _.get(options, 'openapi'))
-
-          if (!swaggerSchema && err) throw new Error(err)
+          if (!swaggerSchema && err) {
+            throw new Error(err)
+          }
           resolve(swaggerSchema)
         });
       } else {

tests/generated/v2.0/api-with-examples.ts

@@ -93,8 +93,9 @@ export class Api<SecurityDataType> {
 
   /**
    * @name listVersionsv2
-   * @description List API versions
+   * @summary List API versions
    * @request GET:/
+   * @description multiple line 1. multiple line 2. multiple line 3. 
    */
   listVersionsv2 = (params?: RequestParams) =>
     this.request<any>(`/`, "GET", params, null)
@@ -104,7 +105,7 @@ export class Api<SecurityDataType> {
 
     /**
     * @name getVersionDetailsv2
-    * @description Show API version details
+    * @summary Show API version details
     * @request GET:/v2
     */
     getVersionDetailsv2: (params?: RequestParams) =>

tests/generated/v2.0/petstore-expanded.ts

@@ -117,35 +117,35 @@ export class Api<SecurityDataType> {
 
     /**
     * @name findPets
-    * @description Returns all pets from the system that the user has access toNam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
     * @request GET:/pets
+    * @description Returns all pets from the system that the user has access to. Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.. . Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.. 
     */
     findPets: (query: { tags?: string[], limit?: number }, params?: RequestParams) =>
       this.request<Pet[]>(`/pets${this.addQueryParams(query)}`, "GET", params, null),
 
 
     /**
     * @name addPet
-    * @description Creates a new pet in the store.  Duplicates are allowed
     * @request POST:/pets
+    * @description Creates a new pet in the store.  Duplicates are allowed
     */
     addPet: (pet: NewPet, params?: RequestParams) =>
       this.request<Pet>(`/pets`, "POST", params, pet),
 
 
     /**
     * @name find pet by id
-    * @description Returns a user based on a single ID, if the user does not have access to the pet
     * @request GET:/pets/{id}
+    * @description Returns a user based on a single ID, if the user does not have access to the pet
     */
     findPetById: (id: number, params?: RequestParams) =>
       this.request<Pet>(`/pets/${id}`, "GET", params, null),
 
 
     /**
     * @name deletePet
-    * @description deletes a single pet based on the ID supplied
     * @request DELETE:/pets/{id}
+    * @description deletes a single pet based on the ID supplied
     */
     deletePet: (id: number, params?: RequestParams) =>
       this.request<any>(`/pets/${id}`, "DELETE", params, null),

tests/generated/v2.0/petstore-minimal.ts

@@ -101,8 +101,8 @@ export class Api<SecurityDataType> {
 
     /**
     * @name get
-    * @description Returns all pets from the system that the user has access to
     * @request GET:/pets
+    * @description Returns all pets from the system that the user has access to
     */
     get: (params?: RequestParams) =>
       this.request<Pet[]>(`/pets`, "GET", params, null),

tests/generated/v2.0/petstore-simple.ts

@@ -117,35 +117,35 @@ export class Api<SecurityDataType> {
 
     /**
     * @name findPets
-    * @description Returns all pets from the system that the user has access to
     * @request GET:/pets
+    * @description Returns all pets from the system that the user has access to
     */
     findPets: (query: { tags?: string[], limit?: number }, params?: RequestParams) =>
       this.request<Pet[]>(`/pets${this.addQueryParams(query)}`, "GET", params, null),
 
 
     /**
     * @name addPet
-    * @description Creates a new pet in the store.  Duplicates are allowed
     * @request POST:/pets
+    * @description Creates a new pet in the store.  Duplicates are allowed
     */
     addPet: (pet: NewPet, params?: RequestParams) =>
       this.request<Pet>(`/pets`, "POST", params, pet),
 
 
     /**
     * @name findPetById
-    * @description Returns a user based on a single ID, if the user does not have access to the pet
     * @request GET:/pets/{id}
+    * @description Returns a user based on a single ID, if the user does not have access to the pet
     */
     findPetById: (id: number, params?: RequestParams) =>
       this.request<Pet>(`/pets/${id}`, "GET", params, null),
 
 
     /**
     * @name deletePet
-    * @description deletes a single pet based on the ID supplied
     * @request DELETE:/pets/{id}
+    * @description deletes a single pet based on the ID supplied
     */
     deletePet: (id: number, params?: RequestParams) =>
       this.request<any>(`/pets/${id}`, "DELETE", params, null),

tests/generated/v2.0/petstore-with-external-docs.ts

@@ -117,35 +117,35 @@ export class Api<SecurityDataType> {
 
     /**
     * @name findPets
-    * @description Returns all pets from the system that the user has access to
     * @request GET:/pets
+    * @description Returns all pets from the system that the user has access to
     */
     findPets: (query: { tags?: string[], limit?: number }, params?: RequestParams) =>
       this.request<Pet[]>(`/pets${this.addQueryParams(query)}`, "GET", params, null),
 
 
     /**
     * @name addPet
-    * @description Creates a new pet in the store.  Duplicates are allowed
     * @request POST:/pets
+    * @description Creates a new pet in the store.  Duplicates are allowed
     */
     addPet: (pet: NewPet, params?: RequestParams) =>
       this.request<Pet>(`/pets`, "POST", params, pet),
 
 
     /**
     * @name findPetById
-    * @description Returns a user based on a single ID, if the user does not have access to the pet
     * @request GET:/pets/{id}
+    * @description Returns a user based on a single ID, if the user does not have access to the pet
     */
     findPetById: (id: number, params?: RequestParams) =>
       this.request<Pet>(`/pets/${id}`, "GET", params, null),
 
 
     /**
     * @name deletePet
-    * @description deletes a single pet based on the ID supplied
     * @request DELETE:/pets/{id}
+    * @description deletes a single pet based on the ID supplied
     */
     deletePet: (id: number, params?: RequestParams) =>
       this.request<any>(`/pets/${id}`, "DELETE", params, null),