@plainconceptsplatform/agent-harness 3.4.1 → 3.6.0

package/cli/steps/optimization/patch-guardrails.js

@@ -1,111 +1,111 @@
-import fse from 'fs-extra'
-import path from 'path'
-import { fileURLToPath } from 'url'
-import { info, success } from '../../utils/exec.js'
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url))
-const GUARDRAILS_FRAGMENT_DIR = path.resolve(__dirname, '../../fragments/guardrails')
-
-const MARKER_SECTIONS = {
-  rtk: 'RTK',
-  codegraph: 'CODEGRAPH',
-  memory: 'MEMORY',
-  simpleEnglish: 'SIMPLE-ENGLISH',
-  humanizer: 'HUMANIZER',
-}
-
-const OPTIONAL_TOOL_GUIDANCE = {
-  codegraph: 'Use `codegraph_explore` to refine relevant symbols and file-disjointness for the current wave.',
-  memory: 'Agentmemory carries context across sessions and agents: before exploring an unfamiliar area, call `memory_smart_search` with the key concepts of the task (components, error text) and reuse what it returns; when the work completes, call `memory_save` for durable non-obvious learnings (architecture constraints, root causes and fixes, decisions and why). Never store secrets.',
-}
-
-function replaceMarkerSection(content, startMarker, endMarker, replacement) {
-  if (!content.includes(startMarker) || !content.includes(endMarker)) return content
-  const escape = value => value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
-  const pattern = new RegExp(`${escape(startMarker)}[\\s\\S]*?${escape(endMarker)}`)
-  // Replacer function so $&, $' and $` in injected content stay literal.
-  return content.replace(pattern, () => `${startMarker}\n${replacement}\n${endMarker}`)
-}
-
-async function patchOptionalToolGuidance(destSkillsDir, selections) {
-  const files = []
-
-  async function collect(dir) {
-    for (const entry of await fse.readdir(dir, { withFileTypes: true })) {
-      const entryPath = path.join(dir, entry.name)
-      if (entry.isDirectory()) await collect(entryPath)
-      else if (entry.name.endsWith('.md')) files.push(entryPath)
-    }
-  }
-
-  if (!await fse.pathExists(destSkillsDir)) return 0
-  await collect(destSkillsDir)
-
-  let patched = 0
-  for (const filePath of files) {
-    let content = await fse.readFile(filePath, 'utf-8')
-    const original = content
-    for (const [key, guidance] of Object.entries(OPTIONAL_TOOL_GUIDANCE)) {
-      const suffix = key.toUpperCase()
-      content = replaceMarkerSection(
-        content,
-        `<!-- PC-OPTIMIZATION-${suffix}-START -->`,
-        `<!-- PC-OPTIMIZATION-${suffix}-END -->`,
-        selections[key] ? guidance : '',
-      )
-    }
-    if (content !== original) {
-      await fse.writeFile(filePath, `${content.replace(/\s*$/, '')}\n`, 'utf-8')
-      patched++
-    }
-  }
-  return patched
-}
-
-export async function patchGuardrails(selections = {}, { cwd = process.cwd() } = {}) {
-  const destSkillsDir = path.join(cwd, '.agents', 'skills')
-  const guardrailsPath = path.join(destSkillsDir, 'pc-guardrails-generic', 'SKILL.md')
-  let patchedCount = 0
-
-  if (await fse.pathExists(guardrailsPath)) {
-    let content = await fse.readFile(guardrailsPath, 'utf-8')
-    content = replaceMarkerSection(
-      content,
-      '<!-- PC-GUARDRAILS-CAVEMAN-START -->',
-      '<!-- PC-GUARDRAILS-CAVEMAN-END -->',
-      '',
-    ).replace(
-      '<!-- PC-GUARDRAILS-CAVEMAN-START -->\n\n<!-- PC-GUARDRAILS-CAVEMAN-END -->',
-      '<!-- PC-GUARDRAILS-SIMPLE-ENGLISH-START -->\n<!-- PC-GUARDRAILS-SIMPLE-ENGLISH-END -->',
-    )
-    // A third replace used to rewrite the engineer workflow's step 1 into "the
-    // plugin has already loaded the skills". That was never true: the plugin
-    // appends a reminder and never calls the skill tool. The shipped skill now
-    // carries the honest wording, and update refreshes this file, so the
-    // migration is gone rather than perpetuated.
-    for (const [key, markerSuffix] of Object.entries(MARKER_SECTIONS)) {
-      let sectionContent = ''
-      if (selections[key]) {
-        const presetName = key === 'simpleEnglish' ? 'simple-english' : key
-        const presetPath = path.join(GUARDRAILS_FRAGMENT_DIR, `${presetName}.md`)
-        if (await fse.pathExists(presetPath)) {
-          sectionContent = (await fse.readFile(presetPath, 'utf-8')).trim()
-        }
-      }
-      content = replaceMarkerSection(
-        content,
-        `<!-- PC-GUARDRAILS-${markerSuffix}-START -->`,
-        `<!-- PC-GUARDRAILS-${markerSuffix}-END -->`,
-        sectionContent,
-      )
-      if (selections[key]) patchedCount++
-    }
-    await fse.writeFile(guardrailsPath, `${content.replace(/\s*$/, '')}\n`, 'utf-8')
-  } else {
-    info('pc-guardrails-generic not found, skipping guardrails patching')
-  }
-
-  const optionalPatched = await patchOptionalToolGuidance(destSkillsDir, selections)
-  success(`Guardrails patched: ${patchedCount} sections injected; ${optionalPatched} optional tool file(s) updated`)
-  return { patched: true, count: patchedCount, optionalPatched }
-}
+import fse from 'fs-extra'
+import path from 'path'
+import { fileURLToPath } from 'url'
+import { info, success } from '../../utils/exec.js'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const GUARDRAILS_FRAGMENT_DIR = path.resolve(__dirname, '../../fragments/guardrails')
+
+const MARKER_SECTIONS = {
+  rtk: 'RTK',
+  codegraph: 'CODEGRAPH',
+  memory: 'MEMORY',
+  simpleEnglish: 'SIMPLE-ENGLISH',
+  humanizer: 'HUMANIZER',
+}
+
+const OPTIONAL_TOOL_GUIDANCE = {
+  codegraph: 'Use `codegraph_explore` to refine relevant symbols and file-disjointness for the current wave.',
+  memory: 'Agentmemory carries context across sessions and agents: before exploring an unfamiliar area, call `memory_smart_search` with the key concepts of the task (components, error text) and reuse what it returns; when the work completes, call `memory_save` for durable non-obvious learnings (architecture constraints, root causes and fixes, decisions and why). Never store secrets.',
+}
+
+function replaceMarkerSection(content, startMarker, endMarker, replacement) {
+  if (!content.includes(startMarker) || !content.includes(endMarker)) return content
+  const escape = value => value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
+  const pattern = new RegExp(`${escape(startMarker)}[\\s\\S]*?${escape(endMarker)}`)
+  // Replacer function so $&, $' and $` in injected content stay literal.
+  return content.replace(pattern, () => `${startMarker}\n${replacement}\n${endMarker}`)
+}
+
+async function patchOptionalToolGuidance(destSkillsDir, selections) {
+  const files = []
+
+  async function collect(dir) {
+    for (const entry of await fse.readdir(dir, { withFileTypes: true })) {
+      const entryPath = path.join(dir, entry.name)
+      if (entry.isDirectory()) await collect(entryPath)
+      else if (entry.name.endsWith('.md')) files.push(entryPath)
+    }
+  }
+
+  if (!await fse.pathExists(destSkillsDir)) return 0
+  await collect(destSkillsDir)
+
+  let patched = 0
+  for (const filePath of files) {
+    let content = await fse.readFile(filePath, 'utf-8')
+    const original = content
+    for (const [key, guidance] of Object.entries(OPTIONAL_TOOL_GUIDANCE)) {
+      const suffix = key.toUpperCase()
+      content = replaceMarkerSection(
+        content,
+        `<!-- PC-OPTIMIZATION-${suffix}-START -->`,
+        `<!-- PC-OPTIMIZATION-${suffix}-END -->`,
+        selections[key] ? guidance : '',
+      )
+    }
+    if (content !== original) {
+      await fse.writeFile(filePath, `${content.replace(/\s*$/, '')}\n`, 'utf-8')
+      patched++
+    }
+  }
+  return patched
+}
+
+export async function patchGuardrails(selections = {}, { cwd = process.cwd() } = {}) {
+  const destSkillsDir = path.join(cwd, '.agents', 'skills')
+  const guardrailsPath = path.join(destSkillsDir, 'pc-guardrails-generic', 'SKILL.md')
+  let patchedCount = 0
+
+  if (await fse.pathExists(guardrailsPath)) {
+    let content = await fse.readFile(guardrailsPath, 'utf-8')
+    content = replaceMarkerSection(
+      content,
+      '<!-- PC-GUARDRAILS-CAVEMAN-START -->',
+      '<!-- PC-GUARDRAILS-CAVEMAN-END -->',
+      '',
+    ).replace(
+      '<!-- PC-GUARDRAILS-CAVEMAN-START -->\n\n<!-- PC-GUARDRAILS-CAVEMAN-END -->',
+      '<!-- PC-GUARDRAILS-SIMPLE-ENGLISH-START -->\n<!-- PC-GUARDRAILS-SIMPLE-ENGLISH-END -->',
+    )
+    // A third replace used to rewrite the engineer workflow's step 1 into "the
+    // plugin has already loaded the skills". That was never true: the plugin
+    // appends a reminder and never calls the skill tool. The shipped skill now
+    // carries the honest wording, and update refreshes this file, so the
+    // migration is gone rather than perpetuated.
+    for (const [key, markerSuffix] of Object.entries(MARKER_SECTIONS)) {
+      let sectionContent = ''
+      if (selections[key]) {
+        const presetName = key === 'simpleEnglish' ? 'simple-english' : key
+        const presetPath = path.join(GUARDRAILS_FRAGMENT_DIR, `${presetName}.md`)
+        if (await fse.pathExists(presetPath)) {
+          sectionContent = (await fse.readFile(presetPath, 'utf-8')).trim()
+        }
+      }
+      content = replaceMarkerSection(
+        content,
+        `<!-- PC-GUARDRAILS-${markerSuffix}-START -->`,
+        `<!-- PC-GUARDRAILS-${markerSuffix}-END -->`,
+        sectionContent,
+      )
+      if (selections[key]) patchedCount++
+    }
+    await fse.writeFile(guardrailsPath, `${content.replace(/\s*$/, '')}\n`, 'utf-8')
+  } else {
+    info('pc-guardrails-generic not found, skipping guardrails patching')
+  }
+
+  const optionalPatched = await patchOptionalToolGuidance(destSkillsDir, selections)
+  success(`Guardrails patched: ${patchedCount} sections injected; ${optionalPatched} optional tool file(s) updated`)
+  return { patched: true, count: patchedCount, optionalPatched }
+}

package/cli/steps/optimization/simple-english.js

@@ -1,17 +1,17 @@
-import { addSkillToLock } from './skills-lock.js'
-import { header, success, info } from '../../utils/exec.js'
-
-const SKILL_ENTRY = {
-  source: 'AminBlg/SimpleEnglish',
-  sourceType: 'github',
-  skillPath: 'skills/simple-english/SKILL.md',
-}
-
-export async function installSimpleEnglish(options = {}) {
-  if (!options.skipHeader) header('Installing Simple English')
-
-  info('Adding Simple English to skills-lock.json for batch install')
-  await addSkillToLock('simple-english', SKILL_ENTRY)
-  success('Simple English queued for installation')
-  return { optedIn: true, installed: true }
-}
+import { addSkillToLock } from './skills-lock.js'
+import { header, success, info } from '../../utils/exec.js'
+
+const SKILL_ENTRY = {
+  source: 'AminBlg/SimpleEnglish',
+  sourceType: 'github',
+  skillPath: 'skills/simple-english/SKILL.md',
+}
+
+export async function installSimpleEnglish(options = {}) {
+  if (!options.skipHeader) header('Installing Simple English')
+
+  info('Adding Simple English to skills-lock.json for batch install')
+  await addSkillToLock('simple-english', SKILL_ENTRY)
+  success('Simple English queued for installation')
+  return { optedIn: true, installed: true }
+}

package/cli/steps/optimization/skills-lock.js

@@ -1,30 +1,30 @@
-import fse from 'fs-extra'
-import path from 'path'
-import { info, warn } from '../../utils/exec.js'
-
-export async function addSkillToLock(skillName, entry) {
-  if (!entry) {
-    warn(`No entry provided for skills-lock.json: ${skillName}`)
-    return false
-  }
-
-  const destLock = path.join(process.cwd(), 'skills-lock.json')
-
-  let lock = { version: 1, skills: {} }
-  if (await fse.pathExists(destLock)) {
-    try {
-      lock = await fse.readJson(destLock)
-      if (!lock.skills) lock.skills = {}
-    } catch {
-      warn('Could not parse existing skills-lock.json, creating fresh')
-    }
-  }
-
-  if (!lock.skills[skillName]) {
-    lock.skills[skillName] = entry
-    await fse.writeJson(destLock, lock, { spaces: 2 })
-    info(`Added ${skillName} to skills-lock.json`)
-  }
-
-  return true
-}
+import fse from 'fs-extra'
+import path from 'path'
+import { info, warn } from '../../utils/exec.js'
+
+export async function addSkillToLock(skillName, entry) {
+  if (!entry) {
+    warn(`No entry provided for skills-lock.json: ${skillName}`)
+    return false
+  }
+
+  const destLock = path.join(process.cwd(), 'skills-lock.json')
+
+  let lock = { version: 1, skills: {} }
+  if (await fse.pathExists(destLock)) {
+    try {
+      lock = await fse.readJson(destLock)
+      if (!lock.skills) lock.skills = {}
+    } catch {
+      warn('Could not parse existing skills-lock.json, creating fresh')
+    }
+  }
+
+  if (!lock.skills[skillName]) {
+    lock.skills[skillName] = entry
+    await fse.writeJson(destLock, lock, { spaces: 2 })
+    info(`Added ${skillName} to skills-lock.json`)
+  }
+
+  return true
+}

package/cli/steps/platform/index.js

@@ -1,109 +1,109 @@
-import { select } from '@inquirer/prompts'
-import { execa } from 'execa'
-import fse from 'fs-extra'
-import path from 'path'
-import { fileURLToPath } from 'url'
-import { code, commandExists, header, info, success, warn } from '../../utils/exec.js'
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url))
-const PLATFORMS_PRESET_PATH = path.resolve(__dirname, '../../presets/platforms.json')
-const platformsPreset = await fse.readJson(PLATFORMS_PRESET_PATH)
-
-
-export async function checkPlatform(platform) {
-  const preset = platformsPreset.find(p => p.value === platform) || platformsPreset[0]
-  if (!preset.cli) {
-    header(`Step 4, Checking ${preset.name} CLI`)
-    info('No platform integration selected, skipping CLI checks.')
-    success(`Platform: ${preset.name}`)
-    return
-  }
-  await checkPlatformCli(preset)
-}
-
-export async function choosePlatform() {
-  header('Step 3, Version control platform')
-
-  const backlogChoices = platformsPreset.filter(p => !p.repoOnly)
-  const backlogPlatform = await select({
-    message: 'Where is your backlog (work items / issues)?',
-    choices: backlogChoices.map(p => ({ name: p.name, value: p.value })),
-  })
-
-  const backlogPreset = platformsPreset.find(p => p.value === backlogPlatform)
-  success(`Backlog platform: ${backlogPreset?.name || backlogPlatform}`)
-
-  let repoPlatform = backlogPlatform
-  if (backlogPlatform !== 'none') {
-    // Exclude backlog-only platforms (e.g. Jira) from repo choices
-    const repoChoices = platformsPreset.filter(p => !p.backlogOnly)
-    repoPlatform = await select({
-      message: 'Where is your code repository (PRs / code reviews)?',
-      choices: repoChoices.map(p => ({ name: p.name, value: p.value })),
-      default: backlogPreset.backlogOnly ? 'github' : backlogPlatform,
-    })
-    const repoPreset = platformsPreset.find(p => p.value === repoPlatform)
-    success(`Repo platform: ${repoPreset?.name || repoPlatform}`)
-  }
-
-  // Check CLIs for both platforms (deduped)
-  const platformsToCheck = [...new Set([backlogPlatform, repoPlatform])].filter(p => p !== 'none')
-  for (const p of platformsToCheck) {
-    const preset = platformsPreset.find(x => x.value === p)
-    if (preset?.cli) await checkPlatformCli(preset)
-  }
-
-  return { backlogPlatform, repoPlatform }
-}
-
-async function checkPlatformCli(platformPreset) {
-  const { cli } = platformPreset
-  header(`Step 4, Checking ${platformPreset.name} CLI`)
-
-  const hasCli = await commandExists(cli.command)
-  if (!hasCli) {
-    warn(`${cli.displayName} not found.`)
-    info(`Install from: ${cli.installUrl}`)
-    if (cli.authCheck?.commands?.length) {
-      console.log()
-      info('After installing, authenticate with:')
-      code(cli.authCheck.commands)
-    }
-    return
-  }
-  success(`${cli.displayName} available`)
-
-  if (cli.authCheck) await runAuthCheck(cli)
-  if (cli.extensionCheck) await runExtensionCheck(cli)
-}
-
-async function runAuthCheck(cli) {
-  try {
-    const result = await execa(cli.command, cli.authCheck.args, { reject: false })
-    if (result.exitCode === 0) {
-      success(`${cli.displayName} authenticated`)
-    } else {
-      warn(cli.authCheck.notAuthenticatedMessage)
-      code(cli.authCheck.commands)
-    }
-  } catch {
-    warn(`Could not check ${cli.command} auth status.`)
-  }
-}
-
-async function runExtensionCheck(cli) {
-  try {
-    const result = await execa(cli.command, cli.extensionCheck.args, { reject: false })
-    const hasExtension = result.stdout && result.stdout.includes(cli.extensionCheck.expectedOutput)
-
-    if (hasExtension) {
-      success(`${cli.extensionCheck.expectedOutput} extension installed`)
-    } else {
-      warn(cli.extensionCheck.missingMessage)
-      code(cli.extensionCheck.commands)
-    }
-  } catch {
-    warn(cli.extensionCheck.errorMessage)
-    code(cli.extensionCheck.commands)
-  }
-}
+import { select } from '@inquirer/prompts'
+import { execa } from 'execa'
+import fse from 'fs-extra'
+import path from 'path'
+import { fileURLToPath } from 'url'
+import { code, commandExists, header, info, success, warn } from '../../utils/exec.js'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const PLATFORMS_PRESET_PATH = path.resolve(__dirname, '../../presets/platforms.json')
+const platformsPreset = await fse.readJson(PLATFORMS_PRESET_PATH)
+
+
+export async function checkPlatform(platform) {
+  const preset = platformsPreset.find(p => p.value === platform) || platformsPreset[0]
+  if (!preset.cli) {
+    header(`Step 4, Checking ${preset.name} CLI`)
+    info('No platform integration selected, skipping CLI checks.')
+    success(`Platform: ${preset.name}`)
+    return
+  }
+  await checkPlatformCli(preset)
+}
+
+export async function choosePlatform() {
+  header('Step 3, Version control platform')
+
+  const backlogChoices = platformsPreset.filter(p => !p.repoOnly)
+  const backlogPlatform = await select({
+    message: 'Where is your backlog (work items / issues)?',
+    choices: backlogChoices.map(p => ({ name: p.name, value: p.value })),
+  })
+
+  const backlogPreset = platformsPreset.find(p => p.value === backlogPlatform)
+  success(`Backlog platform: ${backlogPreset?.name || backlogPlatform}`)
+
+  let repoPlatform = backlogPlatform
+  if (backlogPlatform !== 'none') {
+    // Exclude backlog-only platforms (e.g. Jira) from repo choices
+    const repoChoices = platformsPreset.filter(p => !p.backlogOnly)
+    repoPlatform = await select({
+      message: 'Where is your code repository (PRs / code reviews)?',
+      choices: repoChoices.map(p => ({ name: p.name, value: p.value })),
+      default: backlogPreset.backlogOnly ? 'github' : backlogPlatform,
+    })
+    const repoPreset = platformsPreset.find(p => p.value === repoPlatform)
+    success(`Repo platform: ${repoPreset?.name || repoPlatform}`)
+  }
+
+  // Check CLIs for both platforms (deduped)
+  const platformsToCheck = [...new Set([backlogPlatform, repoPlatform])].filter(p => p !== 'none')
+  for (const p of platformsToCheck) {
+    const preset = platformsPreset.find(x => x.value === p)
+    if (preset?.cli) await checkPlatformCli(preset)
+  }
+
+  return { backlogPlatform, repoPlatform }
+}
+
+async function checkPlatformCli(platformPreset) {
+  const { cli } = platformPreset
+  header(`Step 4, Checking ${platformPreset.name} CLI`)
+
+  const hasCli = await commandExists(cli.command)
+  if (!hasCli) {
+    warn(`${cli.displayName} not found.`)
+    info(`Install from: ${cli.installUrl}`)
+    if (cli.authCheck?.commands?.length) {
+      console.log()
+      info('After installing, authenticate with:')
+      code(cli.authCheck.commands)
+    }
+    return
+  }
+  success(`${cli.displayName} available`)
+
+  if (cli.authCheck) await runAuthCheck(cli)
+  if (cli.extensionCheck) await runExtensionCheck(cli)
+}
+
+async function runAuthCheck(cli) {
+  try {
+    const result = await execa(cli.command, cli.authCheck.args, { reject: false })
+    if (result.exitCode === 0) {
+      success(`${cli.displayName} authenticated`)
+    } else {
+      warn(cli.authCheck.notAuthenticatedMessage)
+      code(cli.authCheck.commands)
+    }
+  } catch {
+    warn(`Could not check ${cli.command} auth status.`)
+  }
+}
+
+async function runExtensionCheck(cli) {
+  try {
+    const result = await execa(cli.command, cli.extensionCheck.args, { reject: false })
+    const hasExtension = result.stdout && result.stdout.includes(cli.extensionCheck.expectedOutput)
+
+    if (hasExtension) {
+      success(`${cli.extensionCheck.expectedOutput} extension installed`)
+    } else {
+      warn(cli.extensionCheck.missingMessage)
+      code(cli.extensionCheck.commands)
+    }
+  } catch {
+    warn(cli.extensionCheck.errorMessage)
+    code(cli.extensionCheck.commands)
+  }
+}