@agoric/pola-io 0.1.1-ymax-v0.2-alpha-dev-8e37faa.0 → 0.2.0-u22.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/pola-io",
-  "version": "0.1.1-ymax-v0.2-alpha-dev-8e37faa.0+8e37faa",
+  "version": "0.2.0-u22.1",
   "description": "Least Authority I/O utilities",
   "type": "module",
   "main": "./src/index.js",
@@ -15,7 +15,7 @@
     "lint-fix": "eslint --fix ."
   },
   "dependencies": {
-    "@agoric/internal": "workspace:*"
+    "@agoric/internal": "0.4.0-u22.1"
   },
   "devDependencies": {
     "ava": "^5.3.0"
@@ -40,5 +40,8 @@
   "typeCoverage": {
     "atLeast": 91.94
   },
-  "gitHead": "8e37faaf5265f55433fc80e67c8785a66480c7f4"
+  "engines": {
+    "node": "^20.9 || ^22.11"
+  },
+  "gitHead": "83a42d0f343b01448a918631dce159b5bdb69b7e"
 }

package/src/ambient/cmd.js

@@ -13,9 +13,9 @@ import * as cmd from '../cmd.js';
  * TODO? .withPath('/opt') or .withEnv({PATH: `${env.PATH}:/opt`})
  *
  * @param {string} file
- * @param {{ execFile: any }} io
+ * @param {{ execFile?: any, defaultEnv?: import('../cmd.js').Environment }} [io]
  */
 export const makeCmdRunner = (
   file,
-  { execFile = promisify(execFileAmbient) },
-) => cmd.makeCmdRunner(file, { execFile });
+  { execFile = promisify(execFileAmbient), defaultEnv = process.env } = {},
+) => cmd.makeCmdRunner(file, { execFile, defaultEnv });

package/src/cmd.js

@@ -3,6 +3,10 @@
 // XXX what hazards does this expose us to?
 const { freeze } = Object;
 
+/**
+ * @typedef {Record<string, string | undefined>} Environment
+ */
+
 /**
  * Access to run a command with flags appended.
  *
@@ -16,31 +20,64 @@ const { freeze } = Object;
  *
  * XXX use a different name from execFile since the meaning is different
  * @param {string} file
- * @param {{ execFile: any }} io XXX expects promisify
+ * @param {{ execFile?: any, defaultEnv?: Environment }} [io] XXX expects promisify
  */
-export const makeCmdRunner = (file, { execFile }) => {
-  /** @param {{ preArgs?: string[], postArgs?: string[] }} [opts] */
-  const make = ({ preArgs = [], postArgs = [] } = {}) => {
+export const makeCmdRunner = (file, { execFile, defaultEnv } = {}) => {
+  /**
+   * @param {{
+   *   preArgs: string[],
+   *   postArgs: string[],
+   *   postEnv: Environment }} opts
+   */
+  const make = ({ preArgs, postArgs, postEnv }) => {
     return freeze({
       /**
        * @param {string[]} args
-       * @param {*} [opts]
+       * @param {object} [opts]
+       * @param {Record<string, string | undefined>} [opts.env]
+       * @param {string} [opts.encoding]
+       * @param {*} [opts.stdio]
        */
       exec: (
         args,
-        opts = { encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'] },
-      ) => execFile(file, [...preArgs, ...args, ...postArgs], opts),
+        {
+          env = { ...defaultEnv },
+          encoding = 'utf8',
+          stdio = ['ignore', 'pipe', 'ignore'],
+          ...opts
+        } = {},
+      ) =>
+        execFile(file, [...preArgs, ...args, ...postArgs], {
+          ...opts,
+          env: { ...env, ...postEnv },
+          encoding,
+          stdio,
+        }),
       /**
        * @param {string} name
-        @param {string[]} [opts] */
+       * @param {string[]} [opts]
+       */
       subCommand: (name, opts = []) =>
-        make({ preArgs: [...preArgs, name, ...opts], postArgs }),
+        make({ preArgs: [...preArgs, name, ...opts], postArgs, postEnv }),
+      /**
+       * @param {string[]} args
+       */
+      withArgs: (...args) =>
+        make({ preArgs: [...preArgs, ...args], postArgs, postEnv }),
+      /**
+       * @param {Environment} env
+       */
+      withEnv: env =>
+        make({ preArgs, postArgs, postEnv: { ...env, ...postEnv } }),
+      /**
+       *
+       */
       /** @param {string[]} tailFlags */
       withFlags: (...tailFlags) =>
-        make({ preArgs, postArgs: [...postArgs, ...tailFlags] }),
+        make({ preArgs, postArgs: [...postArgs, ...tailFlags], postEnv }),
     });
   };
-  return make();
+  return make({ preArgs: [], postArgs: [], postEnv: {} });
 };
 freeze(makeCmdRunner);
 /** @typedef {ReturnType<makeCmdRunner>} CmdRunner */