feat: replace ts-node shebangs with node ones in published bins

Author: nlf

lib/content/update-shebang.ts

@@ -0,0 +1,37 @@
+#!/usr/bin/env ts-node
+
+import { spawnSync } from "node:child_process";
+import { readFile, writeFile } from "node:fs/promises";
+import { dirname, resolve } from "node:path";
+
+const ROOT = dirname(__dirname);
+const tsShebang = "#!/usr/bin/env ts-node";
+const jsShebang = "#!/usr/bin/env node";
+
+async function updateShebang (path: string) {
+  const originalContent = await readFile(path, { encoding: "utf8" });
+  const updatedContent = originalContent.replace(tsShebang, jsShebang);
+  await writeFile(path, updatedContent, { encoding: "utf8" });
+}
+
+async function main () {
+  const npmResult = spawnSync("npm", ["show", ".", "bin", "--json"], {
+    cwd: ROOT,
+    shell: true,
+    encoding: "utf8",
+  });
+
+  if (npmResult.stdout) {
+    const binEntries = JSON.parse(npmResult.stdout) as Record<string, string>;
+    const binPaths = Object.values(binEntries);
+
+    for (const binPath of binPaths) {
+      await updateShebang(resolve(ROOT, binPath));
+    }
+  }
+}
+
+main().catch((err: Error) => {
+  process.exitCode = 1;
+  console.error(err.stack);
+});

lib/index.ts

@@ -14,15 +14,27 @@ interface Variables {
   ci?: object;
 }
 
+type PkgContents = {
+  // we don't use these fields directly, we just need to know if they have a value
+  bin?: unknown;
+  directories?: { bin?: unknown };
+
+  // these ones we inspect
+  name: string;
+  devDependencies?: Record<string, string>;
+};
+
 export default async function (root: string, variables: Variables) {
   const actualContent = await readFile(join(root, "package.json"), { encoding: "utf8" });
-  const actualPkg = JSON.parse(actualContent) as { name: string; devDependencies?: Record<string, string> };
+  const actualPkg = JSON.parse(actualContent) as PkgContents;
   if (actualPkg.name !== ownPkg.name && actualPkg.devDependencies?.[ownPkg.name] !== ownPkg.version) {
     console.log(`ERROR! The devDependency "${ownPkg.name}" must be set to the exact version "${ownPkg.version}"`);
     console.log(`Try running \`npm install --save-exact -D ${ownPkg.name}\``);
     process.exit(1);
   }
 
+  const hasBin = !!(actualPkg.bin || actualPkg.directories?.bin);
+
   const csBin = variables.dogfood ? "./bin/code-skeleton.ts" : "code-skeleton";
   const skeleton: Skeleton = {
     "package.json": pkg({
@@ -43,9 +55,17 @@ export default async function (root: string, variables: Variables) {
         postlint: "npm run skeleton:verify",
         test: "tap",
         posttest: "npm run lint",
-        prepack: "tsc --project tsconfig.build.json",
         "skeleton:apply": `${csBin} apply`,
         "skeleton:verify": `${csBin} verify`,
+        ...(hasBin
+          ? {
+            "update-shebang": "./scripts/update-shebang.ts",
+            prepack: "tsc --project tsconfig.build.json && npm run update-shebang",
+          }
+          : {
+            prepack: "tsc --project tsconfig.build.json",
+          }
+        ),
       },
       tap: {
         coverage: true,
@@ -108,5 +128,9 @@ export default async function (root: string, variables: Variables) {
     skeleton[".npmrc"] = copy(join(__dirname, "content", "npmrc"));
   }
 
+  if (hasBin) {
+    skeleton["scripts/update-shebang.ts"] = copy(join(__dirname, "content", "update-shebang.ts"));
+  }
+
   return skeleton;
 }

scripts/update-shebang.ts

@@ -0,0 +1,37 @@
+#!/usr/bin/env ts-node
+
+import { spawnSync } from "node:child_process";
+import { readFile, writeFile } from "node:fs/promises";
+import { dirname, resolve } from "node:path";
+
+const ROOT = dirname(__dirname);
+const tsShebang = "#!/usr/bin/env ts-node";
+const jsShebang = "#!/usr/bin/env node";
+
+async function updateShebang (path: string) {
+  const originalContent = await readFile(path, { encoding: "utf8" });
+  const updatedContent = originalContent.replace(tsShebang, jsShebang);
+  await writeFile(path, updatedContent, { encoding: "utf8" });
+}
+
+async function main () {
+  const npmResult = spawnSync("npm", ["show", ".", "bin", "--json"], {
+    cwd: ROOT,
+    shell: true,
+    encoding: "utf8",
+  });
+
+  if (npmResult.stdout) {
+    const binEntries = JSON.parse(npmResult.stdout) as Record<string, string>;
+    const binPaths = Object.values(binEntries);
+
+    for (const binPath of binPaths) {
+      await updateShebang(resolve(ROOT, binPath));
+    }
+  }
+}
+
+main().catch((err: Error) => {
+  process.exitCode = 1;
+  console.error(err.stack);
+});