Files
bare-operating-system/packages/bare-os-seeder/kernel/bin/sh
T
Raven Scott aa81fbff5b Close the BareOS shell + Fish REPL roadmap tracker and ship the remaining
shell surfaces in-tree.
Roadmap / CI
- docs/data/shell-roadmap-features.json: all shell-001…shell-100 rows and
  P1–P8 phases marked implemented; note documents closure date and pointers.
- scripts/verify-shell-roadmap.mjs: validate JSON (schema 1, 8 phases,
  100 implemented items) plus existing source needles; wire npm run
  verify:shell-roadmap into root pretest (package.json).
- scripts/README.md: document verifier behavior.
Lexer & expansion (packages/bare-os-booter/lib)
- shell-lex.js: central lexShellLine; ANSI-C $'…' via decodeBareOsDollarQuote;
  keep diagnostics/tokenizer aligned with execution tokenizer.
- shell.js: stray reserved words at statement start → syntax error exit 2;
  optional [[ … ]] when BARE_OS_SHELL_DOUBLE_BRACKET=1 (==, !=);
  alias expansion before function dispatch (ordering tests);
  expandWordWithCmdSubst: balanced $(…) vs skipped $((…)); backtick
  command substitution when BARE_OS_SHELL_CMDSUBST; default ctx.execLine for
  nested cmdsubst when unset; index passthrough for DOUBLE_BRACKET env.
- shell-glob.js: ~login → HOME when USER matches, else /home/login (bounded
  login pattern); tests for pathname + execShellLine.
- shell-tokenizer.js: align with shell-lex detailed spans/modes where needed.
Completion / REPL
- completion-engine.js: completion depth / collectors per shell program work.
- packages/bare-os-booter/index.js: small wiring for shell env passthrough.
/bin/sh front-end
- packages/bare-os-coreutils/src/sh.js; kernel/bin/sh; seeder copies: stay in
  sync with shell behavior and env flags.
Tests
- packages/bare-os-booter/test.js: coverage for misplaced reserved words,
  gated [[ ]], alias vs function, ~user/~~ paths, $'…', cmdsubst $(…) and
  backticks, and related regressions.
Documentation
- docs/reference/shell-grammar.md: $'…', $(…) / backticks vs $((…)).
- handbook/09-posix-utilities-shell-and-vfs.md, environment appendix,
  shell-troubleshooting / shell-unsupported-behavior, release checklist,
  docs/reference/README.md: shell behavior and operator surfaces.
- developer-guide/19-how-to-fish-keybinding-completer.md: Fish keybinding /
  completer how-to (new).
Generated / synced artifacts
- kernel/lib/bare/manifest.json, kernel/share/man/man.json,
  kernel/lib/bare/shell-completion.json, posix_utilities.json,
  docs/audit/bundle-health.json: regenerated or synced with tooling.
- scripts/bench-shell-phases.mjs: bench script touch.
2026-04-27 00:41:06 -04:00

246 lines
6.8 KiB
Plaintext

/* BARE_OS_BIN_API 1.0.0 — bump when staged /bin script semantics change (see developer guide). */
/** Shared helpers for drive-resident /bin scripts (prepended before each command). */
function bareStdin(ctx) {
return typeof ctx.shellStdin === 'string' ? ctx.shellStdin : ''
}
/** @param {number} mode @param {'file' | 'directory' | 'symlink'} type */
function bareFormatModeString(mode, type) {
const typeChar = type === 'directory' ? 'd' : type === 'symlink' ? 'l' : '-'
const perm = mode & 0o777
const r = (bit) => (perm & bit ? 'r' : '-')
const w = (bit) => (perm & bit ? 'w' : '-')
const x = (bit) => (perm & bit ? 'x' : '-')
return (
typeChar +
r(0o400) +
w(0o200) +
x(0o100) +
r(0o040) +
w(0o020) +
x(0o010) +
r(0o004) +
w(0o002) +
x(0o001)
)
}
/** @param {number} mtimeMs @param {number} [nowMs] */
function bareFormatLsMtime(mtimeMs, nowMs) {
const now = nowMs != null ? nowMs : Date.now()
const d = new Date(mtimeMs)
const months = [
'Jan',
'Feb',
'Mar',
'Apr',
'May',
'Jun',
'Jul',
'Aug',
'Sep',
'Oct',
'Nov',
'Dec'
]
const mon = months[d.getMonth()]
const day = String(d.getDate()).padStart(2, ' ')
const sixMo = 180 * 24 * 3600 * 1000
if (Math.abs(now - mtimeMs) > sixMo) {
const yr = String(d.getFullYear()).padStart(4, ' ')
return mon + ' ' + day + ' ' + yr
}
const hh = String(d.getHours()).padStart(2, '0')
const mm = String(d.getMinutes()).padStart(2, '0')
return mon + ' ' + day + ' ' + hh + ':' + mm
}
/** @param {number} size */
function barePosixBlocks(size) {
return Math.ceil(Number(size) / 512) || 0
}
/**
* Raw stdout for NUL/binary when **`process.stdout.write`** is missing.
* If **`ctx.bareOsBinWrite(Uint8Array|string)`** is set (tests / host), use it.
* @param {Record<string, unknown>} ctx
* @param {string | Uint8Array} chunk
* @returns {boolean}
*/
function bareOsEmitRaw(ctx, chunk) {
if (typeof ctx.bareOsBinWrite === 'function') {
const b4 = ctx.b4a
const u8 =
typeof chunk === 'string'
? b4 && typeof b4.from === 'function'
? b4.from(chunk)
: new TextEncoder().encode(chunk)
: chunk
ctx.bareOsBinWrite(u8 instanceof Uint8Array ? u8 : new Uint8Array(u8))
return true
}
const w = globalThis.process?.stdout?.write
if (typeof w === 'function') {
w.call(globalThis.process.stdout, chunk)
return true
}
return false
}
async function run(ctx, argv) {
if (argv.length < 2) {
ctx.console.error('usage: sh [-eu] [-s | -c COMMAND | SCRIPT]')
ctx.exitCode = 2
return
}
if (typeof ctx.execLine !== 'function') {
ctx.console.error('sh: execLine is not available (requires a Bare OS booter session)')
ctx.exitCode = 1
return
}
const vfsEnv =
ctx.vfs?.env && typeof ctx.vfs.env === 'object' ? ctx.vfs.env : null
let i = 1
let sawFlags = false
while (i < argv.length) {
const a = argv[i]
if (a === '--') {
i++
break
}
if (a === '-' || !a.startsWith('-')) break
if (a === '-c' || a === '-s') break
sawFlags = true
for (const ch of a.slice(1)) {
if (ch === 'e' && vfsEnv) vfsEnv.BARE_OS_SHELL_ERREXIT = '1'
else if (ch === 'u' && vfsEnv) vfsEnv.BARE_OS_SHELL_NOUNSET = '1'
else if (ch === 'v' && vfsEnv) vfsEnv.BARE_OS_SHELL_XTRACE = '1'
else if (ch === 'x' && vfsEnv) vfsEnv.BARE_OS_SHELL_XTRACE = '1'
else if (ch === 'C' && vfsEnv) vfsEnv.BARE_OS_SHELL_NOCLOBBER = '1'
}
i++
}
const mode = argv[i]
if (mode == null && !sawFlags) {
ctx.console.error('usage: sh [-eu] [-s | -c COMMAND | SCRIPT]')
ctx.exitCode = 2
return
}
if (mode === '-c') {
const command = argv[i + 1]
if (command == null) {
ctx.console.error('sh: option requires an argument -- c')
ctx.console.error('usage: sh -c COMMAND [NAME [ARG ...]] | sh SCRIPT')
ctx.exitCode = 2
return
}
const env = ctx.vfs?.env
/** @type {Record<string, string | undefined> | null} */
const saved = env && typeof env === 'object' ? {} : null
if (saved && env) {
for (const k of ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '#']) {
saved[k] = env[k]
}
env['0'] = argv[i + 3] ?? 'sh'
const args = argv.slice(i + 4)
for (let j = 1; j <= 9; j++) env[String(j)] = args[j - 1] ?? ''
env['#'] = String(args.length)
}
try {
await ctx.execLine(command)
} finally {
if (saved && env) {
for (const [k, v] of Object.entries(saved)) {
if (v == null) delete env[k]
else env[k] = v
}
}
}
return
}
if (mode === '-s') {
const stdinText =
typeof ctx.shellStdin === 'string'
? ctx.shellStdin
: typeof ctx.shellStdin === 'object' &&
ctx.shellStdin &&
'data' in ctx.shellStdin
? String(/** @type {{ data?: string }} */ (ctx.shellStdin).data ?? '')
: ''
await runShScriptText(ctx, stdinText, { label: 'stdin' })
return
}
const script = mode
let buf
try {
buf = await ctx.vfs.readFile(script)
} catch (e) {
ctx.console.error('sh: ' + ((e && e.message) || String(e)))
ctx.exitCode = 1
return
}
if (buf == null) {
ctx.console.error('sh: ' + script + ': not found')
ctx.exitCode = 127
return
}
let text = ctx.b4a.toString(buf)
if (text.charCodeAt(0) === 0xfeff) text = text.slice(1)
text = text.replace(/^\ufeff/, '')
if (text.startsWith('#!')) {
const nl = text.indexOf('\n')
text = nl === -1 ? '' : text.slice(nl + 1)
}
await runShScriptText(ctx, text, { label: script })
}
/**
* @param {Record<string, unknown>} ctx
* @param {string} text
* @param {{ label: string }} meta
*/
async function runShScriptText(ctx, text, meta) {
text = String(text || '').replace(/\\\r?\n/g, '')
const lines = text.split(/\r?\n/)
const blocks = []
let cur = ''
let depth = 0
for (let i = 0; i < lines.length; i++) {
const raw = lines[i]
const trimmed = raw.trim()
if (!trimmed || trimmed.startsWith('#')) continue
cur += (cur ? '\n' : '') + raw
const words = trimmed
.replace(/[;(){}]/g, ' ')
.split(/\s+/)
.filter(Boolean)
for (const w of words) {
if (w === 'if' || w === 'for' || w === 'while' || w === 'until' || w === 'case')
depth++
else if (w === 'fi' || w === 'done' || w === 'esac') depth = Math.max(0, depth - 1)
}
if (depth === 0) {
blocks.push(cur)
cur = ''
}
}
if (cur.trim()) blocks.push(cur)
let lineNo = 1
for (const block of blocks) {
const env = ctx.vfs?.env
if (env && typeof env === 'object') {
env.BARE_OS_SH_SCRIPT_LABEL = meta.label
env.BARE_OS_SH_SCRIPT_LINE = String(lineNo)
}
await ctx.execLine(block)
lineNo += block.split(/\r?\n/).length
if ((Number(ctx.exitCode) || 0) !== 0) return
}
ctx.exitCode = 0
}