Fix missing type defs, add lint rules to catch it (#1072)

drwpow · web-flow · commit 1d8e76a52901 · 2023-04-07T10:44:36.000-06:00
diff --git a/package.json b/package.json
@@ -39,10 +39,11 @@
     "dev": "tsc -p tsconfig.build.json --watch",
     "download:schemas": "vite-node ./scripts/download-schemas.ts",
     "format": "npm run prettier -w .",
-    "lint": "eslint .",
+    "lint": "eslint \"src/**/*.{js,ts}\"",
     "prepare": "npm run build",
-    "test": "vitest run",
-    "test:coverage": "vitest run --coverage",
+    "test": "npm run test:ts && vitest run",
+    "test:ts": "tsc --noEmit",
+    "test:coverage": "npm run test:ts && vitest run --coverage",
     "update:examples": "vite-node ./scripts/update-examples.ts",
     "version": "npm run build"
   },
@@ -58,8 +59,8 @@
     "@types/degit": "^2.8.3",
     "@types/js-yaml": "^4.0.5",
     "@types/node": "^18.15.11",
-    "@typescript-eslint/eslint-plugin": "^5.57.0",
-    "@typescript-eslint/parser": "^5.57.0",
+    "@typescript-eslint/eslint-plugin": "^5.57.1",
+    "@typescript-eslint/parser": "^5.57.1",
     "@vitest/coverage-c8": "^0.29.8",
     "degit": "^2.8.4",
     "del-cli": "^5.0.0",
@@ -69,7 +70,7 @@
     "execa": "^6.1.0",
     "prettier": "^2.8.7",
     "typescript": "^5.0.3",
-    "vite": "^4.1.4",
+    "vite": "^4.2.1",
     "vite-node": "^0.29.8",
     "vitest": "^0.29.8"
   }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/index.ts b/src/index.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, OpenAPI3, OpenAPITSOptions, Subschema } from "./types";
+import type { GlobalContext, OpenAPI3, OpenAPITSOptions, Subschema } from "./types.js";
 import type { Readable } from "node:stream";
 import { URL } from "node:url";
 import load, { resolveSchema, VIRTUAL_JSON_URL } from "./load.js";
diff --git a/src/load.ts b/src/load.ts
@@ -11,7 +11,7 @@ import type {
   ResponseObject,
   SchemaObject,
   Subschema,
-} from "./types";
+} from "./types.js";
 import fs from "node:fs";
 import path from "node:path";
 import { Readable } from "node:stream";
diff --git a/src/transform/components-object.ts b/src/transform/components-object.ts
@@ -1,4 +1,4 @@
-import type { ComponentsObject, GlobalContext } from "../types";
+import type { ComponentsObject, GlobalContext } from "../types.js";
 import { escObjKey, getEntries, getSchemaObjectComment, indent, tsOptionalProperty, tsReadonly } from "../utils.js";
 import transformHeaderObject from "./header-object.js";
 import transformParameterObject from "./parameter-object.js";
diff --git a/src/transform/header-object.ts b/src/transform/header-object.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, HeaderObject } from "../types";
+import type { GlobalContext, HeaderObject } from "../types.js";
 import { escStr, getEntries, getSchemaObjectComment, indent, tsReadonly } from "../utils.js";
 import transformMediaTypeObject from "./media-type-object.js";
 import transformSchemaObject from "./schema-object.js";
diff --git a/src/transform/index.ts b/src/transform/index.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, OpenAPI3 } from "../types";
+import type { GlobalContext, OpenAPI3 } from "../types.js";
 import transformComponentsObject from "./components-object.js";
 import transformPathsObject from "./paths-object.js";
 import transformWebhooksObject from "./webhooks-object.js";
diff --git a/src/transform/media-type-object.ts b/src/transform/media-type-object.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, MediaTypeObject } from "../types";
+import type { GlobalContext, MediaTypeObject } from "../types.js";
 import transformSchemaObject from "./schema-object.js";
 
 export interface TransformMediaTypeObjectOptions {
diff --git a/src/transform/operation-object.ts b/src/transform/operation-object.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, OperationObject, ParameterObject } from "../types";
+import type { GlobalContext, OperationObject, ParameterObject } from "../types.js";
 import { escObjKey, getEntries, getSchemaObjectComment, indent, tsOptionalProperty, tsReadonly } from "../utils.js";
 import transformParameterObject from "./parameter-object.js";
 import transformRequestBodyObject from "./request-body-object.js";
diff --git a/src/transform/parameter-object-array.ts b/src/transform/parameter-object-array.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, ParameterObject, ReferenceObject } from "types";
+import type { GlobalContext, ParameterObject, ReferenceObject } from "../types.js";
 import { escObjKey, indent, tsOptionalProperty, tsReadonly } from "../utils.js";
 import transformParameterObject from "./parameter-object.js";
 
diff --git a/src/transform/parameter-object.ts b/src/transform/parameter-object.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, ParameterObject } from "types";
+import type { GlobalContext, ParameterObject } from "../types.js";
 import transformSchemaObject from "./schema-object.js";
 
 export interface TransformParameterObjectOptions {
diff --git a/src/transform/path-item-object.ts b/src/transform/path-item-object.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, ParameterObject, PathItemObject, ReferenceObject } from "../types";
+import type { GlobalContext, ParameterObject, PathItemObject, ReferenceObject } from "../types.js";
 import { escStr, getSchemaObjectComment, indent } from "../utils.js";
 import transformOperationObject from "./operation-object.js";
 
diff --git a/src/transform/paths-object.ts b/src/transform/paths-object.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, PathsObject } from "../types";
+import type { GlobalContext, PathsObject } from "../types.js";
 import { escStr, getEntries, indent } from "../utils.js";
 import transformParameterObject from "./parameter-object.js";
 import transformPathItemObject from "./path-item-object.js";
diff --git a/src/transform/request-body-object.ts b/src/transform/request-body-object.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, RequestBodyObject } from "../types";
+import type { GlobalContext, RequestBodyObject } from "../types.js";
 import { escStr, getEntries, getSchemaObjectComment, indent, tsReadonly } from "../utils.js";
 import transformMediaTypeObject from "./media-type-object.js";
 import transformSchemaObject from "./schema-object.js";
diff --git a/src/transform/response-object.ts b/src/transform/response-object.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, ResponseObject } from "../types";
+import type { GlobalContext, ResponseObject } from "../types.js";
 import {
   escObjKey,
   escStr,
diff --git a/src/transform/schema-object.ts b/src/transform/schema-object.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, ReferenceObject, SchemaObject } from "../types";
+import type { GlobalContext, ReferenceObject, SchemaObject } from "../types.js";
 import {
   escObjKey,
   escStr,
diff --git a/src/transform/webhooks-object.ts b/src/transform/webhooks-object.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, WebhooksObject } from "../types";
+import type { GlobalContext, WebhooksObject } from "../types.js";
 import { escStr, getEntries, indent } from "../utils.js";
 import transformPathItemObject from "./path-item-object.js";
 
diff --git a/src/types.ts b/src/types.ts
@@ -1,6 +1,6 @@
 import type { URL } from "node:url";
-import type { TransformSchemaObjectOptions } from "./transform/schema-object";
 import type { RequestInfo, RequestInit, Response } from "undici";
+import type { TransformSchemaObjectOptions } from "./transform/schema-object.js";
 
 export interface Extensable {
   [key: `x-${string}`]: any;
diff --git a/src/utils.ts b/src/utils.ts
@@ -2,7 +2,7 @@ import c from "ansi-colors";
 import { isAbsolute } from "node:path";
 import supportsColor from "supports-color";
 import { fetch as unidiciFetch } from "undici";
-import { Fetch } from "types";
+import type { Fetch } from "./types.js";
 
 // eslint-disable-next-line @typescript-eslint/no-unnecessary-boolean-literal-compare
 if (!supportsColor.stdout || supportsColor.stdout.hasBasic === false) c.enabled = false;
diff --git a/test/components-object.test.ts b/test/components-object.test.ts
@@ -1,4 +1,4 @@
-import type { ComponentsObject, GlobalContext } from "../src/types";
+import type { ComponentsObject, GlobalContext } from "../src/types.js";
 import transformComponentsObject from "../src/transform/components-object.js";
 
 const options: GlobalContext = {
diff --git a/test/header-object.test.ts b/test/header-object.test.ts
@@ -1,4 +1,4 @@
-import type { HeaderObject } from "../src/types";
+import type { HeaderObject } from "../src/types.js";
 import transformHeaderObject, { TransformHeaderObjectOptions } from "../src/transform/header-object.js";
 
 const options: TransformHeaderObjectOptions = {
@@ -12,6 +12,7 @@ const options: TransformHeaderObjectOptions = {
     immutableTypes: false,
     indentLv: 0,
     operations: {},
+    parameters: {},
     pathParamsAsTypes: false,
     postTransform: undefined,
     silent: true,
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -1,5 +1,5 @@
 import fs from "node:fs";
-import { OpenAPI3 } from "../src/types";
+import type { OpenAPI3 } from "../src/types.js";
 import openapiTS from "../dist/index.js";
 
 const BOILERPLATE = `/**
@@ -556,6 +556,7 @@ export type operations = Record<string, never>;
 
       test("transform", async () => {
         const generated = await openapiTS(schema, {
+          // @ts-expect-error
           transform(node) {
             if ("format" in node && node.format === "date-time") return "Date";
           },
@@ -586,6 +587,7 @@ export type operations = Record<string, never>;
       test("postTransform (with inject)", async () => {
         const inject = `type DateOrTime = Date | number;\n`;
         const generated = await openapiTS(schema, {
+          // @ts-expect-error
           postTransform(type, options) {
             if (options.path.includes("Date")) return "DateOrTime";
           },
diff --git a/test/load.test.ts b/test/load.test.ts
@@ -1,8 +1,8 @@
-import internalLoad, { type LoadOptions } from "../src/load.js";
-import type { Subschema } from "../src/types";
-import { Response, fetch as unidiciFetch } from "undici";
-import { Readable } from "node:stream";
 import { dump as stringifyYaml } from "js-yaml";
+import { Readable } from "node:stream";
+import { Response, fetch as unidiciFetch } from "undici";
+import internalLoad, { type LoadOptions } from "../src/load.js";
+import type { Subschema } from "../src/types.js";
 
 describe("Load", () => {
   describe("remote schema", () => {
@@ -112,6 +112,7 @@ async function load(
     immutableTypes: false,
     indentLv: 0,
     operations: {},
+    parameters: {},
     pathParamsAsTypes: false,
     postTransform: undefined,
     silent: true,
diff --git a/test/path-item-object.test.ts b/test/path-item-object.test.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, PathItemObject } from "../src/types";
+import type { GlobalContext, PathItemObject } from "../src/types.js";
 import transformPathItemObject, { TransformPathItemObjectOptions } from "../src/transform/path-item-object.js";
 
 const options: TransformPathItemObjectOptions = {
@@ -12,6 +12,7 @@ const options: TransformPathItemObjectOptions = {
     immutableTypes: false,
     indentLv: 0,
     operations: {},
+    parameters: {},
     pathParamsAsTypes: false,
     postTransform: undefined,
     silent: true,
diff --git a/test/paths-object.test.ts b/test/paths-object.test.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, PathsObject } from "../src/types";
+import type { GlobalContext, PathsObject } from "../src/types.js";
 import transformPathsObject from "../src/transform/paths-object.js";
 
 const options: GlobalContext = {
diff --git a/test/request-body-object.test.ts b/test/request-body-object.test.ts
@@ -1,5 +1,5 @@
 import transformRequestBodyObject, { TransformRequestBodyObjectOptions } from "../src/transform/request-body-object.js";
-import { RequestBodyObject } from "../src/types";
+import type { RequestBodyObject } from "../src/types.js";
 
 const options: TransformRequestBodyObjectOptions = {
   path: "#/test/request-body-object",
@@ -12,6 +12,7 @@ const options: TransformRequestBodyObjectOptions = {
     immutableTypes: false,
     indentLv: 0,
     operations: {},
+    parameters: {},
     pathParamsAsTypes: false,
     postTransform: undefined,
     silent: true,
diff --git a/test/schema-object.test.ts b/test/schema-object.test.ts
@@ -1,4 +1,4 @@
-import type { SchemaObject } from "../src/types";
+import type { SchemaObject } from "../src/types.js";
 import transformSchemaObject, { TransformSchemaObjectOptions } from "../src/transform/schema-object.js";
 
 const options: TransformSchemaObjectOptions = {
@@ -12,6 +12,7 @@ const options: TransformSchemaObjectOptions = {
     immutableTypes: false,
     indentLv: 0,
     operations: {},
+    parameters: {},
     pathParamsAsTypes: false,
     postTransform: undefined,
     silent: true,
diff --git a/test/utils.test.ts b/test/utils.test.ts
@@ -1,5 +1,4 @@
-import { tsUnionOf } from "../src/utils";
-import { tsIntersectionOf } from "../src/utils";
+import { tsIntersectionOf, tsUnionOf } from "../src/utils.js";
 
 describe("utils", () => {
   describe("tsUnionOf", () => {
diff --git a/test/webhooks-object.test.ts b/test/webhooks-object.test.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, WebhooksObject } from "../src/types";
+import type { GlobalContext, WebhooksObject } from "../src/types.js";
 import transformWebhooksObject from "../src/transform/webhooks-object.js";
 
 const options: GlobalContext = {
diff --git a/tsconfig.json b/tsconfig.json
@@ -6,7 +6,7 @@
     "forceConsistentCasingInFileNames": true,
     "lib": ["ESNext"],
     "module": "ESNext",
-    "moduleResolution": "Node",
+    "moduleResolution": "NodeNext",
     "noImplicitReturns": true,
     "outDir": "./dist",
     "removeComments": true,

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { GlobalContext, OpenAPI3, OpenAPITSOptions, Subschema } from "./types";`
	`1`	`+import type { GlobalContext, OpenAPI3, OpenAPITSOptions, Subschema } from "./types.js";`
`2`	`2`	`import type { Readable } from "node:stream";`
`3`	`3`	`import { URL } from "node:url";`
`4`	`4`	`import load, { resolveSchema, VIRTUAL_JSON_URL } from "./load.js";`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { ComponentsObject, GlobalContext } from "../types";`
	`1`	`+import type { ComponentsObject, GlobalContext } from "../types.js";`
`2`	`2`	`import { escObjKey, getEntries, getSchemaObjectComment, indent, tsOptionalProperty, tsReadonly } from "../utils.js";`
`3`	`3`	`import transformHeaderObject from "./header-object.js";`
`4`	`4`	`import transformParameterObject from "./parameter-object.js";`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { GlobalContext, HeaderObject } from "../types";`
	`1`	`+import type { GlobalContext, HeaderObject } from "../types.js";`
`2`	`2`	`import { escStr, getEntries, getSchemaObjectComment, indent, tsReadonly } from "../utils.js";`
`3`	`3`	`import transformMediaTypeObject from "./media-type-object.js";`
`4`	`4`	`import transformSchemaObject from "./schema-object.js";`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { GlobalContext, OpenAPI3 } from "../types";`
	`1`	`+import type { GlobalContext, OpenAPI3 } from "../types.js";`
`2`	`2`	`import transformComponentsObject from "./components-object.js";`
`3`	`3`	`import transformPathsObject from "./paths-object.js";`
`4`	`4`	`import transformWebhooksObject from "./webhooks-object.js";`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { GlobalContext, MediaTypeObject } from "../types";`
	`1`	`+import type { GlobalContext, MediaTypeObject } from "../types.js";`
`2`	`2`	`import transformSchemaObject from "./schema-object.js";`
`3`	`3`
`4`	`4`	`export interface TransformMediaTypeObjectOptions {`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { GlobalContext, OperationObject, ParameterObject } from "../types";`
	`1`	`+import type { GlobalContext, OperationObject, ParameterObject } from "../types.js";`
`2`	`2`	`import { escObjKey, getEntries, getSchemaObjectComment, indent, tsOptionalProperty, tsReadonly } from "../utils.js";`
`3`	`3`	`import transformParameterObject from "./parameter-object.js";`
`4`	`4`	`import transformRequestBodyObject from "./request-body-object.js";`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { GlobalContext, ParameterObject, ReferenceObject } from "types";`
	`1`	`+import type { GlobalContext, ParameterObject, ReferenceObject } from "../types.js";`
`2`	`2`	`import { escObjKey, indent, tsOptionalProperty, tsReadonly } from "../utils.js";`
`3`	`3`	`import transformParameterObject from "./parameter-object.js";`
`4`	`4`