mirror of
https://github.com/garrytan/gstack.git
synced 2026-09-10 15:09:00 +02:00
refactor(hosts): defineHost() factory — 10 copy-paste host files become declarations
hosts/*.ts were ten copies of one file: runtimeRoot byte-identical in 9/10, pathRewrites mechanically derivable from the host name for 7/10, the 11-entry toolRewrites map byte-identical between openclaw and gbrain, and every asset change a 10-file edit (cursor and slate had already fallen out of three other hand-maintained lists). defineHost() owns the defaults; each host file now declares only what makes it different (slate/cursor: 8 lines each). Shared constants: CROSS_MODEL_RESOLVERS, GBRAIN_RESOLVERS, EXEC_STYLE_TOOL_REWRITES. Genuinely-different things stayed explicit: codex/factory $GSTACK_ROOT rewrites, hermes's tool vocabulary, claude's denylist+prefixable install, opencode's wider runtimeRoot. Proof: JSON.stringify(ALL_HOST_CONFIGS) dump-diff before/after EMPTY (and a runtime walk confirmed no function-valued or undefined-keyed fields, so the JSON diff is complete); gen:skill-docs --host all zero-diff; host-config + gen-skill-docs + idempotency suites 485/485. Host files 595 -> 285 lines. docs/ADDING_A_HOST.md teaches the factory pattern. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Fable 5
parent
7c309f7817
commit
408ee77cde
@@ -0,0 +1,167 @@
|
||||
/**
|
||||
* defineHost() factory — the single place the copy-paste across hosts/*.ts
|
||||
* used to live.
|
||||
*
|
||||
* Every field a host doesn't override gets the common external-host default:
|
||||
* paths derived from the host name (`.{name}/skills/gstack`), allowlist
|
||||
* frontmatter (name + description), no metadata sidecar, skip the codex
|
||||
* skill, the standard three-entry pathRewrite trio derived from the resolved
|
||||
* paths, the shared runtimeRoot asset list, and symlink-generated install.
|
||||
*
|
||||
* Defaults are constructed fresh per call, so no two host configs ever share
|
||||
* a mutable array/object. Fields that are absent today (staticFiles, adapter,
|
||||
* sidecar, toolRewrites, coAuthorTrailer, boundaryInstruction) stay absent
|
||||
* unless a host explicitly sets them — the factory never default-populates
|
||||
* optional fields (test/host-config.test.ts pins e.g. openclaw.adapter as
|
||||
* undefined).
|
||||
*/
|
||||
|
||||
import type { HostConfig } from '../scripts/host-config';
|
||||
|
||||
type PathRewrite = { from: string; to: string };
|
||||
|
||||
/**
|
||||
* Preamble resolvers that orchestrate cross-model second opinions (they shell
|
||||
* out to Codex or spin up the review army). Suppressed on hosts that can't or
|
||||
* shouldn't invoke other models — Codex itself (can't invoke itself) and the
|
||||
* non-Claude agent runtimes (OpenClaw, Hermes, GBrain).
|
||||
*/
|
||||
export const CROSS_MODEL_RESOLVERS: string[] = [
|
||||
'DESIGN_OUTSIDE_VOICES', // design.ts:485 — invokes Codex for outside voices
|
||||
'ADVERSARIAL_STEP', // review.ts:408 — invokes Codex adversarially
|
||||
'CODEX_SECOND_OPINION', // review.ts:257 — invokes Codex
|
||||
'CODEX_PLAN_REVIEW', // review.ts:541 — invokes Codex
|
||||
'REVIEW_ARMY', // review-army.ts:180 — multi-model orchestration
|
||||
];
|
||||
|
||||
/**
|
||||
* Brain-aware resolvers. Suppressed by default on every host — only hosts
|
||||
* that can run with a GBrain (hermes, gbrain) leave these active.
|
||||
*/
|
||||
export const GBRAIN_RESOLVERS: string[] = [
|
||||
'GBRAIN_CONTEXT_LOAD',
|
||||
'GBRAIN_SAVE_RESULTS',
|
||||
];
|
||||
|
||||
/**
|
||||
* Tool-name rewrites for OpenClaw-style agent runtimes (lowercase exec /
|
||||
* read / write / edit tools, sessions_spawn for subagents). OpenClaw and
|
||||
* GBrain share these byte-for-byte; spread into `toolRewrites` at the use
|
||||
* site so each config owns its own copy.
|
||||
*/
|
||||
export const EXEC_STYLE_TOOL_REWRITES: Record<string, string> = {
|
||||
'use the Bash tool': 'use the exec tool',
|
||||
'use the Write tool': 'use the write tool',
|
||||
'use the Read tool': 'use the read tool',
|
||||
'use the Edit tool': 'use the edit tool',
|
||||
'use the Agent tool': 'use sessions_spawn',
|
||||
'use the Grep tool': 'search for',
|
||||
'use the Glob tool': 'find files matching',
|
||||
'the Bash tool': 'the exec tool',
|
||||
'the Read tool': 'the read tool',
|
||||
'the Write tool': 'the write tool',
|
||||
'the Edit tool': 'the edit tool',
|
||||
};
|
||||
|
||||
/**
|
||||
* Host definition input: name + displayName are required, everything else is
|
||||
* an override on the common external-host defaults documented above.
|
||||
*
|
||||
* `extraPathRewrites` appends to the derived standard trio
|
||||
* (`~/.claude/skills/gstack` → `~/{globalRoot}`, `.claude/skills/gstack` →
|
||||
* localSkillRoot, `.claude/skills` → `{hostSubdir}/skills`). Hosts whose
|
||||
* rewrites aren't mechanically derivable (codex, factory use $GSTACK_ROOT and
|
||||
* an extra review rewrite; claude has none) replace the whole list via
|
||||
* `pathRewrites` instead. The two are mutually exclusive.
|
||||
*/
|
||||
export interface HostOverrides<N extends string = string>
|
||||
extends Partial<Omit<HostConfig, 'name' | 'displayName'>> {
|
||||
name: N;
|
||||
displayName: string;
|
||||
/** Appended after the derived pathRewrite trio. Mutually exclusive with `pathRewrites`. */
|
||||
extraPathRewrites?: PathRewrite[];
|
||||
}
|
||||
|
||||
export function defineHost<const N extends string>(overrides: HostOverrides<N>): HostConfig & { name: N } {
|
||||
const {
|
||||
name,
|
||||
displayName,
|
||||
cliCommand = name,
|
||||
cliAliases = [],
|
||||
globalRoot = `.${name}/skills/gstack`,
|
||||
localSkillRoot = `.${name}/skills/gstack`,
|
||||
hostSubdir = `.${name}`,
|
||||
usesEnvVars = true, // false only for Claude (literal ~ paths, no $GSTACK_ROOT)
|
||||
frontmatter = {
|
||||
mode: 'allowlist',
|
||||
keepFields: ['name', 'description'],
|
||||
descriptionLimit: null,
|
||||
},
|
||||
generation = {
|
||||
generateMetadata: false,
|
||||
skipSkills: ['codex'], // Codex skill is a Claude wrapper around codex exec
|
||||
},
|
||||
pathRewrites,
|
||||
extraPathRewrites,
|
||||
toolRewrites,
|
||||
suppressedResolvers = [...GBRAIN_RESOLVERS],
|
||||
runtimeRoot = {
|
||||
globalSymlinks: ['bin', 'browse/dist', 'browse/bin', 'gstack-upgrade', 'ETHOS.md'],
|
||||
globalFiles: {
|
||||
'review': ['checklist.md', 'TODOS-format.md'],
|
||||
},
|
||||
},
|
||||
sidecar,
|
||||
install = {
|
||||
prefixable: false,
|
||||
linkingStrategy: 'symlink-generated',
|
||||
},
|
||||
coAuthorTrailer,
|
||||
learningsMode = 'basic',
|
||||
boundaryInstruction,
|
||||
staticFiles,
|
||||
adapter,
|
||||
} = overrides;
|
||||
|
||||
if (pathRewrites && extraPathRewrites) {
|
||||
throw new Error(
|
||||
`[${name}] pathRewrites and extraPathRewrites are mutually exclusive: ` +
|
||||
`pathRewrites replaces the derived trio, extraPathRewrites appends to it`
|
||||
);
|
||||
}
|
||||
|
||||
const resolvedPathRewrites: PathRewrite[] = pathRewrites ?? [
|
||||
{ from: '~/.claude/skills/gstack', to: `~/${globalRoot}` },
|
||||
{ from: '.claude/skills/gstack', to: localSkillRoot },
|
||||
{ from: '.claude/skills', to: `${hostSubdir}/skills` },
|
||||
...(extraPathRewrites ?? []),
|
||||
];
|
||||
|
||||
// Field order below mirrors the HostConfig interface (and the original
|
||||
// hand-written configs) so serialized output is stable. Optional fields are
|
||||
// conditionally spread so absent overrides stay truly absent (no
|
||||
// `key: undefined` entries).
|
||||
return {
|
||||
name,
|
||||
displayName,
|
||||
cliCommand,
|
||||
cliAliases,
|
||||
globalRoot,
|
||||
localSkillRoot,
|
||||
hostSubdir,
|
||||
usesEnvVars,
|
||||
frontmatter,
|
||||
generation,
|
||||
pathRewrites: resolvedPathRewrites,
|
||||
...(toolRewrites !== undefined ? { toolRewrites } : {}),
|
||||
suppressedResolvers,
|
||||
runtimeRoot,
|
||||
...(sidecar !== undefined ? { sidecar } : {}),
|
||||
install,
|
||||
...(coAuthorTrailer !== undefined ? { coAuthorTrailer } : {}),
|
||||
learningsMode,
|
||||
...(boundaryInstruction !== undefined ? { boundaryInstruction } : {}),
|
||||
...(staticFiles !== undefined ? { staticFiles } : {}),
|
||||
...(adapter !== undefined ? { adapter } : {}),
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user