bun-workspaces 1.6.0 → 1.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bun-workspaces",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "A monorepo management tool for Bun, with a CLI and API to enhance Bun's native workspaces.",
   "license": "MIT",
   "exports": {
@@ -15,6 +15,10 @@
     "./config": {
       "types": "./src/config/public.d.ts",
       "default": "./src/config/public.mjs"
+    },
+    "./script": {
+      "types": "./src/runScript/public.d.ts",
+      "default": "./src/runScript/public.mjs"
     }
   },
   "types": "./src/index.d.ts",

package/src/1108.mjs

@@ -24,7 +24,14 @@ const SCRIPT_RUNTIME_METADATA_CONFIG = {
     envVarName: "BW_WORKSPACE_NAME",
   },
 };
-const getScriptRuntimeMetadataConfig = (key) =>
-  SCRIPT_RUNTIME_METADATA_CONFIG[key];
+const validateScriptRuntimeMetadataKey = (key) => {
+  if (!(key in SCRIPT_RUNTIME_METADATA_CONFIG)) {
+    throw new Error(`Invalid script runtime metadata key: ${key}`);
+  }
+};
+const getScriptRuntimeMetadataConfig = (key) => {
+  validateScriptRuntimeMetadataKey(key);
+  return SCRIPT_RUNTIME_METADATA_CONFIG[key];
+};
 
 export { getScriptRuntimeMetadataConfig };

package/src/runScript/public.d.ts

@@ -0,0 +1,40 @@
+// Generated by dts-bundle-generator v9.5.1
+
+declare const SCRIPT_RUNTIME_METADATA_CONFIG: {
+  readonly projectPath: {
+    readonly inlineName: "<projectPath>";
+    readonly envVarName: "BW_PROJECT_PATH";
+  };
+  readonly projectName: {
+    readonly inlineName: "<projectName>";
+    readonly envVarName: "BW_PROJECT_NAME";
+  };
+  readonly workspacePath: {
+    readonly inlineName: "<workspacePath>";
+    readonly envVarName: "BW_WORKSPACE_PATH";
+  };
+  readonly workspaceRelativePath: {
+    readonly inlineName: "<workspaceRelativePath>";
+    readonly envVarName: "BW_WORKSPACE_RELATIVE_PATH";
+  };
+  readonly scriptName: {
+    readonly inlineName: "<scriptName>";
+    readonly envVarName: "BW_SCRIPT_NAME";
+  };
+  readonly workspaceName: {
+    readonly inlineName: "<workspaceName>";
+    readonly envVarName: "BW_WORKSPACE_NAME";
+  };
+};
+export type ScriptRuntimeMetadataKey =
+  keyof typeof SCRIPT_RUNTIME_METADATA_CONFIG;
+/**
+ * This is a utility to run from a workspace's script that was called via `bun-workspaces`.
+ *
+ * It gets the value of some metadata value about the project, workspace, or script that was invoked.
+ */
+export declare const getWorkspaceScriptMetadata: (
+  key: ScriptRuntimeMetadataKey,
+) => string;
+
+export {};

package/src/runScript/public.mjs

@@ -0,0 +1 @@
+export { getWorkspaceScriptMetadata } from "./scriptRuntimeMetadata.mjs";

package/src/runScript/scriptRuntimeMetadata.mjs

@@ -1,4 +1,4 @@
-import { IS_WINDOWS } from "../internal/core/index.mjs";
+import { BunWorkspacesError, IS_WINDOWS } from "../internal/core/index.mjs";
 import { getScriptRuntimeMetadataConfig } from "../1108.mjs";
 
 const createScriptRuntimeEnvVars = (metadata) => {
@@ -39,5 +39,22 @@ const interpolateScriptRuntimeMetadata = (text, metadata, shell) => {
     return value;
   });
 };
+/**
+ * This is a utility to run from a workspace's script that was called via `bun-workspaces`.
+ *
+ * It gets the value of some metadata value about the project, workspace, or script that was invoked.
+ */ const getWorkspaceScriptMetadata = (key) => {
+  const { envVarName } = getScriptRuntimeMetadataConfig(key);
+  if (!(envVarName in process.env)) {
+    throw new BunWorkspacesError(
+      `getScriptMetadata() called with key "${key}" but environment variable ${envVarName} is not set. getScriptMetadata() may not have been called in a workspace script running via bun-workspaces.`,
+    );
+  }
+  return process.env[envVarName];
+};
 
-export { createScriptRuntimeEnvVars, interpolateScriptRuntimeMetadata };
+export {
+  createScriptRuntimeEnvVars,
+  getWorkspaceScriptMetadata,
+  interpolateScriptRuntimeMetadata,
+};