Skip to content

buildChildEnv

Builds the environment for child processes: the parent environment plus DEBUG_COLORS, and — when the running node supports it — LOCAL_STORAGE_NODE_OPTION appended to NODE_OPTIONS.

The support check guards against older node (< 22): passing an option node does not recognize via NODE_OPTIONS makes it exit before running, which would break every spawned tool.

Import:

import { buildChildEnv } from 'obsidian-dev-utils/script-utils/exec';

Signature:

function buildChildEnv(baseEnv: NodeJS.ProcessEnv, allowedNodeEnvironmentFlags: ReadonlySet<string>): NodeJS.ProcessEnv

Parameters:

ParameterTypeDescription
baseEnvNodeJS.ProcessEnvThe parent environment to extend (typically process.env).
allowedNodeEnvironmentFlagsReadonlySet<string>The node options accepted via NODE_OPTIONS (typically process.allowedNodeEnvironmentFlags).

Returns: NodeJS.ProcessEnv — The environment to pass to spawned child processes.