@storm-software/workspace-tools 1.295.87 → 1.296.1

package/README.md

@@ -27,7 +27,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
 
-[![Version](https://img.shields.io/badge/version-1.295.84-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
+[![Version](https://img.shields.io/badge/version-1.295.87-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
 
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->

package/dist/{chunk-OBATTMGC.mjs → chunk-3WCWA5OH.mjs}

@@ -10,7 +10,7 @@ import {
 } from "./chunk-TBW5MCN6.mjs";
 import {
   __dirname
-} from "./chunk-GTBTSMUH.mjs";
+} from "./chunk-C3NYIWL4.mjs";
 
 // src/generators/browser-library/generator.ts
 import {

package/dist/chunk-54BBSJHK.mjs

@@ -0,0 +1,40 @@
+import {
+  joinPaths
+} from "./chunk-TBW5MCN6.mjs";
+
+// src/utils/github.ts
+import { createJiti } from "jiti";
+async function getGitHubTools(workspaceConfig) {
+  try {
+    const jiti = createJiti(workspaceConfig.workspaceRoot, {
+      fsCache: workspaceConfig.skipCache ? false : joinPaths(
+        workspaceConfig.workspaceRoot,
+        workspaceConfig.directories.cache || "node_modules/.cache/storm",
+        "jiti"
+      ),
+      interopDefault: true
+    });
+    const core = await jiti.import(
+      jiti.esmResolve("@actions/core")
+    );
+    return {
+      error: core.error,
+      warning: core.warning,
+      info: core.info,
+      getIDToken: core.getIDToken
+    };
+  } catch {
+    return {
+      error: (message) => console.error(message),
+      warning: (message) => console.warn(message),
+      info: (message) => console.log(message),
+      getIDToken: async () => {
+        throw new Error("getIDToken is not supported in this environment");
+      }
+    };
+  }
+}
+
+export {
+  getGitHubTools
+};

package/dist/{chunk-GTBTSMUH.mjs → chunk-C3NYIWL4.mjs}

@@ -1,4 +1,4 @@
-// ../../node_modules/.pnpm/tsup@8.4.0_patch_hash=751a554d775c3572381af4e7e5fa22eeda6dd6856012fb1cf521d6806eb2dc74__c57ea7b126adfa5c204aaea33b08d818/node_modules/tsup/assets/esm_shims.js
+// ../../node_modules/.pnpm/tsup@8.4.0_patch_hash=751a554d775c3572381af4e7e5fa22eeda6dd6856012fb1cf521d6806eb2dc74__b287391bfb89dd26f0e4843187079e1f/node_modules/tsup/assets/esm_shims.js
 import { fileURLToPath } from "url";
 import path from "path";
 var getFilename = () => fileURLToPath(import.meta.url);

package/dist/{chunk-FPNWNZUL.mjs → chunk-J4MHHL63.mjs}

@@ -7,7 +7,7 @@ import {
 } from "./chunk-ALL63TSY.mjs";
 import {
   __dirname
-} from "./chunk-GTBTSMUH.mjs";
+} from "./chunk-C3NYIWL4.mjs";
 
 // src/generators/preset/generator.ts
 import {

package/dist/{chunk-RCSUK5YZ.mjs → chunk-JIWQM3MH.mjs}

@@ -10,7 +10,7 @@ import {
 } from "./chunk-TBW5MCN6.mjs";
 import {
   __dirname
-} from "./chunk-GTBTSMUH.mjs";
+} from "./chunk-C3NYIWL4.mjs";
 
 // src/generators/neutral-library/generator.ts
 import {

package/dist/chunk-MKJITWLN.js

@@ -0,0 +1,40 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkCQDBLKPFjs = require('./chunk-CQDBLKPF.js');
+
+// src/utils/github.ts
+var _jiti = require('jiti');
+async function getGitHubTools(workspaceConfig) {
+  try {
+    const jiti = _jiti.createJiti.call(void 0, workspaceConfig.workspaceRoot, {
+      fsCache: workspaceConfig.skipCache ? false : _chunkCQDBLKPFjs.joinPaths.call(void 0, 
+        workspaceConfig.workspaceRoot,
+        workspaceConfig.directories.cache || "node_modules/.cache/storm",
+        "jiti"
+      ),
+      interopDefault: true
+    });
+    const core = await jiti.import(
+      jiti.esmResolve("@actions/core")
+    );
+    return {
+      error: core.error,
+      warning: core.warning,
+      info: core.info,
+      getIDToken: core.getIDToken
+    };
+  } catch (e) {
+    return {
+      error: (message) => console.error(message),
+      warning: (message) => console.warn(message),
+      info: (message) => console.log(message),
+      getIDToken: async () => {
+        throw new Error("getIDToken is not supported in this environment");
+      }
+    };
+  }
+}
+
+
+
+exports.getGitHubTools = getGitHubTools;

package/dist/{chunk-HECOVC7R.mjs → chunk-NIETCJS4.mjs}

@@ -13,7 +13,7 @@ import {
 } from "./chunk-TBW5MCN6.mjs";
 import {
   __dirname
-} from "./chunk-GTBTSMUH.mjs";
+} from "./chunk-C3NYIWL4.mjs";
 
 // src/generators/node-library/generator.ts
 import {

package/dist/{chunk-GCDDSEDG.mjs → chunk-OL6ZWI4R.mjs}

@@ -1,3 +1,6 @@
+import {
+  getGitHubTools
+} from "./chunk-54BBSJHK.mjs";
 import {
   addPackageJsonGitHead
 } from "./chunk-EYO6EPEG.mjs";
@@ -243,15 +246,19 @@ import { readFile as readFile3, writeFile as writeFile3 } from "node:fs/promises
 import { format as format2 } from "prettier";
 var LARGE_BUFFER = 1024 * 1e6;
 async function npmPublishExecutorFn(options, context) {
+  const workspaceConfig = await getConfig(context.root);
+  const github = await getGitHubTools(workspaceConfig);
   const isDryRun = process.env.NX_DRY_RUN === "true" || options.dryRun || false;
   if (!context.projectName) {
-    throw new Error("The `npm-publish` executor requires a `projectName`.");
+    github.error("The `npm-publish` executor requires a `projectName`.");
+    return { success: false };
   }
   const projectConfig = context.projectsConfigurations?.projects?.[context.projectName];
   if (!projectConfig) {
-    throw new Error(
+    github.error(
       `Could not find project configuration for \`${context.projectName}\``
     );
+    return { success: false };
   }
   const packageRoot = joinPaths(
     context.root,
@@ -265,15 +272,17 @@ async function npmPublishExecutorFn(options, context) {
   const packageJsonPath = joinPaths(packageRoot, "package.json");
   const packageJsonFile = await readFile3(packageJsonPath, "utf8");
   if (!packageJsonFile) {
-    throw new Error(`Could not find \`package.json\` at ${packageJsonPath}`);
+    github.error(`Could not find \`package.json\` at ${packageJsonPath}`);
+    return { success: false };
   }
   const packageJson = JSON.parse(packageJsonFile);
   const projectPackageJsonPath = joinPaths(projectRoot, "package.json");
   const projectPackageJsonFile = await readFile3(projectPackageJsonPath, "utf8");
   if (!projectPackageJsonFile) {
-    throw new Error(
+    github.error(
       `Could not find \`package.json\` at ${projectPackageJsonPath}`
     );
+    return { success: false };
   }
   const projectPackageJson = JSON.parse(projectPackageJsonFile);
   if (packageJson.version !== projectPackageJson.version) {
@@ -325,13 +334,20 @@ async function npmPublishExecutorFn(options, context) {
     npmPublishCommandSegments.push(`--registry="${registry}" `);
     npmViewCommandSegments.push(`--registry="${registry}" `);
   }
-  if (options.otp) {
-    npmPublishCommandSegments.push(`--otp="${options.otp}" `);
+  let otp = options.otp;
+  if (!otp) {
+    otp = await github.getIDToken();
+  }
+  if (!otp) {
+    const errorMessage = `One time password (OTP) is required to publish ${packageTxt} to NPM. Usually this should be provided automatically via the GitHub Actions OIDC token (see: https://github.com/actions/toolkit/tree/main/packages/core#oidc-token); however, the release process was unable to retrieve it. Please provide it via the \`otp\` executor option.`;
+    github.error(errorMessage);
+    return { success: false };
   }
+  npmPublishCommandSegments.push(`--otp="${otp}" `);
+  npmPublishCommandSegments.push("--provenance --access=public ");
   if (isDryRun) {
     npmPublishCommandSegments.push("--dry-run");
   }
-  npmPublishCommandSegments.push("--provenance --access=public ");
   const tag = options.tag || execSync("npm config get tag", {
     cwd: packageRoot,
     env: {
@@ -366,21 +382,21 @@ async function npmPublishExecutorFn(options, context) {
           return { success: true };
         }
       } catch (err) {
-        console.warn("\n ********************** \n");
-        console.warn(
-          `An error occurred while checking for existing dist-tags
-${JSON.stringify(err)}
+        console.debug(
+          `An error occurred while checking for existing dist-tags. Please note: if this is the first time this package has been published to npm, this can be ignored. 
 
-Note: If this is the first time this package has been published to NPM, this can be ignored.`
+Error: ${JSON.stringify(
+            err,
+            null,
+            2
+          )}`
         );
-        console.info("");
       }
       try {
         if (!isDryRun) {
           const command = `npm dist-tag add ${packageName}@${currentVersion} ${tag} --registry="${registry}" `;
-          console.info(
-            `Adding the dist-tag ${tag} - preparing to run the following:
-${command}`
+          console.debug(
+            `Adding the dist-tag ${tag} - preparing to run the following: ${command}`
           );
           const result = execSync(command, {
             cwd: packageRoot,
@@ -392,76 +408,49 @@ ${command}`
             killSignal: "SIGTERM"
           });
           console.info(
-            `Added the dist-tag ${tag} to v${currentVersion} for registry "${registry}"
+            `Added the dist-tag ${tag} to v${currentVersion} for registry "${registry}". 
 
 Execution response: ${result.toString()}`
           );
         } else {
           console.info(
-            `Would add the dist-tag ${tag} to v${currentVersion} for registry "${registry}", but [dry-run] was set.
+            `Would have added the dist-tag ${tag} to v${currentVersion} for registry "${registry}", but [dry-run] was set.
 `
           );
         }
         return { success: true };
       } catch (err) {
         try {
-          console.warn("\n ********************** \n");
-          let error = err;
-          if (Buffer.isBuffer(error)) {
-            error = error.toString();
-          }
-          console.warn(
-            `An error occurred while adding dist-tags:
-${error}
-
-Note: If this is the first time this package has been published to NPM, this can be ignored.`
-          );
-          console.info("");
           const stdoutData = JSON.parse(err.stdout?.toString() || "{}");
           if (stdoutData?.error && !(stdoutData.error?.code?.includes("E404") && stdoutData.error?.summary?.includes("no such package available")) && !(err.stderr?.toString().includes("E404") && err.stderr?.toString().includes("no such package available"))) {
-            console.error(
-              "npm dist-tag add error please see below for more information:"
-            );
-            if (stdoutData.error.summary) {
-              console.error(stdoutData.error?.summary);
-            }
-            if (stdoutData.error.detail) {
-              console.error(stdoutData.error?.detail);
-            }
-            if (context.isVerbose) {
-              console.error(
-                `npm dist-tag add stdout: ${JSON.stringify(stdoutData, null, 2)}`
-              );
-            }
+            const errorMessage = `An unexpected error occured while running the npm dist-tag add command: 
+
+${stdoutData?.error?.summary ? `Summary: ${stdoutData?.error?.summary}${stdoutData?.error?.code ? ` (${stdoutData?.error?.code})` : ""}
+` : ""}${stdoutData?.error?.detail ? `Detail: ${stdoutData?.error?.detail}
+` : ""}`;
+            github.error(errorMessage);
             return { success: false };
           }
         } catch (err2) {
-          console.error(
-            `Something unexpected went wrong when processing the npm dist-tag add output
-${JSON.stringify(err2)}`
-          );
+          const stdoutData = JSON.parse(err2.stdout?.toString() || "{}");
+          const errorMessage = `An unexpected error occured while processing the npm dist-tag add output: 
+
+${stdoutData?.error?.summary ? `Summary: ${stdoutData?.error?.summary}${stdoutData?.error?.code ? ` (${stdoutData?.error?.code})` : ""}
+` : ""}${stdoutData?.error?.detail ? `Detail: ${stdoutData?.error?.detail}
+` : ""}`;
+          github.error(errorMessage);
           return { success: false };
         }
       }
     } catch (err) {
-      let error = err;
-      if (Buffer.isBuffer(error)) {
-        error = error.toString();
-      }
-      console.error("\n ********************** \n");
-      console.info("");
-      console.error(
-        "An error occured trying to run the npm dist-tag add command."
-      );
-      console.error(error);
-      console.info("");
       const stdoutData = JSON.parse(err.stdout?.toString() || "{}");
       if (!(stdoutData.error?.code?.includes("E404") && stdoutData.error?.summary?.toLowerCase().includes("not found")) && !(err.stderr?.toString().includes("E404") && err.stderr?.toString().toLowerCase().includes("not found"))) {
-        console.error(
-          `Something unexpected went wrong when checking for existing dist-tags.
+        const errorMessage = `An unexpected error occured while checking for existing dist-tags: 
 
-Error: ${JSON.stringify(err, null, 2)}`
-        );
+${stdoutData?.error?.summary ? `Summary: ${stdoutData?.error?.summary}${stdoutData?.error?.code ? ` (${stdoutData?.error?.code})` : ""}
+` : ""}${stdoutData?.error?.detail ? `Detail: ${stdoutData?.error?.detail}
+` : ""}`;
+        github.error(errorMessage);
         return { success: false };
       }
     }
@@ -483,13 +472,13 @@ Error: ${JSON.stringify(err, null, 2)}`
     });
     if (isDryRun) {
       console.info(
-        `Would publish to ${registry} with tag "${tag}", but [dry-run] was set ${result ? `
+        `Would publish tag "${tag}" to ${registry}, but [dry-run] was set. ${result ? `
 
 Execution response: ${result.toString()}` : ""}`
       );
     } else {
       console.info(
-        `Published to ${registry} with tag "${tag}" ${result ? `
+        `Published tag "${tag}" to ${registry}. ${result ? `
 
 Execution response: ${result.toString()}` : ""}`
       );
@@ -497,38 +486,23 @@ Execution response: ${result.toString()}` : ""}`
     return { success: true };
   } catch (err) {
     try {
-      console.error("\n ********************** \n");
-      console.info("");
-      console.error("An error occured running npm publish.");
-      console.error("Please see below for more information:");
-      console.info("");
       const stdoutData = JSON.parse(err.stdout?.toString() || "{}");
-      if (stdoutData.error.summary) {
-        console.error(stdoutData.error.summary);
-        console.error(stdoutData.error.summary);
-      }
-      if (stdoutData.error.detail) {
-        console.error(stdoutData.error.detail);
-      }
-      if (context.isVerbose) {
-        console.error(
-          `npm publish stdout:
-${JSON.stringify(stdoutData, null, 2)}`
-        );
-      }
-      console.error("\n ********************** \n");
+      const errorMessage = `An error occurred while publishing the npm package: 
+
+${stdoutData?.error?.summary ? `Summary: ${stdoutData?.error?.summary}${stdoutData?.error?.code ? ` (${stdoutData?.error?.code})` : ""}
+` : ""}${stdoutData?.error?.detail ? `Detail: ${stdoutData?.error?.detail}
+` : ""}`;
+      github.error(errorMessage);
       return { success: false };
     } catch (err2) {
-      let error = err2;
-      if (Buffer.isBuffer(error)) {
-        error = error.toString();
-      }
-      console.error(
-        `Something unexpected went wrong when processing the npm publish output
+      const errorMessage = `Something unexpected went wrong when processing the npm publish output. 
 
-Error: ${JSON.stringify(error, null, 2)}`
-      );
-      console.error("\n ********************** \n");
+Error: ${JSON.stringify(
+        Buffer.isBuffer(err2) ? err2.toString() : err2,
+        null,
+        2
+      )}`;
+      github.error(errorMessage);
       return { success: false };
     }
   }