Tighten lint rules (#947)

* tighten lint rules

* update Ubuntu runner

Author: drwpow

.eslintrc.cjs

@@ -1,14 +1,5 @@
 module.exports = {
   parser: "@typescript-eslint/parser",
-  extends: ["plugin:@typescript-eslint/recommended", "prettier"],
-  plugins: ["@typescript-eslint", "prettier"],
-  rules: {
-    "@typescript-eslint/camelcase": "off",
-    "@typescript-eslint/explicit-module-boundary-types": "off",
-    "@typescript-eslint/no-explicit-any": "off", // in a foreign schema, sometimes we need “any”
-    "@typescript-eslint/no-use-before-define": "off",
-    "@typescript-eslint/no-var-requires": "off",
-    "prettier/prettier": "error",
-    "prefer-const": "off",
-  },
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+  plugins: ["@typescript-eslint"],
 };

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on:
 
 jobs:
   lint:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v3
       - uses: pnpm/action-setup@v2
@@ -18,7 +18,7 @@ jobs:
     strategy:
       matrix:
         node-version: [16.x, 18.x]
-        os: [macos-12, ubuntu-latest, windows-latest]
+        os: [macos-12, ubuntu-22.04, windows-2022]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3

package.json

@@ -2,10 +2,6 @@
   "name": "openapi-typescript",
   "description": "Generate TypeScript types from Swagger OpenAPI specs",
   "version": "5.4.0",
-  "engines": {
-    "node": ">= 14.0.0",
-    "npm": ">= 7.0.0"
-  },
   "author": "[email protected]",
   "license": "MIT",
   "bin": {

src/index.ts

@@ -57,7 +57,7 @@ async function openapiTS(
 
   // 1. load schema
   let rootSchema: Record<string, any> = {};
-  let external: Record<string, Record<string, any>> = {};
+  const external: Record<string, Record<string, any>> = {};
   const allSchemas: Record<string, Record<string, any>> = {};
   const schemaURL: URL = typeof schema === "string" ? resolveSchema(schema) : (schema as URL);
 

src/load.ts

@@ -103,7 +103,7 @@ export default async function load(
 
   // if this is dynamically-passed-in JSON, we’ll have to change a few things
   const isJSON = schema instanceof URL == false && schema instanceof Readable == false;
-  let schemaID = isJSON || schema instanceof Readable ? new URL(VIRTUAL_JSON_URL).href : (schema.href as string);
+  const schemaID = isJSON || schema instanceof Readable ? new URL(VIRTUAL_JSON_URL).href : (schema.href as string);
 
   const schemas = options.schemas;
 

src/transform/index.ts

@@ -9,10 +9,8 @@ import { transformSchemaObjMap } from "./schema.js";
 
 export function transformAll(schema: any, ctx: GlobalContext): Record<string, string> {
   const readonly = tsReadonly(ctx.immutableTypes);
-
-  let output: Record<string, string> = {};
-
-  let operations: Record<string, { operation: OperationObject; pathItem: PathItemObject }> = {};
+  const output: Record<string, string> = {};
+  const operations: Record<string, { operation: OperationObject; pathItem: PathItemObject }> = {};
 
   // --raw-schema mode
   if (ctx.rawSchema) {

src/transform/parameters.ts

@@ -18,7 +18,7 @@ export function transformParametersArray(
   let output = "";
 
   // sort into map
-  let mappedParams: Record<string, Record<string, ParameterObject>> = {};
+  const mappedParams: Record<string, Record<string, ParameterObject>> = {};
   for (const paramObj of parameters as any[]) {
     if (paramObj.$ref && globalParameters) {
       const paramName = paramObj.$ref.split('["').pop().replace(PARAM_END_RE, ""); // take last segment

src/transform/schema.ts

@@ -18,7 +18,7 @@ interface TransformSchemaObjOptions extends GlobalContext {
 const EOF_RE = /\n+$/;
 
 function hasDefaultValue(node: any): boolean {
-  if (node.hasOwnProperty("default")) return true;
+  if ("default" in node) return true;
   // if (node.hasOwnProperty("$ref")) return true; // TODO: resolve remote $refs?
   return false;
 }
@@ -161,7 +161,7 @@ export function transformSchemaObj(node: any, options: TransformSchemaObjOptions
           break;
         }
 
-        let properties = transformSchemaObjMap(node.properties || {}, {
+        const properties = transformSchemaObjMap(node.properties || {}, {
           ...options,
           required: new Set(node.required || []),
         });

src/utils.ts

@@ -17,9 +17,9 @@ const COMMENT_RE = /\*\//g;
 const LB_RE = /\r?\n/g;
 const DOUBLE_QUOTE_RE = /"/g;
 const SINGLE_QUOTE_RE = /'/g;
-const ESC_0_RE = /\~0/g;
-const ESC_1_RE = /\~1/g;
-const TILDE_RE = /\~/g;
+const ESC_0_RE = /~0/g;
+const ESC_1_RE = /~1/g;
+const TILDE_RE = /~/g;
 const FS_RE = /\//g;
 
 /**
@@ -155,7 +155,7 @@ export function nodeType(obj: any): SchemaObjectType {
   }
 
   // Treat any node with allOf/ anyOf/ oneOf as object
-  if (obj.hasOwnProperty("allOf") || obj.hasOwnProperty("anyOf") || obj.hasOwnProperty("oneOf")) {
+  if ("allOf" in obj || "anyOf" in obj || "oneOf" in obj) {
     return "object";
   }
 
@@ -196,7 +196,7 @@ export function nodeType(obj: any): SchemaObjectType {
   }
 
   // object
-  if (obj.type === "object" || obj.hasOwnProperty("properties") || obj.hasOwnProperty("additionalProperties")) {
+  if (obj.type === "object" || "properties" in obj || "additionalProperties" in obj) {
     return "object";
   }
 

test/core/operation.test.js

@@ -1,4 +1,5 @@
 import { expect } from "chai";
+import { describe, it } from "mocha";
 import { transformOperationObj } from "../../dist/transform/operation.js";
 
 const defaults = {