feat: remove pika and replace with esbuild + tsc (#260)

* feat: remove pika and replace with esbuild + tsc

* style: prettier

Author: wolfy1339

index.js

@@ -10,6 +10,7 @@ const command = require("./lib/command");
 const createBranchProtection = require("./lib/create-branch-protection");
 const createCoc = require("./lib/create-coc");
 const createContributing = require("./lib/create-contributing");
+const createEsbuildScript = require("./lib/create-esbuild-script");
 const createIssueTemplates = require("./lib/create-issue-templates");
 const createLicense = require("./lib/create-license");
 const createPackageJson = require("./lib/create-package-json");
@@ -184,8 +185,8 @@ module.exports = async function main() {
     const dependencies = [];
     const devDependencies = [
       "@octokit/tsconfig",
-      "@pika/pack",
-      "@pika/plugin-ts-standard-pkg",
+      "esbuild",
+      "glob",
       "@types/jest",
       "@types/node",
       "jest",
@@ -196,12 +197,6 @@ module.exports = async function main() {
       "typescript",
     ];
 
-    if (answers.supportsBrowsers) {
-      devDependencies.push("@pika/plugin-build-web");
-    }
-    if (answers.supportsNode) {
-      devDependencies.push("@pika/plugin-build-node");
-    }
     if (answers.isPlugin || answers.isAuthenticationStrategy) {
       devDependencies.push("@octokit/core");
     }
@@ -241,10 +236,18 @@ module.exports = async function main() {
       JSON.stringify({
         extends: "@octokit/tsconfig",
         include: ["src/**/*"],
+        compilerOptions: {
+          declaration: true,
+          outDir: "pkg/dist-types",
+          emitDeclarationOnly: true,
+          sourceMap: true,
+        },
       })
     );
     await command(`git add tsconfig.json`);
-    await command(`git commit -m 'build(typescript): configuration for pika'`);
+    await command(
+      `git commit -m 'build(typescript): configuration for esbuild'`
+    );
 
     console.log("create smoke test");
 
@@ -418,6 +421,7 @@ module.exports = async function main() {
       }
     }
 
+    await createEsbuildScript(answers);
     await command(`git add src`);
     await command(`git commit -m 'feat: initial version'`);
 

lib/create-esbuild-script.js

@@ -0,0 +1,129 @@
+module.exports = createEsbuildScript;
+
+const writePrettyFile = require("./write-pretty-file");
+
+async function createEsbuildScript(answers) {
+  const nodeBuildOptions = `  // Build a CJS Node.js bundle
+  await esbuild.build({
+    entryPoints,
+    outdir: "pkg/dist-node",
+    bundle: true,
+    platform: "node",
+    target: "node18",
+    format: "cjs",
+    ...sharedOptions,
+  })`;
+  const browserBuildOptions = `  // Build an ESM browser bundle
+  await esbuild.build({
+    entryPoints,
+    outdir: "pkg/dist-web",
+    bundle: true,
+    platform: "browser",
+    format: "esm",
+    ...sharedOptions,
+  });`;
+  const dualBuildOptions = `  await Promise.all([
+  // Build a CJS Node.js bundle
+  esbuild.build({
+    entryPoints,
+    outdir: "pkg/dist-node",
+    bundle: true,
+    platform: "node",
+    target: "node18",
+    format: "cjs",
+    ...sharedOptions,
+  }),
+  // Build an ESM browser bundle
+  esbuild.build({
+    entryPoints,
+    outdir: "pkg/dist-web",
+    bundle: true,
+    platform: "browser",
+    format: "esm",
+    ...sharedOptions,
+  }),
+]);`;
+
+  await writePrettyFile(
+    "scripts/esbuild.mjs",
+    `// @ts-check
+import esbuild from "esbuild";
+import { copyFile, readFile, writeFile, rm } from "fs/promises";
+import { glob } from "glob";
+
+/**
+ * @type {esbuild.BuildOptions}
+ */
+const sharedOptions = {
+  sourcemap: "external",
+  sourcesContent: true,
+  minify: false,
+  allowOverwrite: true,
+  packages: "external",
+};
+
+async function main() {
+  // Start with a clean slate
+  await rm("pkg", { recursive: true, force: true });
+  // Build the source code for a neutral platform as ESM
+  await esbuild.build({
+    entryPoints: await glob(["./src/*.ts", "./src/**/*.ts"]),
+    outdir: "pkg/dist-src",
+    bundle: false,
+    platform: "neutral",
+    format: "esm",
+    ...sharedOptions,
+    sourcemap: false,
+  });
+
+  // Remove the types file from the dist-src folder
+  const typeFiles = await glob([
+    "./pkg/dist-src/**/types.js.map",
+    "./pkg/dist-src/**/types.js",
+  ]);
+  for (const typeFile of typeFiles) {
+    await rm(typeFile);
+  }
+
+  const entryPoints = ["./pkg/dist-src/index.js"];\n
+      ${
+        answers.supportsBrowsers && answers.supportsNode
+          ? dualBuildOptions
+          : answers.supportsNode
+          ? nodeBuildOptions
+          : answers.supportsBrowsers
+          ? browserBuildOptions
+          : ""
+      }\n
+  // 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-*/**", "bin/**"],
+        main: "dist-node/index.js",
+        module: "dist-web/index.js",
+        types: "dist-types/index.d.ts",
+        source: "dist-src/index.js",
+        sideEffects: false,
+      },
+      null,
+      2
+    )
+  );
+}
+main();
+`
+  );
+}

lib/create-package-json.js

@@ -12,7 +12,7 @@ async function createPackageJson(answers) {
     version: "0.0.0-development",
     description: answers.description,
     scripts: {
-      build: "pika-pack build",
+      build: "node scripts/build.mjs && tsc -p tsconfig.json",
       lint: "prettier --check '{src,test}/**/*' README.md package.json",
       "lint:fix": "prettier --write '{src,test}/**/*' README.md package.json",
       pretest: "npm run -s lint",
@@ -36,9 +36,6 @@ async function createPackageJson(answers) {
         },
       },
     },
-    "@pika/pack": {
-      pipeline: [["@pika/plugin-ts-standard-pkg"]],
-    },
     release: {
       branches: [
         "+([0-9]).x",
@@ -75,12 +72,6 @@ async function createPackageJson(answers) {
     };
   }
 
-  if (answers.supportsNode) {
-    pkg["@pika/pack"].pipeline.push(["@pika/plugin-build-node"]);
-  }
-  if (answers.supportsBrowsers) {
-    pkg["@pika/pack"].pipeline.push(["@pika/plugin-build-web"]);
-  }
   if (answers.isPlugin) {
     Object.assign(pkg.peerDependencies, OCTOKIT_PLUGIN_PEER_DEPENDENCIES);
   }

lib/write-pretty-file.js

@@ -20,6 +20,8 @@ async function writePrettyFile(path, content) {
     ".md": "markdown",
     ".ts": "typescript",
     ".yml": "yaml",
+    ".js": "babel",
+    ".mjs": "babel",
   }[ext];
 
   if (!parser) throw new Error(`Define parser for ${path}`);