Files
orca/src/main/shell-templates.ts
T
OrcaWin 2847bbe9e8 [comment audit] Consolidate completed code comment cleanup
Combine the completed comment cleanup from 319 stacked PRs into one change against `main`, so the full CI suite validates the combined result once. This replaces the previous audit stack; no additional audit work is included.

The change shortens redundant comments across 2,753 source and shell-snapshot files (25,235 net lines removed). Conflicts preserve current-main executable code. Runtime behavior, test assertions, directives, licenses, generated notices, SAFETY rationales, and compatibility markers are preserved. The audit tracker remains local, outside the repository.

Validation:
- Equivalent source/emitted AST and executable tokens across all 2,750 source files, with separate checks for embedded shell, SQL, JavaScript, CSS, and generated fixtures.
- Identical executable lines in the three shell snapshots; protected comments unchanged.
- Changed-code quality gate passed with no new findings.
- 358 tests passed, 2 skipped across 23 focused test files.
- `git diff --check` passed.
2026-10-23 13:15:45 -07:00

118 lines
4.9 KiB
TypeScript

import { SHELL_STARTUP_FEATURE_ENV } from './shell-startup-features'
import { POSIX_SHELL_STARTUP_COMMAND_ENV } from './pty/posix-shell-startup-command'
export const ZSH_WRAPPER_DIR_MARKER_FILE = '.orca-shell-wrapper'
export const ZSH_WRAPPER_DIR_MARKER_CONTENT = `# Orca-generated zsh startup wrapper directory.
# Its presence is how Orca recognises its own wrapper dir instead of treating it
# as the user's ZDOTDIR. Do not edit; the whole directory is regenerated.
`
// Consume feature env before user config so children cannot inherit the selection.
export const ZSH_FEATURE_CHANNEL_BLOCK = `builtin typeset -ga _orca_shell_features
_orca_shell_features=(\${(s:,:)\${${SHELL_STARTUP_FEATURE_ENV}:-}})
builtin unset ${SHELL_STARTUP_FEATURE_ENV}
# Consume now: user config can drop the deferred hook, leaving exported history state to leak into children.
builtin typeset -g _orca_histfile="\${ORCA_HISTFILE:-}"
builtin unset ORCA_HISTFILE
__orca_has_feature() { (( \${_orca_shell_features[(Ie)$1]} )) }`
export const BASH_FEATURE_CHANNEL_BLOCK = `_orca_shell_features=",\${${SHELL_STARTUP_FEATURE_ENV}:-},"
builtin unset ${SHELL_STARTUP_FEATURE_ENV}
__orca_has_feature() { [[ "$_orca_shell_features" == *",$1,"* ]]; }`
export const SHELL_STARTUP_IDENTITY_MARKER_BLOCK = `__orca_has_feature identity && printf "\\033]777;orca-shell-start:%s\\007" "$$"`
// Restore and consume ZDOTDIR before user startup files; reject stale Orca wrapper paths.
export const ZSH_ZDOTDIR_HANDBACK_BLOCK = `__orca_usable_zdotdir() {
[[ -n "\${1:-}" ]] || return 1
[[ "$1" != */shell-ready/zsh ]] || return 1
[[ ! -f "$1/${ZSH_WRAPPER_DIR_MARKER_FILE}" ]] || return 1
# Reject empty config roots so stale wrapper state cannot hide the user's real .zshenv.
local _orca_startup_file
for _orca_startup_file in .zshenv .zshrc .zprofile .zlogin; do
[[ -r "$1/$_orca_startup_file" ]] && return 0
done
return 1
}
if __orca_usable_zdotdir "\${ORCA_ORIG_ZDOTDIR:-}"; then
builtin export ZDOTDIR="$ORCA_ORIG_ZDOTDIR"
else
builtin unset ZDOTDIR
fi
builtin unset ORCA_ORIG_ZDOTDIR ORCA_ZSHENV_SOURCE_DIR
builtin unfunction __orca_usable_zdotdir`
// Parse registration before user code can switch emulation; source at top level to preserve scope.
export const ZSH_USER_ZSHENV_SOURCE_BLOCK = `{
builtin typeset _orca_user_zshenv="\${ZDOTDIR-$HOME}/.zshenv"
[[ ! -r "$_orca_user_zshenv" ]] || builtin source -- "$_orca_user_zshenv"
} always {
builtin unset _orca_user_zshenv
if (( ! $+_orca_deferred_init_done )); then
builtin typeset -ag precmd_functions
(( \${precmd_functions[(Ie)__orca_deferred_init]} )) || precmd_functions+=(__orca_deferred_init)
__orca_arm_deferred_line_init
fi
}`
export { BASH_PROMPT_COMMAND_COMPOSITION_BLOCK } from './bash-prompt-command-composition'
// zle-line-init runs after line editing starts; emit before user hooks can fail and suppress readiness.
export function getZshShellReadyMarkerRegistrationBlock(
escapedMarker: string,
supportsStartupCommand = false
): string {
const markerBlock = supportsStartupCommand
? ` if [[ "\${__orca_emit_ready_marker-1}" == 1 ]]; then
printf "${escapedMarker}"
fi`
: ` printf "${escapedMarker}"`
const startupCommandBlock = supportsStartupCommand
? `
if (( \${+${POSIX_SHELL_STARTUP_COMMAND_ENV}} )); then
BUFFER="\$${POSIX_SHELL_STARTUP_COMMAND_ENV}"
CURSOR=\${#BUFFER}
builtin unset ${POSIX_SHELL_STARTUP_COMMAND_ENV}
zle accept-line
fi`
: ''
return `# Preserve the original user widget across re-sourcing; builtin/completion widgets cannot chain as plain functions.
if [[ "\${widgets[zle-line-init]:-}" == "user:__orca_prompt_mark" ]]; then
:
elif (( \${+widgets[zle-line-init]} )) && [[ "\${widgets[zle-line-init]}" == user:* ]]; then
__orca_prev_line_init_fn="\${widgets[zle-line-init]#user:}"
else
__orca_prev_line_init_fn=""
fi
__orca_prompt_mark() {
${markerBlock}
# Call as a function so $WIDGET remains zle-line-init for add-zle-hook-widget dispatchers.
if [[ -n "\${__orca_prev_line_init_fn:-}" ]]; then
"\${__orca_prev_line_init_fn}" "$@"
fi${startupCommandBlock}
}
zle -N zle-line-init __orca_prompt_mark`.replace(/\n\n}\n$/, '\n}\n')
}
// fish_prompt runs after config but before bracketed-paste mode; PostReadyFlushGate covers that gap.
export function getFishShellReadyInitCommand(
escapedMarker: string,
emitReadyMarker = true,
supportsStartupCommand = false
): string {
const readyMarkerBlock = emitReadyMarker ? ` builtin printf "${escapedMarker}"\n` : ''
const startupCommandBlock = supportsStartupCommand
? ` if set -q ${POSIX_SHELL_STARTUP_COMMAND_ENV}
set -l __orca_command "\$${POSIX_SHELL_STARTUP_COMMAND_ENV}"
set -e ${POSIX_SHELL_STARTUP_COMMAND_ENV}
builtin printf '%s\\n' "$__orca_command"
eval "$__orca_command"
return $status
end\n`
: ''
return `function __orca_shell_ready_marker --on-event fish_prompt
${readyMarkerBlock} functions -e __orca_shell_ready_marker
${startupCommandBlock}end`
}