mirror of
https://github.com/garrytan/gstack.git
synced 2026-11-02 15:04:37 +01:00
garrytanandBit0ps
998f116b6d
A root DESIGN.md is the design system /design-consultation writes, so preferring it unconditionally reviewed plans against a token file while printing "Design doc found" and never looked at docs/designs/ feature docs. Discovery now considers only docs/designs/*.md as the repo-local design doc (still freshness-compared with the private ~/.gstack copy). The CEO finding fixture seeds its supplied design as a docs/designs doc and its test follows. Co-authored-by: Bit0ps <alex.dreamscaper@gmail.com>
50 lines
2.6 KiB
TypeScript
50 lines
2.6 KiB
TypeScript
/**
|
|
* {{DESIGN_DOC_DISCOVERY}} — the canonical design-doc discovery block (#703).
|
|
*
|
|
* Finds the design doc a plan review should read: newest branch-scoped doc
|
|
* under ~/.gstack/projects/<slug>/, falling back to newest project-scoped
|
|
* doc, then lets a repo-local feature doc (docs/designs/*.md) win when
|
|
* it is at least as fresh. A root DESIGN.md is never a design doc: it is the
|
|
* design system /design-consultation writes, and preferring it reviewed
|
|
* plans against a token file while printing "Design doc found" (#2839). office-hours dual-writes docs/designs/ alongside
|
|
* ~/.gstack, and the committed copy is what teammates see — but a stale old
|
|
* repo doc must never shadow a newer private session.
|
|
*
|
|
* Single source of truth for the freshness-preference logic that previously
|
|
* lived verbatim in plan-ceo-review, plan-eng-review, plan-devex-review, and
|
|
* the prerequisite-skill re-check in review.ts (GStack 2 fork-port wave,
|
|
* time-attack/gstack). Drift between copies meant plan reviews could
|
|
* disagree about which design doc wins.
|
|
*
|
|
* The fragment carries no code fences — the {{DESIGN_DOC_DISCOVERY}} token
|
|
* sits inside each caller's ```bash block. Callers must set $SLUG and
|
|
* $BRANCH first (and `setopt +o nomatch` for zsh); the block sets $DESIGN
|
|
* and prints "Design doc found: ..." or "No design doc found".
|
|
*/
|
|
|
|
import type { TemplateContext } from './types';
|
|
|
|
/**
|
|
* Raw canonical fragment, exported so TS resolvers (review.ts's prerequisite
|
|
* re-check) can interpolate it into their own template strings instead of
|
|
* embedding a drifting copy.
|
|
*/
|
|
export const DESIGN_DOC_DISCOVERY_BLOCK = `_LOCALDOC=$(ls -t ~/.gstack/projects/$SLUG/*-$BRANCH-design-*.md 2>/dev/null | head -1)
|
|
[ -z "$_LOCALDOC" ] && _LOCALDOC=$(ls -t ~/.gstack/projects/$SLUG/*-design-*.md 2>/dev/null | head -1)
|
|
# Repo-local docs win when at least as fresh (#703): office-hours dual-writes
|
|
# docs/designs/ alongside ~/.gstack, and the committed copy is what teammates
|
|
# see. A stale old repo doc never shadows a newer private session.
|
|
_REPOTOP=$(git rev-parse --show-toplevel 2>/dev/null || echo "")
|
|
_REPODOC=""
|
|
# Only docs/designs/ holds feature design docs; a root DESIGN.md is the design system (#2839).
|
|
[ -n "$_REPOTOP" ] && _REPODOC=$(ls -t "$_REPOTOP"/docs/designs/*.md 2>/dev/null | head -1)
|
|
DESIGN="$_LOCALDOC"
|
|
if [ -n "$_REPODOC" ] && { [ -z "$_LOCALDOC" ] || [ "$_REPODOC" -nt "$_LOCALDOC" ]; }; then
|
|
DESIGN="$_REPODOC"
|
|
fi
|
|
[ -n "$DESIGN" ] && echo "Design doc found: $DESIGN" || echo "No design doc found"`;
|
|
|
|
export function generateDesignDocDiscovery(_ctx: TemplateContext): string {
|
|
return DESIGN_DOC_DISCOVERY_BLOCK;
|
|
}
|