pkg-pr-new 0.0.8 → 0.0.10

package/index.ts

@@ -6,21 +6,26 @@ import { createHash } from "node:crypto";
 import { hash } from "ohash";
 import fsSync from "fs";
 import fs from "fs/promises";
-import { Octokit } from "@octokit/action";
-import { getPackageManifest } from "query-registry";
-import { extractOwnerAndRepo, extractRepository } from "@pkg-pr-new/utils";
+import { getPackageManifest, type PackageManifest } from "query-registry";
+import type { Comment } from "@pkg-pr-new/utils";
+import {
+  abbreviateCommitHash,
+  extractOwnerAndRepo,
+  extractRepository,
+} from "@pkg-pr-new/utils";
 import fg from "fast-glob";
 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 { createDefaultTemplate } from "./template";
 
 declare global {
   var API_URL: string;
 }
 
-const apiUrl = process.env.API_URL ?? API_URL
+const apiUrl = process.env.API_URL ?? API_URL;
 const publishUrl = new URL("/publish", apiUrl);
 
 const main = defineCommand({
@@ -47,25 +52,32 @@ const main = defineCommand({
             description:
               "generate stackblitz templates out of directories in the current repo with the new built packages",
           },
+          comment: {
+            type: "string", // "off", "create", "update" (default)
+            description: `"off" for no comments (silent mode). "create" for comment on each publish. "update" for one comment across the pull request with edits on each publish (default)`,
+            default: "update",
+          },
         },
         run: async ({ args }) => {
           const paths = (args._.length ? args._ : ["."])
             .flatMap((p) => (fg.isDynamicPattern(p) ? fg.sync(p) : p))
-            .map((p) => path.resolve(p));
+            .map((p) => path.resolve(p.trim()));
 
           const templates = (
             typeof args.template === "string"
               ? [args.template]
-              : ([...(args.template ?? [])] as string[])
+              : ([...(args.template || [])] as string[])
           )
             .flatMap((p) => (fg.isDynamicPattern(p) ? fg.sync(p) : p))
-            .map((p) => path.resolve(p));
+            .map((p) => path.resolve(p.trim()));
 
           const formData = new FormData();
 
           const isCompact = !!args.compact;
           const isPnpm = !!args.pnpm;
 
+          const comment: Comment = args.comment as Comment;
+
           if (!process.env.TEST && process.env.GITHUB_ACTIONS !== "true") {
             console.error(
               "Continuous Releases are only available in Github Actions.",
@@ -107,16 +119,23 @@ const main = defineCommand({
           }
 
           const { sha } = await checkResponse.json();
+          const abbreviatedSha = abbreviateCommitHash(sha);
 
           const deps: Map<string, string> = new Map();
 
           for (const p of paths) {
+            if (!(await hasPackageJson(p))) {
+              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`);
             }
+            if (pJson.private) {
+              continue;
+            }
 
             if (isCompact) {
               await verifyCompactMode(pJson.name);
@@ -125,19 +144,31 @@ const main = defineCommand({
             deps.set(
               pJson.name,
               new URL(
-                `/${owner}/${repo}/${pJson.name}@${sha}`,
+                `/${owner}/${repo}/${pJson.name}@${abbreviatedSha}`,
                 apiUrl,
               ).href,
             );
           }
 
           for (const templateDir of templates) {
+            if (!(await hasPackageJson(templateDir))) {
+              console.log(
+                `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`);
             }
+            if (pJson.private) {
+              console.log(
+                `skipping ${templateDir} because the package is private`,
+              );
+              continue;
+            }
 
             console.log("preparing template:", pJson.name);
 
@@ -174,16 +205,45 @@ const main = defineCommand({
             await restore();
           }
 
+          const noDefaultTemplate = args.template === false;
+
+          if (!templates.length && !noDefaultTemplate) {
+            const project = createDefaultTemplate(
+              Object.fromEntries(deps.entries()),
+            );
+
+            for (const filePath of Object.keys(project)) {
+              formData.append(
+                `template:default:${encodeURIComponent(filePath)}`,
+                project[filePath],
+              );
+            }
+          }
+
           const restoreMap = new Map<
             string,
             Awaited<ReturnType<typeof writeDeps>>
           >();
           for (const p of paths) {
+            if (!(await hasPackageJson(p))) {
+              continue;
+            }
+            const pJsonPath = path.resolve(p, "package.json");
+            const pJson = await readPackageJSON(pJsonPath);
+
+            if (pJson.private) {
+              continue;
+            }
+
             restoreMap.set(p, await writeDeps(p, deps));
           }
 
           const shasums: Record<string, string> = {};
           for (const p of paths) {
+            if (!(await hasPackageJson(p))) {
+              console.log(`skipping ${p} because there's no package.json file`);
+              continue;
+            }
             const pJsonPath = path.resolve(p, "package.json");
             try {
               const pJson = await readPackageJSON(pJsonPath);
@@ -193,6 +253,10 @@ const main = defineCommand({
                   `"name" field in ${pJsonPath} should be defined`,
                 );
               }
+              if (pJson.private) {
+                console.log(`skipping ${p} because the package is private`);
+                continue;
+              }
 
               const { filename, shasum } = await resolveTarball(
                 isPnpm ? "pnpm" : "npm",
@@ -209,13 +273,14 @@ const main = defineCommand({
               });
               formData.append(`package:${pJson.name}`, blob, filename);
             } finally {
-              await restoreMap.get(pJsonPath)?.();
+              await restoreMap.get(p)!();
             }
           }
 
           const res = await fetch(publishUrl, {
             method: "POST",
             headers: {
+              "sb-comment": comment,
               "sb-compact": `${isCompact}`,
               "sb-key": key,
               "sb-shasums": JSON.stringify(shasums),
@@ -256,30 +321,18 @@ runMain(main);
 
 // TODO: we'll add support for yarn if users hit issues with npm
 async function resolveTarball(pm: "npm" | "pnpm", p: string) {
-  if (pm === "npm") {
-    const { stdout } = await ezSpawn.async("npm pack --json", {
-      stdio: "overlapped",
-      cwd: p,
-    });
-
-    const { filename, shasum }: { filename: string; shasum: string } =
-      JSON.parse(stdout)[0];
-
-    return { filename, shasum };
-  } else if (pm === "pnpm") {
-    const { stdout } = await ezSpawn.async("pnpm pack", {
-      stdio: "overlapped",
-      cwd: p,
-    });
-    const filename = stdout.trim();
-
-    const shasum = createHash("sha1")
-      .update(await fs.readFile(path.resolve(p, filename)))
-      .digest("hex");
-
-    return { filename, shasum };
-  }
-  throw new Error("Could not resolve package manager");
+  const { stdout } = await ezSpawn.async(`${pm} pack`, {
+    stdio: "overlapped",
+    cwd: p,
+  });
+  const lines = stdout.split("\n").filter(Boolean);
+  const filename = lines[lines.length - 1].trim();
+
+  const shasum = createHash("sha1")
+    .update(await fs.readFile(path.resolve(p, filename)))
+    .digest("hex");
+
+  return { filename, shasum };
 }
 
 async function writeDeps(p: string, deps: Map<string, string>) {
@@ -311,23 +364,42 @@ function hijackDeps(
 }
 
 async function verifyCompactMode(packageName: string) {
-  const error = new Error(
-    `pkg-pr-new cannot resolve ${packageName} from npm. --compact flag depends on the package being available in npm.
-Make sure to have your package on npm first or configure the 'repository' field in your package.json properly.`,
-  );
+  let manifest: PackageManifest;
+
   try {
-    const manifest = await getPackageManifest(packageName);
+    manifest = await getPackageManifest(packageName);
+  } catch {
+    throw new Error(
+      `pkg-pr-new cannot resolve ${packageName} from npm. --compact flag depends on the package being available in npm.
+Make sure to have your package on npm first.`,
+    );
+  }
 
-    const repository = extractRepository(manifest);
-    if (!repository) {
-      throw error;
-    }
+  const instruction = `Make sure to configure the 'repository' / 'repository.url' field in its package.json properly.
+See https://docs.npmjs.com/cli/v10/configuring-npm/package-json#repository for details.`;
 
-    const match = extractOwnerAndRepo(repository);
-    if (!match) {
-      throw error;
-    }
+  const repository = extractRepository(manifest);
+  if (!repository) {
+    throw new Error(
+      `pkg-pr-new cannot extract the repository link from the ${packageName} manifest. --compact flag requires the link to be present.
+${instruction}`,
+    );
+  }
+
+  const match = extractOwnerAndRepo(repository);
+  if (!match) {
+    throw new Error(
+      `pkg-pr-new cannot extract the owner and repo names from the ${packageName} repository link: ${repository}. --compact flag requires these names.
+${instruction}`,
+    );
+  }
+}
+
+async function hasPackageJson(p: string) {
+  try {
+    await fs.access(path.resolve(p, "package.json"), fs.constants.F_OK);
+    return true;
   } catch {
-    throw error;
+    return false;
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pkg-pr-new",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -22,7 +22,7 @@
     "ignore": "^5.3.1",
     "isbinaryfile": "^5.0.2",
     "pkg-types": "^1.1.1",
-    "query-registry": "^3.0.0"
+    "query-registry": "^3.0.1"
   },
   "devDependencies": {
     "@pkg-pr-new/utils": "workspace:^",

package/template.ts

@@ -0,0 +1,54 @@
+export const createDefaultTemplate = (
+  dependencies: Record<string, string>,
+) => ({
+  "index.js": "",
+  "README.md": `
+# Default Template
+
+This is a template that leverages the experimental templates feature in the \`pkg.pr.new\` tool.
+
+## Overview
+
+Templates are particularly useful for creating live, interactive examples of your packages, which can be very beneficial for both development and documentation purposes.
+
+As a user, you can check the package.json file and see the new generated packages! You can just copy those and put them in your package.json or install them with your favorite package manager.
+
+${Object.values(dependencies)
+  .map(
+    (url) => `
+\`\`\`sh
+npm i ${url}
+\`\`\`
+`,
+  )
+  .join("")}
+
+## Usage
+
+To use this feature as a maintainer, you can run the following command:
+
+\`\`\`sh
+npx pkg-pr-new publish ./packages/A --template ./examples/*
+\`\`\`
+
+## Benefits
+
+- Interactive Demos: Automatically create live demos that users can interact with directly in their browser.
+- Enhanced Testing: Quickly spin up environments to test your package in different scenarios.
+- Improved Sharing: Easily share working examples of your package with collaborators or users without needing them to set up their environment.
+`,
+  "package.json": JSON.stringify(
+    {
+      name: "default",
+      version: "1.0.0",
+      description: "generated by pkg.pr.new",
+      main: "index.js",
+      dependencies,
+      keywords: [],
+      author: "pkg.pr.new",
+      license: "ISC",
+    },
+    null,
+    2,
+  ),
+});