pkg-pr-new 0.0.39 → 0.0.41

package/environments.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-namespace */
 // https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
 declare global {
   namespace NodeJS {

package/index.ts

@@ -1,11 +1,12 @@
-import { defineCommand, runMain } from "citty";
+/* eslint-disable unicorn/no-process-exit */
 import assert from "node:assert";
-import path from "path";
-import ezSpawn from "@jsdevtools/ez-spawn";
+import path from "node:path";
 import { createHash } from "node:crypto";
+import fsSync from "node:fs";
+import fs from "node:fs/promises";
 import { hash } from "ohash";
-import fsSync from "fs";
-import fs from "fs/promises";
+import ezSpawn from "@jsdevtools/ez-spawn";
+import { defineCommand, runMain } from "citty";
 import { getPackageManifest, type PackageManifest } from "query-registry";
 import type { Comment } from "@pkg-pr-new/utils";
 import {
@@ -16,13 +17,13 @@ import {
 import { glob } from "tinyglobby";
 import ignore from "ignore";
 import "./environments";
-import pkg from "./package.json" with { type: "json" };
 import { isBinaryFile } from "isbinaryfile";
-import { readPackageJSON, writePackageJSON } from "pkg-types";
+import { writePackageJSON, type PackageJson } from "pkg-types";
+import pkg from "./package.json" with { type: "json" };
 import { createDefaultTemplate } from "./template";
 
 declare global {
-  var API_URL: string;
+  const API_URL: string;
 }
 
 type OutputMetadata = {
@@ -89,10 +90,16 @@ const main = defineCommand({
           },
           packageManager: {
             type: "string",
-            description: "Specify the package manager to use (npm, bun, pnpm, yarn)",
+            description:
+              "Specify the package manager to use (npm, bun, pnpm, yarn)",
             enum: ["npm", "bun", "pnpm", "yarn"],
             default: "npm",
           },
+          bin: {
+            type: "boolean",
+            description:
+              "Set to true if your package is a binary application and you would like to show an execute command instead of an install command.",
+          },
         },
         run: async ({ args }) => {
           const paths =
@@ -113,16 +120,30 @@ const main = defineCommand({
           const formData = new FormData();
 
           const isCompact = !!args.compact;
-          const isPnpm = !!args.pnpm;
+          let packMethod: PackMethod = "npm";
+
+          if (args.pnpm) {
+            packMethod = "pnpm";
+          } else if (args.yarn) {
+            packMethod = "yarn";
+          }
+
           const isPeerDepsEnabled = !!args.peerDeps;
           const isOnlyTemplates = !!args["only-templates"];
 
+          const isBinaryApplication = !!args.binaryApplication;
           const comment: Comment = args.comment as Comment;
-          const selectedPackageManager = args.packageManager as "npm" | "bun" | "pnpm" | "yarn";
-
-          if (!["npm", "bun", "pnpm", "yarn"].includes(selectedPackageManager)) {
+          const selectedPackageManager = args.packageManager as
+            | "npm"
+            | "bun"
+            | "pnpm"
+            | "yarn";
+
+          if (
+            !["npm", "bun", "pnpm", "yarn"].includes(selectedPackageManager)
+          ) {
             console.error(
-              `Unsupported package manager: ${selectedPackageManager}. Supported managers are npm, bun, pnpm, yarn.`
+              `Unsupported package manager: ${selectedPackageManager}. Supported managers are npm, bun, pnpm, yarn.`,
             );
             process.exit(1);
           }
@@ -183,11 +204,12 @@ const main = defineCommand({
           };
 
           for (const p of paths) {
-            if (!(await hasPackageJson(p))) {
+            const pJsonPath = path.resolve(p, "package.json");
+            const pJson = await readPackageJson(pJsonPath);
+
+            if (!pJson) {
               continue;
             }
-            const pJsonPath = path.resolve(p, "package.json");
-            const pJson = await readPackageJSON(pJsonPath);
 
             if (!pJson.name) {
               throw new Error(`"name" field in ${pJsonPath} should be defined`);
@@ -223,14 +245,18 @@ const main = defineCommand({
           }
 
           for (const templateDir of templates) {
-            if (!(await hasPackageJson(templateDir))) {
+            const pJsonPath = path.resolve(templateDir, "package.json");
+            const pJsonContents = await tryReadFile(pJsonPath);
+            const pJson = pJsonContents
+              ? parsePackageJson(pJsonContents)
+              : null;
+
+            if (!pJson || !pJsonContents) {
               console.warn(
                 `skipping ${templateDir} because there's no package.json file`,
               );
               continue;
             }
-            const pJsonPath = path.resolve(templateDir, "package.json");
-            const pJson = await readPackageJSON(pJsonPath);
 
             if (!pJson.name) {
               throw new Error(`"name" field in ${pJsonPath} should be defined`);
@@ -238,7 +264,13 @@ const main = defineCommand({
 
             console.warn("preparing template:", pJson.name);
 
-            const restore = await writeDeps(templateDir, deps, realDeps);
+            const restore = await writeDeps(
+              templateDir,
+              pJsonContents,
+              pJson,
+              deps,
+              realDeps,
+            );
 
             const gitignorePath = path.join(templateDir, ".gitignore");
             const ig = ignore().add("node_modules").add(".git");
@@ -301,31 +333,38 @@ const main = defineCommand({
             Awaited<ReturnType<typeof writeDeps>>
           >();
           for (const p of paths) {
-            if (!(await hasPackageJson(p))) {
+            const pJsonPath = path.resolve(p, "package.json");
+            const pJsonContents = await tryReadFile(pJsonPath);
+            const pJson = pJsonContents
+              ? parsePackageJson(pJsonContents)
+              : null;
+
+            if (!pJson || !pJsonContents) {
               continue;
             }
-            const pJsonPath = path.resolve(p, "package.json");
-            const pJson = await readPackageJSON(pJsonPath);
 
             if (pJson.private) {
               continue;
             }
 
-            restoreMap.set(p, await writeDeps(p, deps, realDeps));
+            restoreMap.set(
+              p,
+              await writeDeps(p, pJsonContents, pJson, deps, realDeps),
+            );
           }
 
           const shasums: Record<string, string> = {};
           for (const p of paths) {
-            if (!(await hasPackageJson(p))) {
+            const pJsonPath = path.resolve(p, "package.json");
+            const pJson = await readPackageJson(pJsonPath);
+            if (!pJson) {
               console.warn(
                 `skipping ${p} because there's no package.json file`,
               );
               continue;
             }
-            const pJsonPath = path.resolve(p, "package.json");
-            try {
-              const pJson = await readPackageJSON(pJsonPath);
 
+            try {
               if (!pJson.name) {
                 throw new Error(
                   `"name" field in ${pJsonPath} should be defined`,
@@ -337,8 +376,9 @@ const main = defineCommand({
               }
 
               const { filename, shasum } = await resolveTarball(
-                isPnpm ? "pnpm" : "npm",
+                packMethod,
                 p,
+                pJson,
               );
 
               shasums[pJson.name] = shasum;
@@ -369,7 +409,7 @@ const main = defineCommand({
 
           // multipart uploading
           if (formDataPackagesSize > 1024 * 1024 * 99) {
-            for (const [name, entry] of [...formData]) {
+            for (const [name, entry] of formData) {
               if (name.startsWith("package:")) {
                 const file = entry as File;
                 const chunkSize = 1024 * 1024 * 5;
@@ -388,11 +428,8 @@ const main = defineCommand({
                   console.error(await createMultipartRes.text());
                   continue;
                 }
-                const {
-                  key: uploadKey,
-                  id: uploadId,
-                  ...data
-                } = await createMultipartRes.json();
+                const { key: uploadKey, id: uploadId } =
+                  await createMultipartRes.json();
 
                 interface R2UploadedPart {
                   partNumber: number;
@@ -454,6 +491,7 @@ const main = defineCommand({
               "sb-key": key,
               "sb-shasums": JSON.stringify(shasums),
               "sb-run-id": GITHUB_RUN_ID,
+              "sb-bin": `${isBinaryApplication}`,
               "sb-package-manager": selectedPackageManager,
               "sb-only-templates": `${isOnlyTemplates}`,
             },
@@ -473,8 +511,11 @@ const main = defineCommand({
             .filter((k) => k.startsWith("package:"))
             .map((name, i) => {
               const packageName = name.slice("package:".length);
-              const url = new URL(laterRes.urls[i])
-              const publintUrl = new URL(`/pkg.pr.new${url.pathname}`, "https://publint.dev")
+              const url = new URL(laterRes.urls[i]);
+              const publintUrl = new URL(
+                `/pkg.pr.new${url.pathname}`,
+                "https://publint.dev",
+              );
               return `${packageName}:
 - sha: ${shasums[packageName]}
 - publint: ${publintUrl}
@@ -498,7 +539,9 @@ const main = defineCommand({
     link: () => {
       return {
         meta: {},
-        run: () => {},
+        run: () => {
+          // noop
+        },
       };
     },
   },
@@ -508,14 +551,23 @@ runMain(main)
   .then(() => process.exit(0))
   .catch(() => process.exit(1));
 
-// TODO: we'll add support for yarn if users hit issues with npm
-async function resolveTarball(pm: "npm" | "pnpm", p: string) {
-  const { stdout } = await ezSpawn.async(`${pm} pack`, {
+type PackMethod = "npm" | "pnpm" | "yarn";
+
+async function resolveTarball(pm: PackMethod, p: string, pJson: PackageJson) {
+  let cmd = `${pm} pack`;
+  let filename = `${pJson.name!.replace("/", "-")}-${pJson.version}.tgz`;
+  if (pm === "yarn") {
+    cmd += ` --filename ${filename}`;
+  }
+  const { stdout } = await ezSpawn.async(cmd, {
     stdio: "overlapped",
     cwd: p,
   });
   const lines = stdout.split("\n").filter(Boolean);
-  const filename = lines[lines.length - 1].trim();
+
+  if (pm !== "yarn") {
+    filename = lines[lines.length - 1].trim();
+  }
 
   const shasum = createHash("sha1")
     .update(await fs.readFile(path.resolve(p, filename)))
@@ -526,13 +578,12 @@ async function resolveTarball(pm: "npm" | "pnpm", p: string) {
 
 async function writeDeps(
   p: string,
+  pJsonContents: string,
+  pJson: PackageJson,
   deps: Map<string, string>,
   realDeps: Map<string, string> | null,
 ) {
   const pJsonPath = path.resolve(p, "package.json");
-  const content = await fs.readFile(pJsonPath, "utf-8");
-
-  const pJson = await readPackageJSON(pJsonPath);
 
   hijackDeps(deps, pJson.dependencies);
   hijackDeps(deps, pJson.devDependencies);
@@ -544,7 +595,7 @@ async function writeDeps(
 
   await writePackageJSON(pJsonPath, pJson);
 
-  return () => fs.writeFile(pJsonPath, content);
+  return () => fs.writeFile(pJsonPath, pJsonContents);
 }
 
 function hijackDeps(
@@ -600,11 +651,30 @@ ${instruction}`,
   }
 }
 
-async function hasPackageJson(p: string) {
+async function tryReadFile(p: string) {
+  try {
+    return await fs.readFile(p, "utf8");
+  } catch {
+    return null;
+  }
+}
+
+async function readPackageJson(p: string) {
+  const contents = await tryReadFile(p);
+  if (contents === null) {
+    return null;
+  }
+  try {
+    return parsePackageJson(contents);
+  } catch {
+    return null;
+  }
+}
+
+function parsePackageJson(contents: string) {
   try {
-    await fs.access(path.resolve(p, "package.json"), fs.constants.F_OK);
-    return true;
+    return JSON.parse(contents) as PackageJson;
   } catch {
-    return false;
+    return null;
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pkg-pr-new",
-  "version": "0.0.39",
+  "version": "0.0.41",
   "description": "",
   "main": "index.js",
   "type": "module",