66878996dd
Squashed integration of the user-facing message audit for this surface set. Full per-finding receipts: /tmp/ux-audit/lanes/*-receipt.md (campaign artifacts).
89 lines
3.5 KiB
TypeScript
89 lines
3.5 KiB
TypeScript
/**
|
|
* User-facing copy for a failed first-run install (bootstrap).
|
|
*
|
|
* The install runner reports the manifest stage name that failed (see
|
|
* electron/bootstrap-runner.ts and the stage manifests in scripts/install.ps1 /
|
|
* scripts/install.sh) plus the raw error text. This module turns that into an
|
|
* Error.message the install overlay can show verbatim: a plain lead sentence
|
|
* naming the step in everyday words and what to do next, with the raw error on
|
|
* a trailing "Details:" line.
|
|
*
|
|
* Pure module: no Electron imports, unit-tested next to it.
|
|
*/
|
|
|
|
/** Manifest stage name -> everyday label. Unknown names fall back to humanizeStageName. */
|
|
export const BOOTSTRAP_STAGE_LABELS: ReadonlyMap<string, string> = new Map([
|
|
// scripts/install.ps1 manifest
|
|
['uv', 'Package installer'],
|
|
['git', 'Git'],
|
|
['node', 'Node.js'],
|
|
['system-packages', 'System packages'],
|
|
['repository', 'Hermes source code'],
|
|
['python', 'Python runtime'],
|
|
['venv', 'Python environment'],
|
|
['dependencies', 'Python packages'],
|
|
['node-deps', 'Browser tool packages'],
|
|
['desktop', 'Desktop app build'],
|
|
['platform-sdks', 'Platform tools'],
|
|
['configure', 'Settings'],
|
|
['config-templates', 'Settings templates'],
|
|
['path', 'Hermes command'],
|
|
['gateway', 'Hermes service'],
|
|
['bootstrap-marker', 'Finishing touches'],
|
|
// scripts/install.sh manifest (names that differ from the Windows one)
|
|
['prerequisites', 'System prerequisites'],
|
|
['python-deps', 'Python packages'],
|
|
['config', 'Settings'],
|
|
['setup', 'Settings'],
|
|
['complete', 'Finishing touches']
|
|
])
|
|
|
|
/** `system-packages` -> `System packages`. */
|
|
export function humanizeStageName(stage: string): string {
|
|
const words = stage.replace(/[-_]+/g, ' ').trim()
|
|
|
|
return words ? words.charAt(0).toUpperCase() + words.slice(1) : ''
|
|
}
|
|
|
|
export function bootstrapStageLabel(stage: string | null | undefined): string | null {
|
|
if (!stage) {
|
|
return null
|
|
}
|
|
|
|
return BOOTSTRAP_STAGE_LABELS.get(stage) ?? humanizeStageName(stage)
|
|
}
|
|
|
|
const BOOTSTRAP_FAILURE_REMEDY =
|
|
'Common causes: no internet connection, antivirus blocking the installer, or another copy of Hermes running. ' +
|
|
'Close other Hermes windows and choose Reload and retry; if it fails again, open the logs and send them to support.'
|
|
|
|
/**
|
|
* Build the Error.message for a failed bootstrap. First line is the plain
|
|
* explanation; the raw error follows on its own "Details:" line.
|
|
*/
|
|
export function describeBootstrapFailure(failedStage: string | null | undefined, rawError: unknown): string {
|
|
const label = bootstrapStageLabel(failedStage)
|
|
|
|
const lead = label
|
|
? `Setting up Hermes stopped during the '${label}' step.`
|
|
: 'Setting up Hermes stopped before it could finish.'
|
|
|
|
const details = typeof rawError === 'string' && rawError.trim() ? rawError.trim() : 'unknown error'
|
|
|
|
return `${lead} ${BOOTSTRAP_FAILURE_REMEDY}\nDetails: ${details}`
|
|
}
|
|
|
|
/**
|
|
* Error.message for an installed Hermes with a piece missing (source tree,
|
|
* Python environment). The renderer's install overlay offers the Repair install
|
|
* button ('hermes:bootstrap:repair'), so the copy points there. `whatIsMissing`
|
|
* names the missing part and its path, e.g. "Python environment missing at /x".
|
|
*/
|
|
export function missingInstallPartMessage(whatIsMissing: string): string {
|
|
return (
|
|
"Part of Hermes' installation is missing (it may have been deleted or quarantined by antivirus). " +
|
|
'Choose Repair install below to put it back — your chats and settings are not affected. ' +
|
|
`Details: ${whatIsMissing}`
|
|
)
|
|
}
|