gcf-aif-ext 0.7.6 → 0.7.7

package/README.md

@@ -50,6 +50,11 @@ Updating preserves `gcf/`, `cnlp.config.json` and the pre-commit hook. Run `ai-f
 
 On Windows, run `extension add` and `extension update` from PowerShell or cmd, not Git Bash: the installer unpacks with `tar`, and Git Bash's GNU tar reads `C:\…` as a remote host (`Cannot connect to C: resolve failed`). The Windows `tar.exe` handles it.
 
+### 0.7.7
+
+- `ai-factory gcf config [--json]` lists the human's settings of `gcf/config.yml` with what each means; `gcf config set <key> --value=<v>` sets one, checked by the rules a read applies, the comments kept, one `gcf(config)` commit. An empty number goes back to its default. `gcf board --json` carries them as `settings`.
+- `gcf board --json` questions also carry `assumed`, `until`, `sys`, `lens` and `sections`: a D2 shows what it assumed and when it comes back, and every record where it came from.
+
 ### 0.7.6
 
 - `ai-factory gcf permissions [--on <group>] [--off <group>] [--deny <rule>] [--undeny <rule>]` — what agent runs may not do: deny groups and the human's own rules in the `agent:` section of `gcf/config.yml`, one `gcf(permissions)` commit; with no change it lists them. On by default: `git-destroy`, `mass-delete`, `publish`, `human-moves`, `guards`; off: `secrets`, `outside`, `processes`. `agent.groups` keeps only the human's choices (`secrets: true`): a group it does not name keeps its default, so one a later version adds comes on. `git push` is in none. `gcf board --json` carries `agent` (`groups`, `deny_extra`, the resolved `deny`, `allow`).

package/commands/gcf.js

@@ -977,6 +977,37 @@ function registerBoard(gcf) {
         ].join('\n'),
       );
     });
+  const config = gcf
+    .command('config')
+    .description("The human's settings of gcf/config.yml: list them, or set one (commit)")
+    // A misspelt subcommand would read as a stray word and list the settings, as if set.
+    .allowExcessArguments(false)
+    .option('--json', 'machine output')
+    .action(async (o) => {
+      const { gcfRoot, readConfig, readRawConfig } = await lib('gcf-paths');
+      await readConfig(gcfRoot()); // a config the rules refuse says so here
+      const list = (await lib('config-set')).settingsOf(await readRawConfig(gcfRoot()));
+      out(o.json, list, (x) =>
+        x.map((s) => `${s.key}: ${s.value ?? '-'}  # ${s.label}`).join('\n'),
+      );
+    });
+  config
+    .command('set <key>')
+    .description('Set one key; an empty --value= takes a number back to its default')
+    // The value only through --value: `set plan_passes 7` must not read as a reset. A value
+    // may start with a hyphen (a command's flag); as `--value=<text>` it stays one value.
+    .allowExcessArguments(false)
+    .requiredOption('--value <value>', 'the new value; empty (--value=) for the default')
+    .option('--no-commit', 'skip the commit (tests only)')
+    .action(async (key, o) => {
+      const r = await (
+        await lib('config-set')
+      ).setConfig(process.cwd(), key, o.value, {
+        commit: o.commit,
+      });
+      const now = `${r.key}: ${r.value ?? 'default'}`;
+      console.log(r.unchanged ? `${now} (unchanged)` : `${now}${shortHash(r.hash)}`);
+    });
   const many = (v, prev = []) => [...prev, v];
   gcf
     .command('permissions')

package/extension.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/lee-to/ai-factory/2.x/schemas/extension.schema.json",
   "name": "gcf-aif-ext",
-  "version": "0.7.6",
+  "version": "0.7.7",
   "description": "Game Context Framework for AI Factory",
   "skills": [
     "skills/gcf-init",

package/lib/agent-permissions.js

@@ -75,7 +75,7 @@ export const DENY_GROUPS = [
   {
     id: 'human-moves',
     label:
-      "the human's GCF moves: verdict, decide, answer, unblock, phase, pillars, permissions, setup",
+      "the human's GCF moves: verdict, decide, answer, unblock, phase, pillars, settings, permissions, setup",
     on: true,
     rules: shell(
       'ai-factory gcf verdict*',
@@ -85,6 +85,7 @@ export const DENY_GROUPS = [
       'ai-factory gcf phase next*',
       'ai-factory gcf pillar*',
       'ai-factory gcf permissions*',
+      'ai-factory gcf config set*',
       'ai-factory gcf hooks-install*',
       'ai-factory gcf-harness init*',
       'ai-factory gcf-harness run*',

package/lib/board.js

@@ -4,7 +4,7 @@ import { readFile } from 'node:fs/promises';
 import { existsSync } from 'node:fs';
 import path from 'node:path';
 import { buildLedger } from './ledger.js';
-import { readConfig } from './gcf-paths.js';
+import { readConfig, readRawConfig } from './gcf-paths.js';
 import { readLive } from './live.js';
 import { listInbox } from './inbox.js';
 import { phaseStatus } from './phase.js';
@@ -17,6 +17,7 @@ import { movesOf } from './transitions.js';
 import { listQuestions } from './questions.js';
 import { sessionActive } from './session-mark.js';
 import { agentOf } from './agent-permissions.js';
+import { settingsOf } from './config-set.js';
 
 // The version of the JSON below (Methodology §11): a board refuses one it does not know. Bump it
 // when a field changes meaning or goes away; a new field does not bump it.
@@ -232,6 +233,8 @@ export async function board(projectDir) {
     run_mode: config.run_mode,
     // What the harness hands its agent runs (Harness-PRD §7): the deny rules and the context limits.
     agent: agentOf(config),
+    // The human's settings of config.yml, each with its value and default (`gcf config set`).
+    settings: settingsOf(await readRawConfig(root)),
     context: {
       handoff_pct: config.context_handoff_pct,
       window: config.context_window,

package/lib/config-set.js

@@ -0,0 +1,167 @@
+// `gcf config set` (GCF-PRD §12.4): the human's settings of gcf/config.yml, one key at a time,
+// so a board edits them through the core and never writes the file itself. A change is checked
+// by the same rules a read applies before it is written; the rest of the file keeps its keys
+// and comments. `phases:` and `agent:` have their own commands and are not set here.
+import { readFile } from 'node:fs/promises';
+import { existsSync } from 'node:fs';
+import path from 'node:path';
+import { isDeepStrictEqual } from 'node:util';
+import YAML from 'yaml';
+import { commitMove } from './unit-ops.js';
+import { atomicWrite } from './safe-path.js';
+import { configOf, DEFAULT_CONFIG, gcfRoot, RUN_MODES } from './gcf-paths.js';
+
+/** @typedef {'number' | 'share' | 'mode' | 'command'} Kind */
+
+// Thrown inside the move to leave without a write or a commit.
+const NO_CHANGE = new Error('no change');
+
+/** @type {{ key: string, kind: Kind, label: string }[]} */
+export const SETTINGS = [
+  {
+    key: 'run_mode',
+    kind: 'mode',
+    label:
+      'how a run drives an item: worktree (several at once) or main (one at a time in the project folder)',
+  },
+  { key: 'dod.test', kind: 'command', label: "the project's test command for the DoD, or none" },
+  { key: 'dod.build', kind: 'command', label: "the project's build command for the DoD, or none" },
+  {
+    key: 'plan_passes',
+    kind: 'number',
+    label: 'improve passes a plan may take before the item blocks',
+  },
+  { key: 'dod_attempts', kind: 'number', label: 'DoD attempts before the item blocks' },
+  {
+    key: 'wip_built_limit',
+    kind: 'number',
+    label: 'items waiting for a verdict before new verdict work stops',
+  },
+  {
+    key: 'context_handoff_pct',
+    kind: 'share',
+    label:
+      'share of the context window at which a session hands its item to a fresh one (0: never)',
+  },
+  { key: 'context_window', kind: 'number', label: "context window in tokens (0: the model's)" },
+  {
+    key: 'auto_compact_pct',
+    kind: 'share',
+    label: 'share at which the agent compacts (0: its default; at least the handoff share + 15)',
+  },
+  { key: 'tune_limit', kind: 'number', label: 'tune verdicts an item may take' },
+  { key: 'unplayed_warn_after', kind: 'number', label: 'unplayed items before the audit warns' },
+  {
+    key: 'built_stale_after_commits',
+    kind: 'number',
+    label: 'commits after which a waiting or blocked item is stale',
+  },
+  {
+    key: 'question_stale_after_commits',
+    kind: 'number',
+    label: 'commits after which an open question is stale',
+  },
+  { key: 'context_budget', kind: 'number', label: "token budget of an item's readset" },
+  { key: 'pillars_budget', kind: 'number', label: 'token budget of PILLARS.md' },
+  {
+    key: 'envelope_default_spread',
+    kind: 'number',
+    label: 'default spread of a feel envelope around a GDD number (0.3: ±30%)',
+  },
+];
+
+const BY_KEY = new Map(SETTINGS.map((s) => [s.key, s]));
+
+/**
+ * Each setting with what the file sets (null: not set, the default holds) and its default:
+ * what a settings screen shows. `raw` is the parsed config.yml, before the defaults.
+ */
+export function settingsOf(raw) {
+  return SETTINGS.map((s) => {
+    const [head, sub] = s.key.split('.');
+    const parent = raw?.[head];
+    const value = sub
+      ? parent && typeof parent === 'object'
+        ? (parent[sub] ?? null)
+        : null
+      : (parent ?? null);
+    const def = sub ? null : head === 'run_mode' ? 'worktree' : (DEFAULT_CONFIG[head] ?? null);
+
+    return { ...s, value, default: def };
+  });
+}
+
+/** The value of `text` for a setting of `kind`; an empty number goes back to its default. */
+function valueOf(setting, text) {
+  const t = String(text ?? '').trim();
+  if (setting.kind === 'command') {
+    if (!t) throw new Error(`${setting.key}: name the command, or none`);
+
+    return t;
+  }
+  if (setting.kind === 'mode') {
+    if (!RUN_MODES.includes(t)) throw new Error(`run_mode must be ${RUN_MODES.join(' | ')}`);
+
+    return t;
+  }
+  if (!t) return null;
+  // Plain decimals only: Number() would also take 0x10, 1e3 and 0b1.
+  if (!/^\d+(\.\d+)?$/.test(t)) throw new Error(`${setting.key} must be a number, got ${t}`);
+  const n = Number(t);
+  if (!Number.isFinite(n)) throw new Error(`${setting.key} must be a number, got ${t}`);
+
+  return n;
+}
+
+/**
+ * Set one key of gcf/config.yml and commit gcf(config); a number set to nothing goes back to
+ * its default. The file is read and checked under the move's lock.
+ */
+export async function setConfig(projectDir, key, text, { commit = true } = {}) {
+  const setting = BY_KEY.get(key);
+  if (!setting) throw new Error(`no setting ${key}: ${SETTINGS.map((s) => s.key).join(' | ')}`);
+  const value = valueOf(setting, text);
+  const file = path.join(gcfRoot(projectDir), 'config.yml');
+  const keys = key.split('.');
+  let raw;
+  // A change that changes nothing (the same value, a reset of a key not set) commits nothing.
+  let unchanged = false;
+  const hash = await commitMove(projectDir, `gcf(config): ${key}`, {
+    files: [file],
+    mutate: async () => {
+      const text = existsSync(file) ? await readFile(file, 'utf8') : '';
+      const doc = YAML.parseDocument(text);
+      if (doc.errors.length) throw new Error(`gcf/config.yml: ${doc.errors[0].message}`);
+      if (!YAML.isMap(doc.contents)) doc.contents = doc.createNode({});
+      // A blank parent (`dod:` with nothing under it) is no map yet.
+      if (keys.length > 1) {
+        const parent = doc.get(keys[0], true);
+        if (
+          parent != null &&
+          !YAML.isMap(parent) &&
+          !(YAML.isScalar(parent) && parent.value == null)
+        )
+          throw new Error(`gcf/config.yml: ${keys[0]} must map its keys`);
+        if (!YAML.isMap(parent)) doc.set(keys[0], doc.createNode({}));
+      }
+      if (value === null) doc.deleteIn(keys);
+      else doc.setIn(keys, value);
+      raw = doc.toJS();
+      configOf(raw);
+      const out = doc.toString();
+      // The values, not the text: YAML's output may differ in form (a final newline, `{}`).
+      if (isDeepStrictEqual(YAML.parse(text) ?? {}, raw ?? {})) {
+        unchanged = true;
+        throw NO_CHANGE;
+      }
+      await atomicWrite(file, out);
+    },
+    commit,
+  }).catch((e) => {
+    if (e !== NO_CHANGE) throw e;
+
+    return null;
+  });
+
+  return { key, value, unchanged, settings: settingsOf(raw), hash };
+}

package/lib/gcf-paths.js

@@ -4,7 +4,7 @@ import path from 'node:path';
 import YAML from 'yaml';
 import { parse } from './frontmatter.js';
 
-const DEFAULT_CONFIG = {
+export const DEFAULT_CONFIG = {
   schema: 1,
   built_stale_after_commits: 5,
   tune_limit: 3,
@@ -48,27 +48,24 @@ function runModeOf(v = 'worktree') {
 
 /** @returns {Promise<Record<string, any>>} */
 export async function readConfig(root) {
-  const config = await readNumbers(root);
-  for (const key of PCT_KEYS)
-    if (config[key] > 100)
-      throw new Error(`gcf/config.yml: ${key} is a share of the window, 0-100, got ${config[key]}`);
-  // A compaction before the handoff threshold shrinks the context the handoff waits for.
-  const { auto_compact_pct: compact, context_handoff_pct: handoff } = config;
-  if (compact && handoff && compact < handoff + 15)
-    throw new Error(
-      `gcf/config.yml: auto_compact_pct ${compact} must be at least context_handoff_pct + 15 ` +
-        `(${handoff + 15}), or the compaction comes before the handoff`,
-    );
-
-  return { ...config, run_mode: runModeOf(config.run_mode) };
+  return configOf(await readRawConfig(root));
 }
 
-/** @returns {Promise<Record<string, any>>} */
-async function readNumbers(root) {
+/** config.yml as the file has it, before the defaults: `{}` when there is none. */
+export async function readRawConfig(root) {
   const file = path.join(root, 'config.yml');
-  if (!existsSync(file)) return { ...DEFAULT_CONFIG };
-  const parsed = YAML.parse(await readFile(file, 'utf8')) ?? {};
-  if (typeof parsed !== 'object' || Array.isArray(parsed))
+
+  return existsSync(file) ? (YAML.parse(await readFile(file, 'utf8')) ?? {}) : {};
+}
+
+/**
+ * The config a parsed config.yml gives, checked: defaults for what it does not set, every limit
+ * a non-negative number, the shares 0-100, the run mode one of RUN_MODES. Throws on the first
+ * key that breaks a rule. `gcf config set` checks a change with it before it writes.
+ * @returns {Record<string, any>}
+ */
+export function configOf(parsed) {
+  if (typeof parsed !== 'object' || parsed === null || Array.isArray(parsed))
     throw new Error('gcf/config.yml must be a key: value mapping');
   // A blank `key:` parses as null and means "not set", like an absent key.
   const config = {
@@ -84,8 +81,18 @@ async function readNumbers(root) {
       );
     }
   }
+  for (const key of PCT_KEYS)
+    if (config[key] > 100)
+      throw new Error(`gcf/config.yml: ${key} is a share of the window, 0-100, got ${config[key]}`);
+  // A compaction before the handoff threshold shrinks the context the handoff waits for.
+  const { auto_compact_pct: compact, context_handoff_pct: handoff } = config;
+  if (compact && handoff && compact < handoff + 15)
+    throw new Error(
+      `gcf/config.yml: auto_compact_pct ${compact} must be at least context_handoff_pct + 15 ` +
+        `(${handoff + 15}), or the compaction comes before the handoff`,
+    );
 
-  return config;
+  return { ...config, run_mode: runModeOf(config.run_mode) };
 }
 
 /** Token estimate: ceil(chars/4). Stability over accuracy (GCF-PRD §9.1). */

package/lib/questions.js

@@ -8,7 +8,20 @@ import path from 'node:path';
 import { atomicWrite } from './safe-path.js';
 import { commitMove } from './unit-ops.js';
 
-const FIELDS = ['class', 'question', 'proposed', 'blocks', 'answer'];
+// A D2 carries its assumption and the trigger that brings it back; `lens`, `sections` and `sys`
+// say where a record came from: an import names its lens and the GDD sections.
+const FIELDS = [
+  'class',
+  'question',
+  'proposed',
+  'blocks',
+  'answer',
+  'assumed',
+  'until',
+  'sys',
+  'lens',
+  'sections',
+];
 
 const fileOf = (root) => path.join(root, 'open-questions.md');
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gcf-aif-ext",
-  "version": "0.7.6",
+  "version": "0.7.7",
   "description": "Game Context Framework for AI Factory",
   "type": "module",
   "license": "MIT",

package/templates/agents-block.md

@@ -29,6 +29,7 @@ gcf_forbidden:
 - do not answer a `TBD` of a design unit yourself: ask the human and offer your draft as the proposed answer
 - do not run `ai-factory gcf phase next`: the phase moves on the human's word only
 - do not change what agent runs may do: `ai-factory gcf permissions` and its deny groups belong to the human
+- do not change a setting of `gcf/config.yml`: `ai-factory gcf config set` belongs to the human
 - do not reuse an ended id: rework gets a new id with `reopens: <old id>`
 - do not commit past the gate with `--no-verify`: a refused commit names what to fix