Remove @pika/pack (#509)

drwpow · web-flow · commit b5bfe4d7cdb9 · 2021-03-06T22:52:39.000-07:00
😢
diff --git a/.gitignore b/.gitignore
@@ -2,7 +2,7 @@
 .DS_Store
 **/generated/*.ts
 coverage
-pkg
+dist
 node_modules
 yarn.lock
 yarn-error.log
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -51,7 +51,7 @@ If you’ve added a feature or fixed a bug and need to update the generated sche
 # 1. re-build the package
 npm run build
 # 2. run the local CLI (not the npm one!)
-pkg/bin/cli.js tests/v3/specs/github.yaml -o tests/v3/expected/github.ts
+./bin/cli.js tests/v3/specs/github.yaml -o tests/v3/expected/github.ts
 ```
 
 This should update the expected TypeScript definiton.
diff --git a/bin/cli.js b/bin/cli.js
@@ -4,7 +4,7 @@ const fs = require("fs");
 const { bold, green, red } = require("kleur");
 const path = require("path");
 const meow = require("meow");
-const { default: swaggerToTS } = require("../dist-node");
+const { default: swaggerToTS } = require("../dist/cjs/index.js");
 const { loadSpec } = require("./loaders");
 
 const cli = meow(
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,14 +1,29 @@
 {
   "name": "openapi-typescript",
   "description": "Generate TypeScript types from Swagger OpenAPI specs",
-  "main": "dist/cjs",
   "version": "3.0.4",
   "engines": {
     "node": ">= 10.0.0"
   },
+  "author": "drew@pow.rs",
+  "license": "ISC",
   "bin": {
     "openapi-typescript": "bin/cli.js"
   },
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "exports": {
+    "browser": "./dist/esm/index.js",
+    "import": "./dist/esm/index.js",
+    "require": "./dist/cjs/index.js"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "src",
+    "types"
+  ],
+  "types": "./types/index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/drwpow/openapi-typescript"
@@ -24,33 +39,12 @@
     "openapi 3",
     "node"
   ],
-  "author": "drew@pow.rs",
-  "license": "ISC",
   "bugs": {
     "url": "https://github.com/drwpow/openapi-typescript/issues"
   },
   "homepage": "https://github.com/drwpow/openapi-typescript#readme",
-  "@pika/pack": {
-    "pipeline": [
-      [
-        "@pika/plugin-ts-standard-pkg"
-      ],
-      [
-        "@pika/plugin-build-node"
-      ],
-      [
-        "@pika/plugin-copy-assets",
-        {
-          "files": [
-            "bin/"
-          ]
-        }
-      ]
-    ]
-  },
   "scripts": {
-    "build": "pika-pack build",
-    "deploy": "npm run build && pika publish",
+    "build": "rm -rf dist && tsc --build tsconfig.json && tsc --build tsconfig.cjs.json",
     "format": "yarn prettier -w .",
     "lint": "eslint --ignore-path .gitignore --ext .js,.ts src",
     "pregenerate": "npm run build",
@@ -67,13 +61,8 @@
     "prettier": "^2.2.1"
   },
   "devDependencies": {
-    "@pika/pack": "^0.5.0",
-    "@pika/plugin-build-node": "^0.9.2",
-    "@pika/plugin-copy-assets": "^0.9.2",
-    "@pika/plugin-ts-standard-pkg": "^0.9.2",
     "@types/jest": "^26.0.14",
     "@types/js-yaml": "^4.0.0",
-    "@types/prettier": "^2.1.5",
     "@typescript-eslint/eslint-plugin": "^4.4.1",
     "@typescript-eslint/parser": "^4.4.1",
     "codecov": "^3.8.1",
diff --git a/src/index.ts b/src/index.ts
@@ -2,8 +2,6 @@ import path from "path";
 import prettier from "prettier";
 import { swaggerVersion } from "./utils";
 import { transformAll } from "./transform/index";
-import { OpenAPI2, OpenAPI3, SchemaObject, SwaggerToTSOptions } from "./types/index";
-export * from "./types/index";
 
 export const WARNING_MESSAGE = `/**
 * This file was auto-generated by openapi-typescript.
diff --git a/src/transform/headers.ts b/src/transform/headers.ts
@@ -1,5 +1,4 @@
 import { comment } from "../utils";
-import { HeaderObject } from "../types";
 import { transformSchemaObj } from "./schema";
 
 export function transformHeaderObjMap(headerMap: Record<string, HeaderObject>): string {
diff --git a/src/transform/index.ts b/src/transform/index.ts
@@ -1,4 +1,3 @@
-import { OperationObject } from "../types";
 import { comment } from "../utils";
 import { transformHeaderObjMap } from "./headers";
 import { transformOperationObj } from "./operation";
diff --git a/src/transform/operation.ts b/src/transform/operation.ts
@@ -1,4 +1,3 @@
-import { OperationObject, ParameterObject, RequestBody } from "../types";
 import { comment, isRef, transformRef } from "../utils";
 import { transformParametersArray } from "./parameters";
 import { transformResponsesObj } from "./responses";
diff --git a/src/transform/parameters.ts b/src/transform/parameters.ts
@@ -1,5 +1,4 @@
 import { transformSchemaObj } from "./schema";
-import { ParameterObject, ReferenceObject } from "../types";
 import { comment } from "../utils";
 
 export function transformParametersArray(
diff --git a/src/transform/paths.ts b/src/transform/paths.ts
@@ -1,4 +1,3 @@
-import { OperationObject, ParameterObject, PathItemObject } from "../types/index";
 import { comment, transformRef } from "../utils";
 import { transformOperationObj } from "./operation";
 import { transformParametersArray } from "./parameters";
diff --git a/src/transform/responses.ts b/src/transform/responses.ts
@@ -2,7 +2,6 @@ import { comment, transformRef } from "../utils";
 import { transformHeaderObjMap } from "./headers";
 import { transformSchemaObj } from "./schema";
 import { transformRequestBodyObj } from "./operation";
-import { RequestBody } from "../types";
 
 const resType = (res: string | number) => (res === 204 || (res >= 300 && res < 400) ? "never" : "unknown");
 
diff --git a/src/utils.ts b/src/utils.ts
@@ -1,5 +1,3 @@
-import { OpenAPI2, OpenAPI3, ReferenceObject } from "./types";
-
 export function comment(text: string): string {
   const commentText = text.trim();
 
diff --git a/tests/bin/cli.test.ts b/tests/bin/cli.test.ts
@@ -9,7 +9,7 @@ describe("cli", () => {
   it("--prettier-config (JSON)", () => {
     const expected = fs.readFileSync(path.join(__dirname, "expected", "prettier-json.ts"), "utf8");
     execSync(
-      `../../pkg/bin/cli.js specs/petstore.yaml -o generated/prettier-json.ts --prettier-config fixtures/.prettierrc`,
+      `../../bin/cli.js specs/petstore.yaml -o generated/prettier-json.ts --prettier-config fixtures/.prettierrc`,
       { cwd: __dirname }
     );
     const output = fs.readFileSync(path.join(__dirname, "generated", "prettier-json.ts"), "utf8");
@@ -19,7 +19,7 @@ describe("cli", () => {
   it("--prettier-config (.js)", () => {
     const expected = fs.readFileSync(path.join(__dirname, "expected", "prettier-js.ts"), "utf8");
     execSync(
-      `../../pkg/bin/cli.js specs/petstore.yaml -o generated/prettier-js.ts --prettier-config fixtures/prettier.config.js`,
+      `../../bin/cli.js specs/petstore.yaml -o generated/prettier-js.ts --prettier-config fixtures/prettier.config.js`,
       { cwd: __dirname }
     );
     const output = fs.readFileSync(path.join(__dirname, "generated", "prettier-js.ts"), "utf8");
@@ -28,7 +28,7 @@ describe("cli", () => {
 
   it("stdout", () => {
     const expected = fs.readFileSync(path.join(__dirname, "expected", "stdout.ts"), "utf8");
-    const result = execSync(`../../pkg/bin/cli.js specs/petstore.yaml`, { cwd: __dirname });
+    const result = execSync(`../../bin/cli.js specs/petstore.yaml`, { cwd: __dirname });
     expect(result.toString("utf8")).toBe(expected);
   });
 });
diff --git a/tests/v2/index.test.ts b/tests/v2/index.test.ts
@@ -9,7 +9,7 @@ describe("cli", () => {
   schemas.forEach((schema) => {
     const output = schema.replace(/\ya?ml$/i, "ts");
     it(`reads ${schema} spec (v2) from file`, () => {
-      execSync(`../../pkg/bin/cli.js specs/${schema} -o generated/${output}`, {
+      execSync(`../../bin/cli.js specs/${schema} -o generated/${output}`, {
         cwd: __dirname,
       });
       const expected = fs.readFileSync(path.join(__dirname, "expected", output), "utf8");
@@ -20,7 +20,7 @@ describe("cli", () => {
 
   it("reads spec (v2) from remote resource", () => {
     execSync(
-      "../../pkg/bin/cli.js https://raw.githubusercontent.com/drwpow/openapi-typescript/main/tests/v2/specs/manifold.yaml -o generated/http.ts",
+      "../../bin/cli.js https://raw.githubusercontent.com/drwpow/openapi-typescript/main/tests/v2/specs/manifold.yaml -o generated/http.ts",
       {
         cwd: __dirname,
       }
diff --git a/tests/v3/index.test.ts b/tests/v3/index.test.ts
@@ -8,7 +8,7 @@ describe("cli", () => {
   schemas.forEach((schema) => {
     const output = schema.replace(/\ya?ml$/i, "ts");
     it(`reads ${schema} spec (v3) from file`, () => {
-      execSync(`../../pkg/bin/cli.js specs/${schema} -o generated/${output}`, {
+      execSync(`../../bin/cli.js specs/${schema} -o generated/${output}`, {
         cwd: __dirname,
       });
       const expected = fs.readFileSync(path.join(__dirname, "expected", output), "utf8");
@@ -19,7 +19,7 @@ describe("cli", () => {
 
   it("reads spec (v3) from remote resource", () => {
     execSync(
-      "../../pkg/bin/cli.js https://raw.githubusercontent.com/drwpow/openapi-typescript/main/tests/v3/specs/manifold.yaml -o generated/http.ts",
+      "../../bin/cli.js https://raw.githubusercontent.com/drwpow/openapi-typescript/main/tests/v3/specs/manifold.yaml -o generated/http.ts",
       {
         cwd: __dirname,
       }
diff --git a/tsconfig.cjs.json b/tsconfig.cjs.json
@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "baseUrl": "./src",
+    "declaration": true,
+    "esModuleInterop": true,
+    "lib": ["ESNext"],
+    "module": "CommonJS",
+    "moduleResolution": "node",
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noUnusedLocals": true,
+    "outDir": "./dist/cjs",
+    "removeComments": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "target": "ES2018"
+  },
+  "include": ["src", "types"],
+  "exclude": ["examples/*", "tests/**/*"]
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -3,19 +3,19 @@
     "baseUrl": "./src",
     "declaration": true,
     "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
     "lib": ["ESNext"],
     "module": "ESNext",
     "moduleResolution": "node",
     "noImplicitAny": true,
     "noImplicitReturns": true,
     "noUnusedLocals": true,
-    "outDir": "dist",
+    "outDir": "./dist/esm",
     "removeComments": true,
     "skipLibCheck": true,
     "sourceMap": true,
     "strict": true,
     "target": "ES2020"
   },
+  "include": ["src", "types"],
   "exclude": ["examples/*", "tests/**/*"]
 }
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1,12 +1,12 @@
-export interface OpenAPI2 {
+declare interface OpenAPI2 {
   swagger: string; // required
   paths?: Record<string, PathItemObject>;
   definitions?: Record<string, SchemaObject>;
   parameters?: ParameterObject[];
   responses?: Record<string, ResponseObject>; // required
 }
 
-export interface OpenAPI3 {
+declare interface OpenAPI3 {
   openapi: string; // required
   paths?: Record<string, PathItemObject>; // required
   components?: {
@@ -19,15 +19,15 @@ export interface OpenAPI3 {
   };
 }
 
-export interface HeaderObject {
+declare interface HeaderObject {
   // note: this extends ParameterObject, minus "name" & "in"
   type?: string; // required
   description?: string;
   required?: boolean;
   schema: ReferenceObject | SchemaObject;
 }
 
-export interface PathItemObject {
+declare interface PathItemObject {
   $ref?: string;
   summary?: string;
   description?: string;
@@ -42,15 +42,15 @@ export interface PathItemObject {
   parameters?: (ReferenceObject | ParameterObject)[];
 }
 
-export interface LinkObject {
+declare interface LinkObject {
   operationRef?: string;
   operationId?: string;
   parameters?: (ReferenceObject | ParameterObject)[];
   requestBody?: RequestBody;
   description?: string;
 }
 
-export interface OperationObject {
+declare interface OperationObject {
   description?: string;
   tags?: string[]; // unused
   summary?: string; // unused
@@ -60,7 +60,7 @@ export interface OperationObject {
   responses?: Record<string, ReferenceObject | ResponseObject>; // required
 }
 
-export interface ParameterObject {
+declare interface ParameterObject {
   name?: string; // required
   in?: "query" | "header" | "path" | /* V3 */ "cookie" | /* V2 */ "formData" | /* V2 */ "body"; // required
   description?: string;
@@ -69,9 +69,9 @@ export interface ParameterObject {
   schema?: ReferenceObject | SchemaObject; // required
 }
 
-export type ReferenceObject = { $ref: string };
+declare type ReferenceObject = { $ref: string };
 
-export interface ResponseObject {
+declare interface ResponseObject {
   description?: string;
   headers?: Record<string, ReferenceObject | HeaderObject>;
   schema?: ReferenceObject | SchemaObject; // V2 ONLY
@@ -82,14 +82,14 @@ export interface ResponseObject {
   };
 }
 
-export interface RequestBody {
+declare interface RequestBody {
   description?: string;
   content?: {
     [contentType: string]: { schema: ReferenceObject | SchemaObject };
   };
 }
 
-export interface SchemaObject {
+declare interface SchemaObject {
   title?: string; // ignored
   description?: string;
   required?: string[];
@@ -104,7 +104,7 @@ export interface SchemaObject {
   anyOf?: (ReferenceObject | SchemaObject)[]; // V3 ONLY
 }
 
-export interface SwaggerToTSOptions {
+declare interface SwaggerToTSOptions {
   /** (optional) Path to Prettier config */
   prettierConfig?: string;
   /** (optional) Parsing input document as raw schema rather than OpenAPI document */

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`import { comment } from "../utils";`
`2`		`-import { HeaderObject } from "../types";`
`3`	`2`	`import { transformSchemaObj } from "./schema";`
`4`	`3`
`5`	`4`	`export function transformHeaderObjMap(headerMap: Record<string, HeaderObject>): string {`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-import { OperationObject } from "../types";`
`2`	`1`	`import { comment } from "../utils";`
`3`	`2`	`import { transformHeaderObjMap } from "./headers";`
`4`	`3`	`import { transformOperationObj } from "./operation";`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-import { OperationObject, ParameterObject, RequestBody } from "../types";`
`2`	`1`	`import { comment, isRef, transformRef } from "../utils";`
`3`	`2`	`import { transformParametersArray } from "./parameters";`
`4`	`3`	`import { transformResponsesObj } from "./responses";`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`import { transformSchemaObj } from "./schema";`
`2`		`-import { ParameterObject, ReferenceObject } from "../types";`
`3`	`2`	`import { comment } from "../utils";`
`4`	`3`
`5`	`4`	`export function transformParametersArray(`