Files
archived-orca/src/shared/workspace-setup/setup-script-shebang.ts
T

97 lines
3.3 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
// Script shebangs choose the interpreter independently of the user’s terminal preference.
const POSIX_SHELL_BASENAMES = new Set(['sh', 'bash', 'zsh', 'dash', 'ksh', 'ash'])
// Accept only set-compatible flags; invocation-only flags abort the set -e runner or restrict setup.
const SET_OPTION_FLAG_PATTERN = /^[-+][abefhkmnptuvxBCHP]+$/
// Require a name after -o/-euo or set would print its option table into the terminal.
const SET_LONG_OPTION_FLAG_PATTERN = /^[-+][abefhkmnptuvxBCHP]*o$/
const SHELL_OPTION_NAME_PATTERN = /^[a-z_]+$/
export type SetupScriptShebang = {
/** Lowercased interpreter basename, e.g. `bash` for `#!/usr/bin/env -S bash -e`. */
interpreter: string
/** Interpreter flags the generated runner replays through `set`, e.g. `['-euo', 'pipefail']`. */
shellOptions: string[]
}
/** True when `line` is a `#!` interpreter line (leading whitespace tolerated). */
export function isShebangLine(line: string): boolean {
return line.trimStart().startsWith('#!')
}
/** Parses the script's leading `#!` line, or null when it has none. */
export function parseSetupScriptShebang(script: string): SetupScriptShebang | null {
const firstLine = script.split('\n', 1)[0] ?? ''
if (!isShebangLine(firstLine)) {
return null
}
const tokens = firstLine.trim().slice(2).trim().split(/\s+/).filter(Boolean)
const interpreterIndex = findInterpreterIndex(tokens)
if (interpreterIndex === -1) {
return null
}
return {
interpreter: executableBasename(tokens[interpreterIndex]),
shellOptions: parseShellOptions(tokens.slice(interpreterIndex + 1))
}
}
/** True when the script's first line is a `#!` line naming a POSIX shell. */
export function scriptDeclaresPosixShell(script: string): boolean {
const shebang = parseSetupScriptShebang(script)
return shebang !== null && POSIX_SHELL_BASENAMES.has(shebang.interpreter)
}
/** Drops a leading `#!` line; the generated runner carries its own interpreter line. */
export function stripLeadingShebangLine(script: string): string {
if (!isShebangLine(script.split('\n', 1)[0] ?? '')) {
return script
}
const lineEnd = script.indexOf('\n')
return lineEnd === -1 ? '' : script.slice(lineEnd + 1)
}
function findInterpreterIndex(tokens: string[]): number {
for (let index = 0; index < tokens.length; index++) {
const basename = executableBasename(tokens[index])
// Why: `env` (and its `-S` split-string form) only forwards to the real interpreter.
if (basename === '' || basename === 'env' || basename.startsWith('-')) {
continue
}
return index
}
return -1
}
function parseShellOptions(tokens: string[]): string[] {
const options: string[] = []
for (let index = 0; index < tokens.length; index++) {
const token = tokens[index]
if (SET_LONG_OPTION_FLAG_PATTERN.test(token)) {
const optionName = tokens[index + 1]
if (optionName && SHELL_OPTION_NAME_PATTERN.test(optionName)) {
options.push(token, optionName)
index++
}
continue
}
if (SET_OPTION_FLAG_PATTERN.test(token)) {
options.push(token)
}
}
return options
}
function executableBasename(token: string): string {
return (
token
.replaceAll('\\', '/')
.split('/')
.pop()
?.toLowerCase()
.replace(/\.exe$/, '') ?? ''
)
}