fix(build): use typescript to produce declaration files (#550)

kfcampbell · wolfy1339 · web-flow · commit 9953e34db63d · 2023-06-13T17:27:12.000-04:00
Co-authored-by: wolfy1339 &lt;4595477+wolfy1339@users.noreply.github.com&gt;
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -15,7 +15,8 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
           cache: npm
       - run: npm ci
+      - run: npm run build
       - run: npm test
diff --git a/.github/workflows/update.yml b/.github/workflows/update.yml
@@ -11,7 +11,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: "lts/*"
           cache: npm
       - run: git checkout routes-update || true
       - run: npm install @octokit/openapi-types@latest
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -9,7 +9,7 @@
     "@octokit/openapi-types": "^18.0.0"
   },
   "scripts": {
-    "build": "pika-pack build",
+    "build": "node scripts/build.mjs && tsc -p tsconfig.json",
     "docs": "typedoc --readme none --out docs src/index.ts && touch docs/.nojekyll",
     "lint": "prettier --check \"{src,test,scripts}/**/*.{js,ts,json}\" README.md package.json !src/generated/* !scripts/update-endpoints/generated/*",
     "lint:fix": "prettier --write \"{src,test,scripts}/**/*.{js,ts,json}\" README.md package.json !src/generated/* !scripts/update-endpoints/generated/*",
@@ -31,18 +31,14 @@
   "author": "Gregor Martynus (https://twitter.com/gr2m)",
   "license": "MIT",
   "devDependencies": {
-    "@pika/pack": "^0.3.7",
-    "@pika/plugin-build-node": "^0.9.0",
-    "@pika/plugin-build-web": "^0.9.0",
-    "@pika/plugin-ts-standard-pkg": "^0.9.0",
+    "@octokit/tsconfig": "^1.0.2",
     "@types/node": ">= 8",
     "github-openapi-graphql-query": "^4.0.0",
     "handlebars": "^4.7.6",
     "json-schema-to-typescript": "^13.0.0",
     "lodash.set": "^4.3.2",
     "npm-run-all": "^4.1.5",
     "pascal-case": "^3.1.1",
-    "pika-plugin-merge-properties": "^1.0.6",
     "prettier": "^2.0.0",
     "semantic-release": "^21.0.0",
     "semantic-release-plugin-update-version-in-files": "^1.0.0",
@@ -51,27 +47,6 @@
     "typedoc": "^0.24.0",
     "typescript": "^5.0.0"
   },
-  "@pika/pack": {
-    "pipeline": [
-      [
-        "@pika/plugin-ts-standard-pkg"
-      ],
-      [
-        "pika-plugin-merge-properties",
-        {
-          "properties": {
-            "octokit": "see https://github.com/jabuco/pika-plugin-merge-properties/issues/2"
-          }
-        }
-      ],
-      [
-        "@pika/plugin-build-node"
-      ],
-      [
-        "@pika/plugin-build-web"
-      ]
-    ]
-  },
   "release": {
     "branches": [
       "+([0-9]).x",
diff --git a/scripts/build.mjs b/scripts/build.mjs
@@ -0,0 +1,34 @@
+import { copyFile, readFile, writeFile, rm, mkdir } from "node:fs/promises";
+
+
+async function main() {
+	// Start with a clean slate
+	await rm("pkg", { recursive: true, force: true });
+	await mkdir("pkg");
+
+	// Copy the README, LICENSE to the pkg folder
+	await copyFile("LICENSE", "pkg/LICENSE");
+	await copyFile("README.md", "pkg/README.md");
+
+	// Handle the package.json
+	let pkg = JSON.parse((await readFile("package.json", "utf8")).toString());
+	// Remove unnecessary fields from the package.json
+	delete pkg.scripts;
+	delete pkg.prettier;
+	delete pkg.release;
+	delete pkg.jest;
+	await writeFile(
+		"pkg/package.json",
+		JSON.stringify(
+			{
+				...pkg,
+				files: ["dist-types/**"],
+				types: "dist-types/index.d.ts",
+				sideEffects: false,
+			},
+			null,
+			2
+		)
+	);
+}
+main();
diff --git a/test.ts b/test.ts
@@ -8,9 +8,9 @@ import {
 } from "./src";
 
 const endpoint = {} as EndpointInterface;
-function assertString(type: string) {}
-function assertNullableString(type: string | null | undefined) {}
-function assertArray(type: unknown[]) {}
+function assertString(_: string) {}
+function assertNullableString(_: string | null | undefined) {}
+function assertArray(_: unknown[]) {}
 const assertPaginate = {} as {
   <R extends Route>(route: R): Promise<void>;
   <R extends RequestInterface>(request: R): Promise<void>;
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,10 +1,13 @@
 {
+  "extends": "@octokit/tsconfig",
   "compilerOptions": {
     "esModuleInterop": true,
-    "module": "esnext",
-    "moduleResolution": "node",
-    "strict": true,
-    "target": "es2018"
+    "declaration": true,
+    "outDir": "pkg/dist-types",
+    "emitDeclarationOnly": true,
+    "sourceMap": true
   },
-  "include": ["src/**/*"]
+  "include": [
+    "src/**/*"
+  ]
 }
diff --git a/tsconfig.test.json b/tsconfig.test.json
@@ -1,6 +1,7 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {
+    "emitDeclarationOnly": false,
     "noEmit": true,
     "declaration": true,
     "noUnusedLocals": true

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": "./tsconfig.json",`
`3`	`3`	`"compilerOptions": {`
	`4`	`+ "emitDeclarationOnly": false,`
`4`	`5`	`"noEmit": true,`
`5`	`6`	`"declaration": true,`
`6`	`7`	`"noUnusedLocals": true`