Tighten lint rules (#1045)

Author: drwpow

.eslintrc.cjs

@@ -4,8 +4,14 @@ module.exports = {
   parserOptions: {
     project: ["./tsconfig.json"],
   },
-  extends: ["plugin:prettier/recommended", "eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  extends: ["plugin:prettier/recommended", "eslint:recommended", "plugin:@typescript-eslint/strict"],
   plugins: ["@typescript-eslint"],
+  rules: {
+    "@typescript-eslint/consistent-indexed-object-style": "off", // sometimes naming keys is more user-friendly
+    "@typescript-eslint/no-dynamic-delete": "off", // delete is OK
+    "@typescript-eslint/no-unnecessary-condition": "off", // this gives bad advice
+    "no-unused-vars": "off",
+  },
   overrides: [
     {
       files: ["**/*.test.*"],

package.json

@@ -60,7 +60,7 @@
     "@types/node": "^18.15.0",
     "@typescript-eslint/eslint-plugin": "^5.54.1",
     "@typescript-eslint/parser": "^5.54.1",
-    "@vitest/coverage-c8": "^0.28.5",
+    "@vitest/coverage-c8": "^0.29.2",
     "degit": "^2.8.4",
     "del-cli": "^5.0.0",
     "eslint": "^8.35.0",
@@ -69,7 +69,7 @@
     "execa": "^6.1.0",
     "prettier": "^2.8.4",
     "typescript": "^4.9.5",
-    "vite-node": "^0.28.5",
-    "vitest": "^0.28.5"
+    "vite-node": "^0.29.2",
+    "vitest": "^0.29.2"
   }
 }

pnpm-lock.yaml

@@ -39,23 +39,23 @@ async function openapiTS(
   options: OpenAPITSOptions = {} as Partial<OpenAPITSOptions>
 ): Promise<string> {
   const ctx: GlobalContext = {
-    additionalProperties: options.additionalProperties || false,
-    alphabetize: options.alphabetize || false,
-    defaultNonNullable: options.defaultNonNullable || false,
+    additionalProperties: options.additionalProperties ?? false,
+    alphabetize: options.alphabetize ?? false,
+    defaultNonNullable: options.defaultNonNullable ?? false,
     discriminators: {},
-    transform: options && typeof options.transform === "function" ? options.transform : undefined,
-    postTransform: options && typeof options.postTransform === "function" ? options.postTransform : undefined,
-    immutableTypes: options.immutableTypes || false,
-    emptyObjectsUnknown: options.emptyObjectsUnknown || false,
+    transform: typeof options.transform === "function" ? options.transform : undefined,
+    postTransform: typeof options.postTransform === "function" ? options.postTransform : undefined,
+    immutableTypes: options.immutableTypes ?? false,
+    emptyObjectsUnknown: options.emptyObjectsUnknown ?? false,
     indentLv: 0,
     operations: {},
-    pathParamsAsTypes: options.pathParamsAsTypes || false,
-    silent: options.silent || false,
-    supportArrayLength: options.supportArrayLength || false,
+    pathParamsAsTypes: options.pathParamsAsTypes ?? false,
+    silent: options.silent ?? false,
+    supportArrayLength: options.supportArrayLength ?? false,
   };
 
   // note: we may be loading many large schemas into memory at once; take care to reuse references without cloning
-  const isInlineSchema = typeof schema !== "string" && schema instanceof URL == false;
+  const isInlineSchema = typeof schema !== "string" && schema instanceof URL === false; // eslint-disable-line @typescript-eslint/no-unnecessary-boolean-literal-compare
 
   // 1. load schema (and subschemas)
   const allSchemas: { [id: string]: Subschema } = {};
@@ -90,7 +90,7 @@ async function openapiTS(
   const output: string[] = [];
 
   // 2a. Start file, inject custom code (if any)
-  if (options && "commentHeader" in options) {
+  if ("commentHeader" in options) {
     if (options.commentHeader) output.push(options.commentHeader);
   } else {
     output.push(COMMENT_HEADER);

src/index.ts

@@ -19,7 +19,9 @@ import yaml from "js-yaml";
 import type { Dispatcher } from "undici";
 import { parseRef, error, makeTSIndex, walk, isRemoteURL, isFilepath } from "./utils.js";
 
-type SchemaMap = { [id: string]: Subschema };
+interface SchemaMap {
+  [id: string]: Subschema;
+}
 
 export const VIRTUAL_JSON_URL = `file:///_json`; // fake URL reserved for dynamic JSON
 
@@ -109,7 +111,7 @@ export default async function load(
   // 1. load contents
   // 1a. URL
   if (schema instanceof URL) {
-    const hint = options.hint || "OpenAPI3";
+    const hint = options.hint ?? "OpenAPI3";
 
     // normalize ID
     if (schema.href !== options.rootURL.href) schemaID = relativePath(options.rootURL, schema);
@@ -136,12 +138,12 @@ export default async function load(
         headers,
       });
       const contentType = res.headers.get("content-type");
-      if (ext === ".json" || (contentType && contentType.includes("json"))) {
+      if (ext === ".json" || contentType?.includes("json")) {
         options.schemas[schemaID] = {
           hint,
           schema: parseJSON(await res.text()),
         };
-      } else if (ext === ".yaml" || ext === ".yml" || (contentType && contentType.includes("yaml"))) {
+      } else if (ext === ".yaml" || ext === ".yml" || contentType?.includes("yaml")) {
         options.schemas[schemaID] = {
           hint,
           schema: parseYAML(await res.text()),
@@ -180,7 +182,7 @@ export default async function load(
     // if file starts with '{' assume JSON
     options.schemas[schemaID] = {
       hint: "OpenAPI3",
-      schema: contents.charAt(0) === "{" ? parseJSON(contents) : parseYAML(contents),
+      schema: contents.startsWith("{") ? parseJSON(contents) : parseYAML(contents),
     };
   }
   // 1c. inline

src/load.ts

@@ -65,7 +65,7 @@ export default function transformOperationObject(
             const parts = parseTSIndex(p.$ref);
             const paramI = parts.indexOf("parameters");
             if (paramI === -1 || parts[paramI + 1] !== paramIn || !parts[paramI + 2]) continue;
-            const key = parts.pop() as string;
+            const key = parts.pop()!;
             const index = makeTSIndex(parts);
             if (!refs[index]) refs[index] = [key];
             else refs[index].push(key);

src/transform/operation-object.ts

@@ -42,7 +42,7 @@ export default function transformPathItemObject(
   }
 
   // parameters
-  if (pathItem.parameters && pathItem.parameters.length) {
+  if (pathItem.parameters?.length) {
     output.push(
       indent(
         transformOperationObject({ parameters: pathItem.parameters }, { path, ctx, wrapObject: false }).trim(),

src/transform/path-item-object.ts

@@ -144,7 +144,7 @@ export function defaultSchemaObjectTransform(
           return ctx.immutableTypes || schemaObject.readOnly ? tsReadonly(itemType) : itemType;
         } else {
           return tsUnionOf(
-            ...Array.from({ length: (maxItems || 0) - minItems + 1 })
+            ...Array.from({ length: (maxItems ?? 0) - minItems + 1 })
               .map((_, i) => i + minItems)
               .map((n) => {
                 const t = tsTupleOf(...Array.from({ length: n }).map(() => itemType));
@@ -169,7 +169,7 @@ export function defaultSchemaObjectTransform(
     ("additionalProperties" in schemaObject && schemaObject.additionalProperties)
   ) {
     indentLv++;
-    for (const [k, v] of getEntries(schemaObject.properties || {}, ctx.alphabetize)) {
+    for (const [k, v] of getEntries(schemaObject.properties ?? {}, ctx.alphabetize)) {
       const c = getSchemaObjectComment(v, indentLv);
       if (c) coreType.push(indent(c, indentLv));
       let key = escObjKey(k);
@@ -204,11 +204,11 @@ export function defaultSchemaObjectTransform(
     );
     if (discriminatorRef) {
       const discriminator = ctx.discriminators[discriminatorRef.$ref];
-      let value = parseRef(path).path.pop() as string;
+      let value = parseRef(path).path.pop()!;
       if (discriminator.mapping) {
         // Mapping value can either be a fully-qualified ref (#/components/schemas/XYZ) or a schema name (XYZ)
         const matchedValue = Object.entries(discriminator.mapping).find(
-          ([_, v]) => (v[0] !== "#" && v === value) || (v[0] === "#" && parseRef(v).path.pop() === value)
+          ([_, v]) => (!v.startsWith("#") && v === value) || (v.startsWith("#") && parseRef(v).path.pop() === value)
         );
         if (matchedValue) value = matchedValue[0]; // why was this designed backwards!?
       }