mirror of
https://github.com/garrytan/gstack.git
synced 2026-10-31 22:14:25 +01:00
* feat(gen-skill-docs): add --plan-mode=off to omit the plan-mode preamble (#3168)
Generated skills ship a ~1.8 KB "## Plan Mode Safe Operations" +
"## Skill Invocation During Plan Mode" block on every skill, for hosts
and users who never enter plan mode. This adds a --plan-mode=off flag to
gen-skill-docs that drops that block at gen time. Default builds
(planMode undefined or true) keep the block byte-identically.
The "PLAN MODE EXCEPTION — ALWAYS RUN" markers inside skill bodies
still apply when the flag is off.
(cherry picked from commit 51edee9915)
* style(types): fix stray indentation on TemplateContext.installRoot
Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
* feat(config): plan_mode_preamble key wires --plan-mode=off into setup and every installed render
gstack-config plan_mode_preamble (on|off, default on) makes ./setup pass
--plan-mode=off to every gen:skill-docs render, gbrain-refresh and the
gstack-relink router render. The default Claude install, which otherwise
serves the committed SKILL.md files, gets a plain render with the key off;
the activation record notes plan_mode=off so switching back on removes the
render, including on the gbrain=unknown keep branch. With the key on or
unset every path and record is byte-for-byte unchanged.
Fixes #3168. Finishes #3213 by @xingzihai.
Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
* fix(setup,relink): plan_mode_preamble=off survives builds and failed renders; alias follows the router
Review findings on the plan_mode_preamble wiring:
- a build renders env hosts without --plan-mode=off, so with the key off
setup no longer skips their re-render after a build;
- with the key off the gbrain-absent branch leaves the render to the plain
re-render, so a failed render keeps the previous one;
- gstack-relink refreshes the _gstack-command alias after re-rendering the
router (also fixes the same staleness for disabled_skills).
Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
---------
Co-authored-by: xingzihai <xingzihai@users.noreply.github.com>
Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
139 lines
5.5 KiB
TypeScript
139 lines
5.5 KiB
TypeScript
import { ALL_HOST_CONFIGS } from '../../hosts/index';
|
|
|
|
/**
|
|
* Host type — derived from host configs in hosts/*.ts.
|
|
* Adding a new host: create hosts/myhost.ts + add to hosts/index.ts.
|
|
* Do NOT hardcode host names here.
|
|
*/
|
|
export type Host = (typeof ALL_HOST_CONFIGS)[number]['name'];
|
|
|
|
export interface HostPaths {
|
|
skillRoot: string;
|
|
localSkillRoot: string;
|
|
binDir: string;
|
|
browseDir: string;
|
|
designDir: string;
|
|
makePdfDir: string;
|
|
}
|
|
|
|
/**
|
|
* Make a host path safe to interpolate INSIDE DOUBLE QUOTES in generated bash.
|
|
*
|
|
* Tilde-based hosts (Claude, factory) resolve to paths like
|
|
* `~/.claude/skills/gstack/bin`. Bash only performs tilde expansion when the
|
|
* `~` is UNQUOTED, so `"~/.claude/..."` is a literal relative path that never
|
|
* resolves. A `[ -x "~/..." ]` test is therefore always false and a
|
|
* `"~/..." --flag` invocation always fails — the surrounding block silently
|
|
* becomes dead code rather than erroring.
|
|
*
|
|
* Env-var hosts already use `$GSTACK_BIN`, which expands correctly when
|
|
* quoted, so they pass through untouched.
|
|
*
|
|
* Use this ONLY where the path lands inside double quotes. Unquoted
|
|
* interpolations (`${ctx.paths.binDir}/gstack-slug`) expand fine as-is and are
|
|
* left alone so generated docs keep the more readable `~`.
|
|
*/
|
|
export function quoteSafePath(hostPath: string): string {
|
|
return hostPath.startsWith('~/') ? `$HOME/${hostPath.slice(2)}` : hostPath;
|
|
}
|
|
|
|
/**
|
|
* HOST_PATHS — derived from host configs.
|
|
* Each config's globalRoot/localSkillRoot determines the path structure.
|
|
* Non-Claude hosts use $GSTACK_ROOT env vars (set by preamble).
|
|
*/
|
|
function buildHostPaths(): Record<string, HostPaths> {
|
|
const paths: Record<string, HostPaths> = {};
|
|
for (const config of ALL_HOST_CONFIGS) {
|
|
if (config.usesEnvVars) {
|
|
paths[config.name] = {
|
|
skillRoot: '$GSTACK_ROOT',
|
|
localSkillRoot: config.localSkillRoot,
|
|
binDir: '$GSTACK_BIN',
|
|
browseDir: '$GSTACK_BROWSE',
|
|
designDir: '$GSTACK_DESIGN',
|
|
makePdfDir: '$GSTACK_MAKE_PDF',
|
|
};
|
|
} else {
|
|
const root = `~/${config.globalRoot}`;
|
|
paths[config.name] = {
|
|
skillRoot: root,
|
|
localSkillRoot: config.localSkillRoot,
|
|
binDir: `${root}/bin`,
|
|
browseDir: `${root}/browse/dist`,
|
|
designDir: `${root}/design/dist`,
|
|
makePdfDir: `${root}/make-pdf/dist`,
|
|
};
|
|
}
|
|
}
|
|
return paths;
|
|
}
|
|
|
|
export const HOST_PATHS: Record<string, HostPaths> = buildHostPaths();
|
|
|
|
/**
|
|
* Render a HostPaths binary dir as a shell-expandable absolute path.
|
|
* Claude-style dirs are `~`-rooted (e.g. `~/.claude/skills/gstack/browse/dist`)
|
|
* and expand via `$HOME`; env-var hosts already carry an absolute `$GSTACK_*`
|
|
* value, so they pass through untouched — prepending `$HOME` would double it.
|
|
*/
|
|
export function toShellPath(dir: string): string {
|
|
return dir.startsWith('~') ? `$HOME${dir.slice(1)}` : dir;
|
|
}
|
|
|
|
import type { Model } from '../models';
|
|
export type { Model } from '../models';
|
|
|
|
export interface TemplateContext {
|
|
skillName: string;
|
|
tmplPath: string;
|
|
benefitsFrom?: string[];
|
|
host: Host;
|
|
paths: HostPaths;
|
|
preambleTier?: number; // 1-4, controls which preamble sections are included
|
|
model?: Model; // model family for behavioral overlay. Omitted/undefined → no overlay.
|
|
interactive?: boolean; // true → emit plan-mode handshake in preamble. Generator-only, not written to SKILL.md.
|
|
/**
|
|
* Build-time compression mode. Defaults to 'default'.
|
|
*
|
|
* - 'default': full preamble prose ships as today (writing style, completeness,
|
|
* confusion protocol, context health are all present).
|
|
* - 'terse': writing-style + completeness + confusion-protocol + context-health
|
|
* sections are compressed to a one-line pointer at gen time. Saves ~2.6 KB
|
|
* per tier-2+ skill (measured 2,611 B on the v1.71 render — re-measure with
|
|
* a terse vs default build diff if the preamble changes shape again).
|
|
* Opt-in via `--explain-level=terse` build flag for
|
|
* users who want shipped skills to match their runtime preference and
|
|
* avoid the per-session terse-mode prose.
|
|
*
|
|
* Default builds keep the runtime-conditional behavior intact (Writing Style
|
|
* section says "skip entirely if EXPLAIN_LEVEL: terse appears in preamble echo").
|
|
* Terse builds make the compression structural — bytes never ship in the first place.
|
|
*/
|
|
explainLevel?: 'default' | 'terse';
|
|
/**
|
|
* Install-context render contract (docs/ADDING_A_HOST.md): absolute install
|
|
* root a per-install render serves (`gen-skill-docs --install-root`).
|
|
* null/undefined = the host's default root (committed render, unchanged bytes).
|
|
*/
|
|
installRoot?: string | null;
|
|
/**
|
|
* Plan-mode preamble block. Defaults to true (block ships).
|
|
* false (opt-in via `--plan-mode=off`): the "## Plan Mode Safe Operations" +
|
|
* "## Skill Invocation During Plan Mode" section is dropped from the
|
|
* preamble. "PLAN MODE EXCEPTION — ALWAYS RUN" markers inside skill bodies
|
|
* still apply.
|
|
*/
|
|
planMode?: boolean;
|
|
}
|
|
|
|
/** Resolver function signature. args is populated for parameterized placeholders like {{INVOKE_SKILL:name}}. */
|
|
export type ResolverFn = (ctx: TemplateContext, args?: string[]) => string;
|
|
|
|
// NOTE: a gated-resolver mechanism (ResolverEntry { resolve, appliesTo } +
|
|
// unwrapResolver) lived here, fully built and tested — and never used by a
|
|
// single one of the 65 registry entries. Per-skill gating happens either at
|
|
// the template level ({{NAME}} is already conditional) or, where it truly
|
|
// exists, via explicit ctx.skillName branches inside resolvers. Deleted
|
|
// rather than kept as speculative API.
|