Class ShellCommandBuilder

Create command lines ready to be sent to a shell's stdin for evaluation.

Index

Constructors

Methods

buildCommand buildForBash buildForCmd buildForDefault buildForPowershell createShellCommandLine needsQuoting quoteExecutableIfNecessary

Constructors

constructor

new ShellCommandBuilder(): ShellCommandBuilder
Returns ShellCommandBuilder

Methods

buildCommand

buildCommand(
hostProcessInfo: undefined | ProcessInfo,
commandOptions: CommandLineOptions,
): string
Constructs a command line to run in a shell. The shell could be re-used/long-lived, this means we cannot spawn a new process with a nice and fresh environment, we need to encode environment modifications into the returned command.

Inspired by VS Code implementation, see: https://github.com/microsoft/vscode/blob/f395cac4fff0721a8099126172c01411812bcb4a/src/vs/workbench/contrib/debug/node/terminals.ts#L79
Parameters
- hostProcessInfo: undefined | ProcessInfo
  the host terminal process infos
- commandOptions: CommandLineOptions
  program to execute in the host terminal
Returns string
- Defined in packages/process/src/common/shell-command-builder.ts:60

`Protected`buildForBash

buildForBash(
    args: (string | ShellQuotedString)[],
    cwd?: string,
    env?: [string, null | string][],
): string
Parameters
- args: (string | ShellQuotedString)[]
- Optionalcwd: string
- Optionalenv: [string, null | string][]
Returns string
- Defined in packages/process/src/common/shell-command-builder.ts:87

`Protected`buildForCmd

buildForCmd(
    args: (string | ShellQuotedString)[],
    cwd?: string,
    env?: [string, null | string][],
): string
Parameters
- args: (string | ShellQuotedString)[]
- Optionalcwd: string
- Optionalenv: [string, null | string][]
Returns string
- Defined in packages/process/src/common/shell-command-builder.ts:130

`Protected`buildForDefault

buildForDefault(
    args: (string | ShellQuotedString)[],
    cwd?: string,
    env?: [string, null | string][],
): string
Parameters
- args: (string | ShellQuotedString)[]
- Optionalcwd: string
- Optionalenv: [string, null | string][]
Returns string
- Defined in packages/process/src/common/shell-command-builder.ts:151

`Protected`buildForPowershell

buildForPowershell(
    args: (string | ShellQuotedString)[],
    cwd?: string,
    env?: [string, null | string][],
): string
Parameters
- args: (string | ShellQuotedString)[]
- Optionalcwd: string
- Optionalenv: [string, null | string][]
Returns string
- Defined in packages/process/src/common/shell-command-builder.ts:107

`Protected`createShellCommandLine

createShellCommandLine(
args: (string | ShellQuotedString)[],
quotingFunctions: ShellQuotingFunctions,
): string
This method will try to leave arg[0] unescaped if possible. The reason is that shells like cmd expect their own commands like dir to be unescaped.
Parameters
- args: (string | ShellQuotedString)[]
- quotingFunctions: ShellQuotingFunctions
Returns string
empty string if args is empty, otherwise an escaped command.
- Defined in packages/process/src/common/shell-command-builder.ts:162

`Protected`needsQuoting

needsQuoting(arg: string): boolean
If this method returns false then we definitely need quoting.

May return false positives.
Parameters
- arg: string
Returns boolean
- Defined in packages/process/src/common/shell-command-builder.ts:184

`Protected`quoteExecutableIfNecessary

quoteExecutableIfNecessary(
exec: string | ShellQuotedString,
quotingFunctions: ShellQuotingFunctions,
): string
Parameters
- exec: string | ShellQuotedString
- quotingFunctions: ShellQuotingFunctions
Returns string
- Defined in packages/process/src/common/shell-command-builder.ts:175