Skip to content

[Refactor] Extract shared execution environment logic in system.ts #7515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
gonzaloriestra wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[Refactor] Extract shared execution environment logic in system.ts #7515

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions packages/cli-kit/src/public/node/system.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,11 +179,7 @@ function parseCommand(command: string): string[] {
* ```
*/
export async function captureCommandWithExitCode(command: string, options?: ExecOptions): Promise<CaptureOutputResult> {
const env = options?.env ?? process.env
if (shouldDisplayColors()) {
env.FORCE_COLOR = '1'
}
const executionCwd = options?.cwd ?? cwd()
const {env, executionCwd} = getExecutionEnvironment(options)
const [cmd, ...args] = parseCommand(command)
if (!cmd) {
return {stdout: '', stderr: 'Empty command', exitCode: 1}
Expand All @@ -208,11 +204,7 @@ export async function captureCommandWithExitCode(command: string, options?: Exec
* @param options - Optional settings for how to run the command.
*/
export async function execCommand(command: string, options?: ExecOptions): Promise<void> {
const env = options?.env ?? process.env
if (shouldDisplayColors()) {
env.FORCE_COLOR = '1'
}
const executionCwd = options?.cwd ?? cwd()
const {env, executionCwd} = getExecutionEnvironment(options)
const [cmd, ...args] = parseCommand(command)
if (!cmd) {
throw new AbortError('Empty command')
Expand Down Expand Up @@ -305,11 +297,7 @@ function buildExec(
options?: ExecOptions,
execaOptions?: BuildExecOptions,
): ExecaChildProcess {
const env = options?.env ?? process.env
if (shouldDisplayColors()) {
env.FORCE_COLOR = '1'
}
const executionCwd = options?.cwd ?? cwd()
const {env, executionCwd} = getExecutionEnvironment(options)
checkCommandSafety(command, {cwd: executionCwd})
const commandProcess = execa(command, args, {
env,
Expand All @@ -333,6 +321,18 @@ function buildExec(
return commandProcess
}

function getExecutionEnvironment(options?: ExecOptions): {
env: {[key: string]: string | undefined}
executionCwd: string
} {
const env = options?.env ?? process.env
if (shouldDisplayColors()) {
env.FORCE_COLOR = '1'
}
const executionCwd = options?.cwd ?? cwd()
return {env, executionCwd}
}

function checkCommandSafety(command: string, _options: {cwd: string}): void {
const pathIncludingLocal = `${_options.cwd}${delimiter}${process.env.PATH}`
const commandPath = which.sync(command, {
Expand Down
Loading