build-strap 4.1.0-dev.61 → 4.1.0-dev.62

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "build-strap",
-  "version": "4.1.0-dev.61",
+  "version": "4.1.0-dev.62",
   "description": "Node scripts for building things",
   "license": "MIT",
   "authors": [

package/src/brew.js

@@ -2,8 +2,7 @@ import fs from 'fs-extra';
 import os from 'os';
 import path from 'path';
 import { spawn } from './cp.js';
-import { cmdExists } from './env.js';
-import { appendIfMissing } from './fs.js';
+import { appendToEnvProfile, cmdExists, ensureProcessPathEnvIncludes, } from './env.js';
 const brewPath = async () => {
     for (const testPath of [
         '/opt/homebrew/bin/brew',
@@ -25,12 +24,10 @@ const brewPathExists = async () => {
         return false;
     }
 };
-const appendBrewShellEnv = async () => {
+const appendBrewShellEnv = async (opts) => {
     const brewDir = path.dirname(await brewPath());
-    await appendIfMissing(path.join(os.homedir(), '.zprofile'), `\neval "$(${brewDir}/brew shellenv)"`);
-    if (!process.env.PATH?.includes(brewDir)) {
-        process.env.PATH = `${brewDir}:${process.env.PATH}`;
-    }
+    await appendToEnvProfile(`\neval "$(${brewDir}/brew shellenv)"`, opts);
+    ensureProcessPathEnvIncludes(brewDir);
 };
 export const ensureBrewInstalled = async () => {
     if (!(await cmdExists('brew'))) {

package/src/docker.container.js

@@ -73,14 +73,14 @@ export async function unthrottledDockerContainerLs({ all, filter, } = {}) {
                         log(`<${this.name}> container stopped.`);
                     }
                     catch (e1) {
-                        log(`Failed to stop <${this.name}> container: ${e1.message}`);
+                        log(`Failed to stop <${this.name}> container: ${e1 instanceof Error && e1.message}`);
                         try {
                             log(`Killing container: <${this.name}>...`);
                             await this.kill(false);
                             log(`<${this.name}> container killed.`);
                         }
                         catch (e2) {
-                            log(`Failed to kill <${this.name}> container: ${e2.message}`);
+                            log(`Failed to kill <${this.name}> container: ${e2 instanceof Error && e2.message}`);
                         }
                     }
                 }
@@ -113,7 +113,7 @@ export async function dockerContainerStop(id, ignoreErrors = true) {
     }
     catch (e) {
         if (!ignoreErrors) {
-            throw new Error(`Failed to stop container(s): ${e.message}`);
+            throw new Error(`Failed to stop container(s): ${e instanceof Error && e.message}`);
         }
     }
 }
@@ -124,7 +124,7 @@ export async function dockerContainerKill(id, ignoreErrors = true) {
     }
     catch (e) {
         if (!ignoreErrors) {
-            throw new Error(`Failed to kill container(s): ${e.message}`);
+            throw new Error(`Failed to kill container(s): ${e instanceof Error && e.message}`);
         }
     }
 }
@@ -134,7 +134,7 @@ export async function dockerTryStopContainer(id, name = '') {
             await dockerContainerStop(id, false);
         }
         catch (e) {
-            buildLog(`Failed to stop ${name} container: ${e.message}`);
+            buildLog(`Failed to stop ${name} container: ${e instanceof Error && e.message}`);
         }
     }
 }
@@ -145,10 +145,10 @@ export async function dockerContainerRm(id, ignoreErrors = true) {
     }
     catch (e) {
         if (ignoreErrors) {
-            buildLog(`Warning (ignored Error): Failed to remove container(s): ${e.message}`);
+            buildLog(`Warning (ignored Error): Failed to remove container(s): ${e instanceof Error && e.message}`);
         }
         else {
-            throw new Error(`Failed to remove container(s): ${e.message}`);
+            throw new Error(`Failed to remove container(s): ${e instanceof Error && e.message}`);
         }
     }
 }

package/src/docker.volume.d.ts

@@ -1,4 +1,4 @@
-declare type DockerVolumeInspectOutput = Record<string, any>;
+declare type DockerVolumeInspectOutput = Record<string, unknown>;
 export interface DockerVolume {
     driver: string;
     inspect: () => Promise<null | DockerVolumeInspectOutput>;

package/src/docker.volume.js

@@ -49,7 +49,7 @@ export async function dockerVolumeRm(id, ignoreErrors = true) {
     }
     catch (e) {
         if (!ignoreErrors) {
-            throw new Error(`Failed to remove volume(s): ${e.message}`);
+            throw new Error(`Failed to remove volume(s): ${e instanceof Error && e.message}`);
         }
     }
 }

package/src/dockerCleanup.js

@@ -8,7 +8,9 @@ import { buildLog } from './run.js';
 async function flatten(input) {
     const result = await input;
     return Array.isArray(result)
-        ? [].concat(...(await Promise.all(result.map(flatten))))
+        ? [].concat(
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        ...(await Promise.all(result.map(flatten))))
         : result;
 }
 /**

package/src/env.d.ts

@@ -1,3 +1,4 @@
+import { StringGenFn } from './fs.js';
 export declare const isMac: () => boolean;
 export declare const isLinux: () => boolean;
 export declare const isWindows: () => boolean;
@@ -13,7 +14,13 @@ interface ReadShellEnvVarOptions {
     shell?: string;
 }
 export declare const readShellEnvVar: (name: string, { refreshEnv, envFile, shell, }?: ReadShellEnvVarOptions) => Promise<string | null>;
+export interface AppendToEnvProfileOptions {
+    envFile?: string | null;
+    testContent?: string | StringGenFn;
+}
+export declare const appendToEnvProfile: (content: string | StringGenFn, { envFile, testContent }?: AppendToEnvProfileOptions) => Promise<void>;
 export declare const appendEnvVarToProfile: (name: string, value: string, { envFile }?: ReadShellEnvVarOptions) => Promise<void>;
 export declare const ensureEnvVarValue: (name: string, value: string, opts?: ReadShellEnvVarOptions | undefined) => Promise<void>;
 export declare const ensureEnvVarSet: (name: string, getValue: () => Promise<string>) => Promise<void>;
+export declare const ensureProcessPathEnvIncludes: (binPath: string) => void;
 export {};

package/src/env.js

@@ -37,7 +37,7 @@ export const shellEnvFile = () => cacheString('shellEnvFile', () => {
     }
 });
 export const whichCmd = async (cmd) => {
-    const binPath = (await spawn('which', [cmd], { captureOutput: true })).output.trim();
+    const binPath = (await spawn('which', [cmd], { captureOutput: true })).stdout.trim();
     if (!binPath || !(await fs.pathExists(binPath))) {
         return null;
     }
@@ -57,12 +57,13 @@ export const readShellEnvVar = async (name, { refreshEnv = false, envFile = shel
         return null;
     }
 };
-export const appendEnvVarToProfile = async (name, value, { envFile = shellEnvFile() } = {}) => {
+export const appendToEnvProfile = async (content, { envFile = shellEnvFile(), testContent } = {}) => {
     if (!envFile) {
         throw new Error('envFile must be set');
     }
-    await appendIfMissing(path.join(os.homedir(), envFile), `\nexport ${name}=${value}`);
+    await appendIfMissing(envFile, content, testContent);
 };
+export const appendEnvVarToProfile = async (name, value, { envFile = shellEnvFile() } = {}) => appendToEnvProfile(`\nexport ${name}=${value}`, { envFile });
 export const ensureEnvVarValue = async (name, value, opts) => {
     const currentValue = await readShellEnvVar(name, opts);
     if (currentValue !== value) {
@@ -78,3 +79,8 @@ export const ensureEnvVarSet = async (name, getValue) => {
         process.env[name] = newValue;
     }
 };
+export const ensureProcessPathEnvIncludes = (binPath) => {
+    if (!process.env.PATH?.includes(binPath)) {
+        process.env.PATH = `${binPath}:${process.env.PATH}`;
+    }
+};

package/src/fs.d.ts

@@ -5,7 +5,6 @@ export declare const copyDir: (source: string, target: string, fileGlob?: string
 export declare const cleanDir: (pattern: string, globOptions?: false | glob.IOptions | undefined) => Promise<void>;
 export declare const producedPathExists: (producer: () => Promise<string>) => Promise<boolean>;
 export declare const copyIfMissing: (src: string, dest: string) => Promise<void>;
-declare type StringGenFn = () => string | Promise<string>;
+export declare type StringGenFn = () => string | Promise<string>;
 export declare const writeIfMissing: (dest: string, content: string | StringGenFn) => Promise<boolean>;
 export declare const appendIfMissing: (dest: string, content: string | StringGenFn, testContent?: string | StringGenFn | undefined) => Promise<void>;
-export {};

package/src/maps.js

@@ -38,4 +38,6 @@ export const filterKeys = (obj, filter = (v) => v != null) => Object.entries(obj
  * @param {Object} obj the input object
  * @returns {Object} a new object, a subset of the input
  */
-export const filterNullish = (obj) => filterKeys(obj);
+export const filterNullish = (obj) => 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+filterKeys(obj);

package/src/publish.d.ts

@@ -22,6 +22,6 @@ export interface PublishConfiguration extends CreateArtifactOptions {
     npmPath?: string;
     npmSkipExisting?: boolean;
     npmTag?: string;
-    prePublishFn?: () => any;
+    prePublishFn?: () => void | Promise<void>;
 }
 export declare function publish({ distDir, doPublish, fileName, npmAuthToken, npmConfig, npmCreds, npmPath, npmSkipExisting, npmTag, outDir, prePublishFn, }: PublishConfiguration): Promise<void>;