opencode-onboard 0.4.3 → 0.4.5

package/src/steps/optimization/codegraph.js

@@ -0,0 +1,103 @@
+import { execa } from 'execa'
+import fse from 'fs-extra'
+import path from 'node:path'
+import { header, success, warn, error, loading } from '../../utils/exec.js'
+
+/**
+ * After codegraph install, it may create an `opencode.jsonc` at the project root.
+ * This project uses `.opencode/opencode.json` instead. Merge any MCP config from
+ * the rogue file into the correct location and remove it.
+ */
+export async function fixCodegraphConfig() {
+  const cwd = process.cwd()
+  const rogueFile = path.join(cwd, 'opencode.jsonc')
+  const correctFile = path.join(cwd, '.opencode', 'opencode.json')
+
+  if (!await fse.pathExists(rogueFile)) return
+
+  let rogueContent
+  try {
+    const raw = await fse.readFile(rogueFile, 'utf-8')
+    // Strip JSONC comments (single-line // and block /* */) before parsing
+    const stripped = raw
+      .replace(/\/\/.*$/gm, '')
+      .replace(/\/\*[\s\S]*?\*\//g, '')
+    rogueContent = JSON.parse(stripped)
+  } catch {
+    warn('Could not parse opencode.jsonc, removing it')
+    await fse.remove(rogueFile)
+    return
+  }
+
+  let correctContent = {}
+  if (await fse.pathExists(correctFile)) {
+    try {
+      correctContent = await fse.readJson(correctFile)
+    } catch {
+      correctContent = {}
+    }
+  }
+
+  // Merge mcpServers from rogue into correct config
+  if (rogueContent.mcpServers || rogueContent.mcp) {
+    const mcpServers = rogueContent.mcpServers || rogueContent.mcp
+    correctContent.mcpServers = { ...(correctContent.mcpServers || {}), ...mcpServers }
+  }
+
+  await fse.ensureDir(path.dirname(correctFile))
+  await fse.writeJson(correctFile, correctContent, { spaces: 2 })
+  await fse.remove(rogueFile)
+  warn('Migrated codegraph config from opencode.jsonc → .opencode/opencode.json (removed opencode.jsonc)')
+}
+
+export async function installCodegraph(options = {}) {
+  if (!options.skipHeader) header('Installing codegraph')
+
+  const location = options.installScope === 'global' ? 'global' : 'local'
+
+  loading(`configuring codegraph for opencode (${location})...`)
+
+  try {
+    const installResult = await execa(
+      'npx',
+      ['@colbymchenry/codegraph', 'install', '--target=opencode', `--location=${location}`, '--yes'],
+      {
+        cwd: process.cwd(),
+        reject: false,
+        stdio: 'pipe',
+      }
+    )
+
+    if (installResult.exitCode !== 0) {
+      warn('codegraph install exited with non-zero code')
+      return { optedIn: true, installed: false }
+    }
+
+    await fixCodegraphConfig()
+    success(`codegraph configured for opencode (${location})`)
+  } catch (err) {
+    error(`Failed to install codegraph: ${err.message}`)
+    return { optedIn: true, installed: false }
+  }
+
+  loading('initializing codegraph project index...')
+
+  try {
+    const initResult = await execa('codegraph', ['init'], {
+      cwd: process.cwd(),
+      reject: false,
+      stdio: 'pipe',
+    })
+
+    if (initResult.exitCode !== 0) {
+      warn('codegraph init exited with non-zero code')
+      return { optedIn: true, installed: false }
+    }
+    success('codegraph project index initialized')
+  } catch (err) {
+    error(`Failed to initialize codegraph: ${err.message}`)
+    return { optedIn: true, installed: false }
+  }
+
+  return { optedIn: true, installed: true }
+}

package/src/steps/optimization/codegraph.test.js

@@ -0,0 +1,104 @@
+import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest'
+import fs from 'node:fs'
+import path from 'node:path'
+import os from 'node:os'
+import fse from 'fs-extra'
+
+vi.mock('execa', () => ({ execa: vi.fn() }))
+vi.mock('../../utils/exec.js', () => ({
+  header: vi.fn(),
+  success: vi.fn(),
+  warn: vi.fn(),
+  error: vi.fn(),
+  loading: vi.fn(),
+}))
+
+import { warn } from '../../utils/exec.js'
+import { fixCodegraphConfig } from './codegraph.js'
+
+describe('fixCodegraphConfig()', () => {
+  let tmpDir
+
+  beforeEach(() => {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'codegraph-test-'))
+    vi.spyOn(process, 'cwd').mockReturnValue(tmpDir)
+  })
+
+  afterEach(() => {
+    fs.rmSync(tmpDir, { recursive: true, force: true })
+    vi.restoreAllMocks()
+  })
+
+  it('does nothing when opencode.jsonc does not exist', async () => {
+    await fixCodegraphConfig()
+    // No error, no file created
+    expect(fs.existsSync(path.join(tmpDir, '.opencode', 'opencode.json'))).toBe(false)
+  })
+
+  it('merges mcpServers from opencode.jsonc into .opencode/opencode.json', async () => {
+    const rogueContent = {
+      mcpServers: {
+        codegraph: { command: 'codegraph', args: ['mcp'] }
+      }
+    }
+    fs.writeFileSync(path.join(tmpDir, 'opencode.jsonc'), JSON.stringify(rogueContent))
+
+    const opencodeDir = path.join(tmpDir, '.opencode')
+    fs.mkdirSync(opencodeDir, { recursive: true })
+    fs.writeFileSync(path.join(opencodeDir, 'opencode.json'), JSON.stringify({
+      "$schema": "https://opencode.ai/config.json",
+      "plugin": ["opencode-plugin-openspec@latest"]
+    }))
+
+    await fixCodegraphConfig()
+
+    expect(fs.existsSync(path.join(tmpDir, 'opencode.jsonc'))).toBe(false)
+    const result = await fse.readJson(path.join(opencodeDir, 'opencode.json'))
+    expect(result.mcpServers.codegraph).toEqual({ command: 'codegraph', args: ['mcp'] })
+    expect(result.plugin).toEqual(["opencode-plugin-openspec@latest"])
+  })
+
+  it('handles JSONC with comments', async () => {
+    const rogueRaw = `{
+  // This is a comment
+  "mcpServers": {
+    "codegraph": { "command": "codegraph", "args": ["mcp"] }
+  }
+}`
+    fs.writeFileSync(path.join(tmpDir, 'opencode.jsonc'), rogueRaw)
+
+    const opencodeDir = path.join(tmpDir, '.opencode')
+    fs.mkdirSync(opencodeDir, { recursive: true })
+    fs.writeFileSync(path.join(opencodeDir, 'opencode.json'), '{}')
+
+    await fixCodegraphConfig()
+
+    expect(fs.existsSync(path.join(tmpDir, 'opencode.jsonc'))).toBe(false)
+    const result = await fse.readJson(path.join(opencodeDir, 'opencode.json'))
+    expect(result.mcpServers.codegraph.command).toBe('codegraph')
+  })
+
+  it('removes unparseable opencode.jsonc and warns', async () => {
+    fs.writeFileSync(path.join(tmpDir, 'opencode.jsonc'), 'not valid json {{{')
+
+    await fixCodegraphConfig()
+
+    expect(fs.existsSync(path.join(tmpDir, 'opencode.jsonc'))).toBe(false)
+    expect(warn).toHaveBeenCalledWith('Could not parse opencode.jsonc, removing it')
+  })
+
+  it('creates .opencode/opencode.json if it does not exist', async () => {
+    const rogueContent = {
+      mcpServers: {
+        codegraph: { command: 'codegraph', args: ['mcp'] }
+      }
+    }
+    fs.writeFileSync(path.join(tmpDir, 'opencode.jsonc'), JSON.stringify(rogueContent))
+
+    await fixCodegraphConfig()
+
+    const result = await fse.readJson(path.join(tmpDir, '.opencode', 'opencode.json'))
+    expect(result.mcpServers.codegraph.command).toBe('codegraph')
+    expect(fs.existsSync(path.join(tmpDir, 'opencode.jsonc'))).toBe(false)
+  })
+})

package/src/steps/optimization/global.js

@@ -1,64 +1,88 @@
-import fse from 'fs-extra'
-import path from 'node:path'
-import { info, success, warn } from '../../utils/exec.js'
-
-const SOURCE_START = '<!-- OB-SOURCE-ROOTS-START -->'
-const SOURCE_END = '<!-- OB-SOURCE-ROOTS-END -->'
-const RTK_START = '<!-- OB-RTK-START -->'
-const RTK_END = '<!-- OB-RTK-END -->'
-const CAVEMAN_START = '<!-- OB-CAVEMAN-START -->'
-const CAVEMAN_END = '<!-- OB-CAVEMAN-END -->'
-
-function relRoot(cwd, abs) {
-  const rel = path.relative(cwd, abs).replace(/\\/g, '/')
-  return rel || '.'
-}
-
-function buildSourceRootsSection(sourceRoots, cwd) {
-  const roots = Array.isArray(sourceRoots) && sourceRoots.length > 0 ? sourceRoots : [cwd]
-  const bullets = roots.map(r => `- \`${relRoot(cwd, r)}\``).join('\n')
-  const multiRepo = roots.length > 1
-    ? '\nEach root is an independent git repository. For branch/commit/push workflows, run git operations per repository. There is no single shared git history across all roots.\n'
-    : ''
-
-  return `Read and analyze code ONLY from these roots:\n\n${bullets}\n${multiRepo}`
-}
-
-function buildRtkSection(rtkEnabled) {
-  if (!rtkEnabled) return 'RTK was not selected during onboarding. Do not assume `rtk` exists.'
-  return `## RTK, MANDATORY\n\nUse \`rtk\` for ALL CLI commands. Never run commands directly.\n\n- \`rtk git\` NOT \`git\`\n- \`rtk gh\` NOT \`gh\`\n- \`rtk az\` NOT \`az\`\n- \`rtk openspec\` NOT \`openspec\`\n\nIf \`rtk\` is not available, report blocker and stop CLI execution.`
-}
-
-function buildCavemanSection(cavemanEnabled) {
-  if (!cavemanEnabled) return 'Caveman was not selected during onboarding. Use normal concise style.'
-  return `## Caveman\n\ncaveman mode. Active now. Every response. No revert unless user asks \"stop caveman\" or \"normal mode\".`
-}
-
-function replaceBetween(content, start, end, replacement) {
-  if (!content.includes(start) || !content.includes(end)) return content
-  const pattern = new RegExp(`${start}[\\s\\S]*?${end}`)
-  return content.replace(pattern, `${start}\n${replacement.trim()}\n${end}`)
-}
-
-export async function configureObGlobal(ctx = {}, tokenOpt = {}) {
-  const cwd = process.cwd()
-  const skillPath = path.join(cwd, '.agents', 'skills', 'ob-global', 'SKILL.md')
-
-  if (!await fse.pathExists(skillPath)) {
-    warn('ob-global skill not found, skipping dynamic configuration')
-    return { configured: false }
-  }
-
-  const sourceRootsSection = buildSourceRootsSection(ctx.sourceRoots, cwd)
-  const rtkSection = buildRtkSection(!!tokenOpt?.rtk?.optedIn)
-  const cavemanSection = buildCavemanSection(!!tokenOpt?.caveman?.optedIn)
-
-  let content = await fse.readFile(skillPath, 'utf-8')
-  content = replaceBetween(content, SOURCE_START, SOURCE_END, sourceRootsSection)
-  content = replaceBetween(content, RTK_START, RTK_END, rtkSection)
-  content = replaceBetween(content, CAVEMAN_START, CAVEMAN_END, cavemanSection)
-  await fse.writeFile(skillPath, `${content.replace(/\s*$/, '')}\n`, 'utf-8')
-  info('Configured ob-global from onboarding selections')
-  success('ob-global skill updated')
-  return { configured: true, path: skillPath }
-}
+import fse from 'fs-extra'
+import path from 'node:path'
+import { info, success, warn } from '../../utils/exec.js'
+
+const SOURCE_START = '<!-- OB-SOURCE-ROOTS-START -->'
+const SOURCE_END = '<!-- OB-SOURCE-ROOTS-END -->'
+const RTK_START = '<!-- OB-RTK-START -->'
+const RTK_END = '<!-- OB-RTK-END -->'
+const CAVEMAN_START = '<!-- OB-CAVEMAN-START -->'
+const CAVEMAN_END = '<!-- OB-CAVEMAN-END -->'
+
+const CODEGRAPH_START = '<!-- OB-CODEGRAPH-START -->'
+const CODEGRAPH_END = '<!-- OB-CODEGRAPH-END -->'
+
+function relRoot(cwd, abs) {
+  const rel = path.relative(cwd, abs).replace(/\\/g, '/')
+  return rel || '.'
+}
+
+function buildSourceRootsSection(sourceRoots, cwd) {
+  const roots = Array.isArray(sourceRoots) && sourceRoots.length > 0 ? sourceRoots : [cwd]
+  const bullets = roots.map(r => `- \`${relRoot(cwd, r)}\``).join('\n')
+  const multiRepo = roots.length > 1
+    ? '\nEach root is an independent git repository. For branch/commit/push workflows, run git operations per repository. There is no single shared git history across all roots.\n'
+    : ''
+
+  return `Read and analyze code ONLY from these roots:\n\n${bullets}\n${multiRepo}`
+}
+
+function buildRtkSection(rtkEnabled) {
+  if (!rtkEnabled) return 'RTK was not selected during onboarding. Do not assume `rtk` exists.'
+  return `## RTK, MANDATORY\n\nUse \`rtk\` for ALL CLI commands. Never run commands directly.\n\n- \`rtk git\` NOT \`git\`\n- \`rtk gh\` NOT \`gh\`\n- \`rtk az\` NOT \`az\`\n- \`rtk openspec\` NOT \`openspec\`\n\nIf \`rtk\` is not available, report blocker and stop CLI execution.`
+}
+
+function buildCavemanSection(cavemanEnabled) {
+  if (!cavemanEnabled) return 'Caveman was not selected during onboarding. Use normal concise style.'
+  return `## Caveman\n\ncaveman mode. Active now. Every response. No revert unless user asks "stop caveman" or "normal mode".`
+}
+
+function buildCodegraphSection(codegraphEnabled) {
+  if (!codegraphEnabled) return 'Codegraph was not selected during onboarding. Use standard grep/glob/read for code exploration.'
+  return `## CodeGraph
+
+This project has CodeGraph initialized (\`.codegraph/\` exists). Use it for all code exploration.
+
+**NEVER call \`codegraph_explore\` or \`codegraph_context\` directly in the main session** — these return large source payloads that fill context. Instead, ALWAYS spawn an Explore sub-agent for exploration questions ("how does X work?", "where is Y implemented?").
+
+When spawning Explore agents, include in the prompt:
+> This project has CodeGraph initialized. Use \`codegraph_explore\` as your PRIMARY tool. Do NOT re-read files that codegraph_explore already returned. Only fall back to grep/glob/read for files listed under "Additional relevant files".
+
+**The main session may only use these lightweight tools directly** (targeted lookups before edits):
+- \`codegraph_search\` — find symbols by name
+- \`codegraph_callers\` / \`codegraph_callees\` — trace call flow
+- \`codegraph_impact\` — check what's affected before editing
+- \`codegraph_node\` — get a single symbol's details`
+}
+
+
+function replaceBetween(content, start, end, replacement) {
+  if (!content.includes(start) || !content.includes(end)) return content
+  const pattern = new RegExp(`${start}[\\s\\S]*?${end}`)
+  return content.replace(pattern, `${start}\n${replacement.trim()}\n${end}`)
+}
+
+export async function configureObGlobal(ctx = {}, tokenOpt = {}) {
+  const cwd = process.cwd()
+  const skillPath = path.join(cwd, '.agents', 'skills', 'ob-global', 'SKILL.md')
+
+  if (!await fse.pathExists(skillPath)) {
+    warn('ob-global skill not found, skipping dynamic configuration')
+    return { configured: false }
+  }
+
+  const sourceRootsSection = buildSourceRootsSection(ctx.sourceRoots, cwd)
+  const rtkSection = buildRtkSection(!!tokenOpt?.rtk?.optedIn)
+  const cavemanSection = buildCavemanSection(!!tokenOpt?.caveman?.optedIn)
+  const codegraphSection = buildCodegraphSection(!!tokenOpt?.codegraph?.optedIn)
+
+  let content = await fse.readFile(skillPath, 'utf-8')
+  content = replaceBetween(content, SOURCE_START, SOURCE_END, sourceRootsSection)
+  content = replaceBetween(content, RTK_START, RTK_END, rtkSection)
+  content = replaceBetween(content, CAVEMAN_START, CAVEMAN_END, cavemanSection)
+  content = replaceBetween(content, CODEGRAPH_START, CODEGRAPH_END, codegraphSection)
+  await fse.writeFile(skillPath, `${content.replace(/\s*$/, '')}\n`, 'utf-8')
+  info('Configured ob-global from onboarding selections')
+  success('ob-global skill updated')
+  return { configured: true, path: skillPath }
+}

package/src/steps/optimization/global.test.js

@@ -0,0 +1,99 @@
+import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest'
+import fs from 'node:fs'
+import path from 'node:path'
+import os from 'node:os'
+
+vi.mock('../../utils/exec.js', () => ({
+  info: vi.fn(),
+  success: vi.fn(),
+  warn: vi.fn(),
+}))
+
+import { configureObGlobal } from './global.js'
+
+const SKILL_TEMPLATE = `## Token Optimization Rules
+
+<!-- OB-SOURCE-ROOTS-START -->
+placeholder
+<!-- OB-SOURCE-ROOTS-END -->
+
+<!-- OB-RTK-START -->
+placeholder
+<!-- OB-RTK-END -->
+
+<!-- OB-CAVEMAN-START -->
+placeholder
+<!-- OB-CAVEMAN-END -->
+
+<!-- OB-CODEGRAPH-START -->
+placeholder
+<!-- OB-CODEGRAPH-END -->
+`
+
+describe('configureObGlobal()', () => {
+  let tmpDir
+  let skillPath
+
+  beforeEach(() => {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'ob-global-test-'))
+    const skillDir = path.join(tmpDir, '.agents', 'skills', 'ob-global')
+    fs.mkdirSync(skillDir, { recursive: true })
+    skillPath = path.join(skillDir, 'SKILL.md')
+    fs.writeFileSync(skillPath, SKILL_TEMPLATE, 'utf-8')
+    vi.spyOn(process, 'cwd').mockReturnValue(tmpDir)
+  })
+
+  afterEach(() => {
+    fs.rmSync(tmpDir, { recursive: true, force: true })
+    vi.restoreAllMocks()
+  })
+
+  it('returns configured:false when ob-global skill is missing', async () => {
+    fs.rmSync(skillPath)
+    const result = await configureObGlobal()
+    expect(result).toEqual({ configured: false })
+  })
+
+  it('injects source roots section', async () => {
+    await configureObGlobal({ sourceRoots: [tmpDir] }, {})
+    const content = fs.readFileSync(skillPath, 'utf-8')
+    expect(content).toContain('Read and analyze code ONLY from these roots')
+  })
+
+  it('injects RTK section when rtk is opted in', async () => {
+    await configureObGlobal({}, { rtk: { optedIn: true } })
+    const content = fs.readFileSync(skillPath, 'utf-8')
+    expect(content).toContain('RTK, MANDATORY')
+  })
+
+  it('injects RTK not-selected note when rtk is not opted in', async () => {
+    await configureObGlobal({}, { rtk: { optedIn: false } })
+    const content = fs.readFileSync(skillPath, 'utf-8')
+    expect(content).toContain('RTK was not selected during onboarding')
+  })
+
+  it('injects caveman section when caveman is opted in', async () => {
+    await configureObGlobal({}, { caveman: { optedIn: true } })
+    const content = fs.readFileSync(skillPath, 'utf-8')
+    expect(content).toContain('caveman mode')
+  })
+
+  it('injects codegraph section when codegraph is opted in', async () => {
+    await configureObGlobal({}, { codegraph: { optedIn: true } })
+    const content = fs.readFileSync(skillPath, 'utf-8')
+    expect(content).toContain('CodeGraph')
+    expect(content).toContain('codegraph_explore')
+  })
+
+  it('injects codegraph not-selected note when codegraph is not opted in', async () => {
+    await configureObGlobal({}, { codegraph: { optedIn: false } })
+    const content = fs.readFileSync(skillPath, 'utf-8')
+    expect(content).toContain('Codegraph was not selected during onboarding')
+  })
+
+  it('returns configured:true with skill path on success', async () => {
+    const result = await configureObGlobal({}, {})
+    expect(result.configured).toBe(true)
+    expect(result.path).toBe(skillPath)
+  })
+})