Replaced TSLint by ESLint

Luis Fernando Planella Gonzalez · Luis Fernando Planella Gonzalez · commit ed1ff34d5999 · 2023-06-28T09:06:40.000-03:00
Fixes #277
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,98 @@
+module.exports = {
+    "env": {
+        "es6": true,
+        "node": true
+    },
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "project": "tsconfig.json",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "eslint-plugin-jsdoc",
+        "@typescript-eslint",
+        "@typescript-eslint/tslint"
+    ],
+    "root": true,
+    "rules": {
+        "@typescript-eslint/indent": [
+          "error",
+          2
+        ],
+        "@typescript-eslint/member-delimiter-style": [
+            "error",
+            {
+                "multiline": {
+                    "delimiter": "semi",
+                    "requireLast": true
+                },
+                "singleline": {
+                    "delimiter": "semi",
+                    "requireLast": false
+                }
+            }
+        ],
+        "@typescript-eslint/naming-convention": "error",
+        "@typescript-eslint/no-shadow": [
+            "error",
+            {
+                "hoist": "all"
+            }
+        ],
+        "@typescript-eslint/prefer-namespace-keyword": "error",
+        "@typescript-eslint/quotes": [
+            "error",
+            "single"
+        ],
+        "@typescript-eslint/semi": [
+            "error",
+            "always"
+        ],
+        "@typescript-eslint/type-annotation-spacing": "error",
+        "brace-style": [
+            "error",
+            "1tbs"
+        ],
+        "eol-last": "error",
+        "eqeqeq": [
+            "error",
+            "smart"
+        ],
+        "guard-for-in": "error",
+        "indent": "off",
+        "jsdoc/check-alignment": "error",
+        "jsdoc/check-indentation": "error",
+        "no-shadow": "off",
+        "no-throw-literal": "error",
+        "no-trailing-spaces": "error",
+        "no-var": "error",
+        "prefer-const": "error",
+        "quotes": "off",
+        "semi": "off",
+        "spaced-comment": [
+            "error",
+            "always",
+            {
+                "markers": [
+                    "/"
+                ]
+            }
+        ],
+        "@typescript-eslint/tslint/config": [
+            "error",
+            {
+                "rules": {
+                    "whitespace": [
+                        true,
+                        "check-branch",
+                        "check-decl",
+                        "check-operator",
+                        "check-module",
+                        "check-separator",
+                        "check-type"
+                    ]
+                }
+            }
+        ]
+    }
+};
diff --git a/lib/cmd-args.ts b/lib/cmd-args.ts
@@ -5,18 +5,19 @@ import { Options } from './options.js';
 import fs from 'fs';
 import { kebabCase } from 'lodash';
 
-const Mnemonics: { [key: string]: string } = { 'input': 'i', 'output': 'o' };
-const DefaultConfig = 'ng-openapi-gen.json';
+const MNEMONICS: { [key: string]: string } = { 'input': 'i', 'output': 'o' };
+const DEFAULT = 'ng-openapi-gen.json';
 
 function createParser() {
   const argParser = new ArgumentParser({
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     add_help: true,
     description: `
 Generator for API clients described with OpenAPI 3.0 specification for
 Angular 6+ projects. Requires a configuration file, which defaults to
-${DefaultConfig} in the current directory. The file can also be
+${DEFAULT} in the current directory. The file can also be
 specified using '--config <file>' or '-c <file>'.
-All settings in the configuration file can be overridding by setting the
+All settings in the configuration file can be overriding by setting the
 corresponding argument in the command-line. For example, to specify a
 custom suffix for service classes via command-line, pass the command-line
 argument '--serviceSuffix Suffix'. Kebab-case is also accepted, so, the same
@@ -38,9 +39,9 @@ a configuration file is only required if no --input argument is set.`.trim()
     {
       help: `
 The configuration file to be used. If not specified, assumes that
-${DefaultConfig} in the current directory`.trim(),
+${DEFAULT} in the current directory`.trim(),
       dest: 'config',
-      default: `./${DefaultConfig}`
+      default: `./${DEFAULT}`
     }
   );
   const props = schema.properties;
@@ -51,7 +52,7 @@ ${DefaultConfig} in the current directory`.trim(),
     const kebab = kebabCase(key);
     const desc = (props as any)[key];
     const names = [];
-    const mnemonic = Mnemonics[key];
+    const mnemonic = MNEMONICS[key];
     if (mnemonic) {
       names.push('-' + mnemonic);
     }
@@ -77,9 +78,9 @@ export function parseOptions(sysArgs?: string[]): Options {
   if (args.config) {
     if (fs.existsSync(args.config)) {
       options = JSON.parse(fs.readFileSync(args.config, { encoding: 'utf-8' }));
-    } else if (args.config === `./${DefaultConfig}`) {
+    } else if (args.config === `./${DEFAULT}`) {
       if ((args.input || '').length === 0) {
-        throw new Error(`No input is given, and the file ${DefaultConfig} doesn't exist.
+        throw new Error(`No input is given, and the file ${DEFAULT} doesn't exist.
 For help, run ng-openapi-gen --help`);
       }
     } else {
@@ -111,7 +112,7 @@ For help, run ng-openapi-gen --help`);
       options[key] = value;
     }
   }
-  if (options.input == undefined || options.input === '') {
+  if (options.input === undefined || options.input === '') {
     throw new Error('No input (OpenAPI specification) defined');
   }
   return options;
diff --git a/lib/content.ts b/lib/content.ts
@@ -6,7 +6,6 @@ import { tsType } from './gen-utils';
  * Either a request body or response content
  */
 export class Content {
-
   type: string;
 
   constructor(
diff --git a/lib/gen-utils.ts b/lib/gen-utils.ts
@@ -120,7 +120,7 @@ export function toBasicChars(text: string, firstNonDigit = false): string {
  */
 export function tsComments(description: string | undefined, level: number, deprecated?: boolean) {
   const indent = '  '.repeat(level);
-  if (description == undefined || description.length === 0) {
+  if (description === undefined || description.length === 0) {
     return indent + (deprecated ? '/** @deprecated */' : '');
   }
   const lines = description.trim().split('\n');
diff --git a/lib/globals.ts b/lib/globals.ts
@@ -32,15 +32,15 @@ export class Globals {
     this.responseClass = options.response || 'StrictHttpResponse';
     this.responseFile = fileName(this.responseClass);
     if (options.module !== false && options.module !== '') {
-      this.moduleClass = options.module === true || options.module == undefined ? 'ApiModule' : options.module;
+      this.moduleClass = options.module === true || options.module === undefined ? 'ApiModule' : options.module;
       // Angular's best practices demands xxx.module.ts, not xxx-module.ts
       this.moduleFile = fileName(this.moduleClass as string).replace(/\-module$/, '.module');
     }
     if (options.serviceIndex !== false && options.serviceIndex !== '') {
-      this.serviceIndexFile = options.serviceIndex === true || options.serviceIndex == undefined ? 'services' : options.serviceIndex;
+      this.serviceIndexFile = options.serviceIndex === true || options.serviceIndex === undefined ? 'services' : options.serviceIndex;
     }
     if (options.modelIndex !== false && options.modelIndex !== '') {
-      this.modelIndexFile = options.modelIndex === true || options.modelIndex == undefined ? 'models' : options.modelIndex;
+      this.modelIndexFile = options.modelIndex === true || options.modelIndex === undefined ? 'models' : options.modelIndex;
     }
   }
 
diff --git a/lib/ng-openapi-gen.ts b/lib/ng-openapi-gen.ts
@@ -1,21 +1,20 @@
+import $RefParser from '@apidevtools/json-schema-ref-parser';
 import { OpenAPIObject, OperationObject, PathItemObject, ReferenceObject, SchemaObject } from '@loopback/openapi-v3-types';
+import eol from 'eol';
 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 path from 'path';
 import { parseOptions } from './cmd-args';
-import { HTTP_METHODS, methodName, simpleName, syncDirs, deleteDirRecursive } from './gen-utils';
+import { HTTP_METHODS, deleteDirRecursive, methodName, simpleName, syncDirs } from './gen-utils';
 import { Globals } from './globals';
 import { HandlebarsManager } from './handlebars-manager';
 import { Import } from './imports';
+import { Logger } from './logger';
 import { Model } from './model';
 import { Operation } from './operation';
 import { Options } from './options';
 import { Service } from './service';
 import { Templates } from './templates';
-import eol from 'eol';
-import { Logger } from './logger';
 
 /**
  * Main generator class
@@ -128,7 +127,8 @@ export class NgOpenApiGen {
     const ts = this.setEndOfLine(this.templates.apply(template, model));
     const file = path.join(this.tempDir, subDir || '.', `${baseName}.ts`);
     const dir = path.dirname(file);
-    mkdirp.sync(dir);
+
+    fs.mkdirpSync(dir);
     fs.writeFileSync(file, ts, { encoding: 'utf-8' });
   }
 
@@ -322,8 +322,6 @@ export class NgOpenApiGen {
   }
 }
 
-///////////////////////////////////////////////////////////////////////////
-
 /**
  * Parses the command-line arguments, reads the configuration file and run the generation
  */
@@ -339,7 +337,7 @@ export async function runNgOpenApiGen() {
       resolve: {
         http: {
           timeout: options.fetchTimeout == null ? 20000 : options.fetchTimeout
-        } as HTTPResolverOptions
+        }
       }
     }) as OpenAPIObject;
     const gen = new NgOpenApiGen(openApi, options);
diff --git a/lib/operation.ts b/lib/operation.ts
@@ -101,7 +101,9 @@ export class Operation {
   }
 
   private collectSecurity(params: (SecurityRequirementObject)[] | undefined): Security[][] {
-    if (!params) { return []; }
+    if (!params) {
+      return [];
+    }
 
     return params.map((param) => {
       return Object.keys(param).map(key => {
@@ -127,7 +129,7 @@ export class Operation {
     return result;
   }
 
-  private collectResponses(): { success: Response | undefined, all: Response[] } {
+  private collectResponses(): { success: Response | undefined; all: Response[] } {
     let successResponse: Response | undefined = undefined;
     const allResponses: Response[] = [];
     const responses = this.spec.responses || {};
diff --git a/lib/options.ts b/lib/options.ts
@@ -100,8 +100,8 @@ export interface Options {
 
   customizedResponseType?: {
     [key: string]: {
-      toUse: 'arraybuffer' | 'blob' | 'json' | 'document'
-    }
+      toUse: 'arraybuffer' | 'blob' | 'json' | 'document';
+    };
   };
 
   /** When specified, will create temporary files in system temporary folder instead of next to output folder. */
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/tslint.json b/tslint.json

Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,7 @@ export function toBasicChars(text: string, firstNonDigit = false): string {`
`120`	`120`	`*/`
`121`	`121`	`export function tsComments(description: string \| undefined, level: number, deprecated?: boolean) {`
`122`	`122`	`const indent = ' '.repeat(level);`
`123`		`- if (description == undefined \|\| description.length === 0) {`
	`123`	`+ if (description === undefined \|\| description.length === 0) {`
`124`	`124`	`return indent + (deprecated ? '/** @deprecated */' : '');`
`125`	`125`	`}`
`126`	`126`	`const lines = description.trim().split('\n');`
Original file line number	Diff line number	Diff line change
`@@ -32,15 +32,15 @@ export class Globals {`
`32`	`32`	`this.responseClass = options.response \|\| 'StrictHttpResponse';`
`33`	`33`	`this.responseFile = fileName(this.responseClass);`
`34`	`34`	`if (options.module !== false && options.module !== '') {`
`35`		`- this.moduleClass = options.module === true \|\| options.module == undefined ? 'ApiModule' : options.module;`
	`35`	`+ this.moduleClass = options.module === true \|\| options.module === undefined ? 'ApiModule' : options.module;`
`36`	`36`	`// Angular's best practices demands xxx.module.ts, not xxx-module.ts`
`37`	`37`	`this.moduleFile = fileName(this.moduleClass as string).replace(/\-module$/, '.module');`
`38`	`38`	`}`
`39`	`39`	`if (options.serviceIndex !== false && options.serviceIndex !== '') {`
`40`		`- this.serviceIndexFile = options.serviceIndex === true \|\| options.serviceIndex == undefined ? 'services' : options.serviceIndex;`
	`40`	`+ this.serviceIndexFile = options.serviceIndex === true \|\| options.serviceIndex === undefined ? 'services' : options.serviceIndex;`
`41`	`41`	`}`
`42`	`42`	`if (options.modelIndex !== false && options.modelIndex !== '') {`
`43`		`- this.modelIndexFile = options.modelIndex === true \|\| options.modelIndex == undefined ? 'models' : options.modelIndex;`
	`43`	`+ this.modelIndexFile = options.modelIndex === true \|\| options.modelIndex === undefined ? 'models' : options.modelIndex;`
`44`	`44`	`}`
`45`	`45`	`}`
`46`	`46`