refactor(): lint errors and some functions moved from helpers

Signed-off-by: Vojtech Mašek <[email protected]>

Author: vmasek

src/generator.ts

@@ -3,9 +3,10 @@ import { ensureDir } from 'fs-extra';
 import * as Mustache from 'mustache';
 import { dirname, join } from 'path';
 import { parse as swaggerFile, validate } from 'swagger-parser';
+import { Operation, Path, Spec as Swagger } from 'swagger-schema-official';
 import { promisify } from 'util';
 import { MustacheData, GenOptions, Definition } from './types';
-import { fileName, logWarn, dashCase, getAllSwaggerTags, flattenAll, compareStringByKey } from './helper';
+import { fileName, logWarn, dashCase, flattenAll, compareStringByKey } from './helper';
 import { createMustacheViewModel } from './parser';
 
 const ALL_TAGS_OPTION = 'all';
@@ -31,8 +32,8 @@ export async function generateAPIClient(options: GenOptions): Promise<string[]>
     throw new Error(`Provided swagger file "${swaggerFilePath}" is invalid`);
   }
 
-  const swaggerDef = await swaggerFile(swaggerFilePath);
-  const allTags = getAllSwaggerTags(swaggerDef);
+  const swaggerDef: Swagger = await swaggerFile(swaggerFilePath);
+  const allTags = getAllSwaggerTags(swaggerDef.paths);
   const specifiedTags = options.splitPathTags || [];
   const usedTags: (string | undefined)[] = specifiedTags.length === 0
     ? [undefined]
@@ -46,7 +47,7 @@ export async function generateAPIClient(options: GenOptions): Promise<string[]>
   const allDefinitions = apiTagsData.map(({definitions}) => definitions).reduce<Definition[]>(
     (acc, definitions) => [...acc, ...definitions], []
   )
-    .sort(compareStringByKey('name'))
+    .sort(compareStringByKey('name')) // tslint:disable-line:no-array-mutation
     .filter(({name}, index, self) => index > 0 ? name !== self[index - 1].name : true);
 
   return flattenAll([
@@ -134,3 +135,14 @@ async function generateModuleExportIndex(viewContext: MustacheData, outputPath:
   await promisify(writeFile)(outfile, result, 'utf-8');
   return [outfile];
 }
+
+export function getAllSwaggerTags(paths: { [pathName: string]: Path }): string[] {
+  const allTags = Object.values(paths).map((pathDef) =>
+    // get tags from all the paths and flatten with reduce
+    Object.values(pathDef)
+      .map(({tags}: Operation) => tags || [])
+      .reduce<string[]>((acc, tags) => [...acc, ...tags], [])
+  ).reduce<string[]>((acc, tags) => [...acc, ...tags], []); // array of tags fatten with reduce
+
+  return Array.from(new Set(allTags));
+}

src/helper.ts

@@ -1,4 +1,3 @@
-import { Spec as Swagger, Path, Operation } from 'swagger-schema-official';
 import { FileInfix } from './types';
 
 export const BASIC_TS_TYPE_REGEX = /\b(?:string|number|integer|boolean)\b/;
@@ -87,20 +86,6 @@ export function prefixImportedModels(type: string = ''): string {
   return BUILD_IN_TS_TYPE_REGEX.test(type) ? type : `models.${type}`;
 }
 
-export function determineDomain({schemes, host, basePath}: Swagger): string {
-
-  // if the host is defined then try and use a protocol from the swagger file
-  // otherwise use the current protocol of loaded app
-  const protocol = host && schemes && schemes.length > 0 ? `${schemes[0]}://` : '//';
-
-  // if no host exists in the swagger file use a window location relative path
-  const domain = host
-    ? host // tslint:disable-next-line:no-invalid-template-strings
-    : '${window.location.hostname}${window.location.port ? \':\'+window.location.port : \'\'}';
-  const base = ('/' === basePath || !basePath ? '' : basePath);
-  return `${protocol}${domain}${base}`;
-}
-
 export function replaceNewLines(str: string = '', replaceValue: string = ''): string {
   return str.replace(/(\r\n|\r|\n)/g, replaceValue);
 }
@@ -109,16 +94,6 @@ export function logWarn(str: string): void {
   console.warn('\x1b[33m%s\x1b[0m', str);
 }
 
-export function getAllSwaggerTags(swagger: Swagger): string[] {
-  const allTags: string[] = [];
-  Object.values(swagger.paths)
-    .forEach((pathDef: Path) =>
-      Object.values(pathDef).forEach((operation: Operation) =>
-        allTags.push(...(operation.tags ? operation.tags : [])))
-    );
-  return Array.from(new Set(allTags));
-}
-
 /**
  * Aggregates an array of promises of arrays to a single promise of a flattened array.
  * @param promises An array of promises that resolve to arrays of values.
@@ -128,7 +103,6 @@ export async function flattenAll<T>(promises: Promise<T[]>[]): Promise<T[]> {
   return Array.prototype.concat(...await Promise.all(promises));
 }
 
-
 export function compareStringByKey<T>(key: keyof T): (a: T, b: T) => number {
   return (a, b) => a[key] && b[key] ? `${a[key]}`.localeCompare(`${b[key]}`) : -1;
 }

src/parser.ts

@@ -20,7 +20,6 @@ import {
   BASIC_TS_TYPE_REGEX,
   toCamelCase,
   dereferenceType,
-  determineDomain,
   fileName,
   prefixImportedModels,
   replaceNewLines,
@@ -71,6 +70,20 @@ export function createMustacheViewModel(swagger: Swagger, swaggerTag?: string):
   };
 }
 
+export function determineDomain({schemes, host, basePath}: Swagger): string {
+
+  // if the host is defined then try and use a protocol from the swagger file
+  // otherwise use the current protocol of loaded app
+  const protocol = host && schemes && schemes.length > 0 ? `${schemes[0]}://` : '//';
+
+  // if no host exists in the swagger file use a window location relative path
+  const domain = host
+    ? host // tslint:disable-next-line:no-invalid-template-strings
+    : '${window.location.hostname}${window.location.port ? \':\'+window.location.port : \'\'}';
+  const base = ('/' === basePath || !basePath ? '' : basePath);
+  return `${protocol}${domain}${base}`;
+}
+
 function parseMethods({paths, security, parameters}: Swagger, swaggerTag?: string): Method[] {
   const supportedMethods = ['DELETE', 'GET', 'HEAD', 'OPTIONS', 'PATCH', 'POST', 'PUT'];
 
@@ -218,7 +231,7 @@ function parseInterfaceProperties(properties: { [propertyName: string]: Schema }
         typescriptType,
       };
     }
-  ).sort(compareStringByKey('name'));
+  ).sort(compareStringByKey('name')); // tslint:disable-line:no-array-mutation
 }
 
 function parseReference(schema: Schema): string {
@@ -276,7 +289,7 @@ function defineInterface(schema: Schema, definitionKey: string): Definition {
       .map(({type}) => type || '')
       .filter((type) => type !== name)
       .concat(extendInterface ? [extendInterface] : [])
-      .sort()
+      .sort() // tslint:disable-line:no-array-mutation
       // filter duplicate imports
       .filter((el, i, a) => (i === a.indexOf(el)) ? 1 : 0),
     isEnum: false,

tslint.json

@@ -128,6 +128,7 @@
     ],
     "no-misused-new": true,
     "no-namespace": true,
+    "no-array-mutation": true,
     "no-object-mutation": [true, {"ignore-prefix": "this."}],
     "no-parameter-reassignment": false,
     "no-reference": true,