opencode-onboard 0.4.2 → 0.4.4

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)
+  })
+})

package/src/steps/optimization/index.js

@@ -1,101 +1,109 @@
-import { checkbox, confirm } from '@inquirer/prompts'
-import fse from 'fs-extra'
-import path from 'path'
-import { fileURLToPath } from 'url'
-import { code, commandExists, header, info, loading, success, warn } from '../../utils/exec.js'
-import { installQuota } from './quota.js'
-import { installCaveman } from './caveman.js'
-import { enableCavemanGuidance } from './caveman-guidance.js'
-import { configureObGlobal } from './global.js'
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url))
-const OPTIMIZATION_PRESET_PATH = path.resolve(__dirname, '../../presets/optimization.json')
-const optimizationPreset = await fse.readJson(OPTIMIZATION_PRESET_PATH)
-
-export async function checkRtk(options = {}) {
-  if (!options.skipHeader) header('Checking rtk')
-
-  let shouldCheck = true
-  if (!options.skipPrompt) {
-    info('Recommended: install and verify rtk for safer agent CLI command execution.')
-    shouldCheck = await confirm({
-      message: 'Check rtk now?',
-      default: true,
-    })
-  }
-
-  if (!shouldCheck) {
-    warn('Skipped rtk check (you can install it later)')
-    return { optedIn: false, checked: false, available: false }
-  }
-
-  loading('checking rtk...')
-
-  const available = await commandExists('rtk')
-
-  if (available) {
-    success('rtk is available')
-    return { optedIn: true, checked: true, available: true }
-  }
-
-  warn('rtk not found on PATH.')
-  console.log()
-  info('rtk is required for agents to run CLI commands safely.')
-  info('Install it from: https://github.com/rtk-ai/rtk#pre-built-binaries')
-  console.log()
-  info('After installing, verify with:')
-  code(['rtk --version'])
-  return { optedIn: true, checked: true, available: false }
-}
-
-export async function tokenOptimizationStep(options = {}) {
-  header('Step 8, Token optimization tools')
-
-  const defaultSelected = optimizationPreset.choices
-    .filter(choice => choice.checked)
-    .map(choice => choice.value)
-  let selected = defaultSelected
-
-  if (!options.skipPrompt && process.stdin.isTTY) {
-    info(optimizationPreset.info)
-    const timeoutMs = optimizationPreset.timeoutMs
-    const choice = await Promise.race([
-      checkbox({
-        message: optimizationPreset.message,
-        choices: optimizationPreset.choices,
-      }),
-      new Promise(resolve => setTimeout(() => resolve(defaultSelected), timeoutMs)),
-    ])
-    selected = Array.isArray(choice) ? choice : defaultSelected
-  }
-
-  loading('applying token optimization selections...')
-
-  const has = value => selected.includes(value)
-
-  const rtk = has('rtk')
-    ? await checkRtk({ skipHeader: true, skipPrompt: true })
-    : { optedIn: false, checked: false, available: false }
-
-  const quota = has('quota')
-    ? await installQuota({ skipHeader: true, skipPrompt: true })
-    : { optedIn: false, installed: false }
-
-  const caveman = has('caveman')
-    ? await installCaveman({
-      skipHeader: true,
-      skipPrompt: true,
-    })
-    : { optedIn: false, installed: false }
-
-  const cavemanGuidance = has('caveman')
-    ? await enableCavemanGuidance(caveman)
-    : { enabled: false }
-
-  const obGlobal = await configureObGlobal(options.ctx || {}, { rtk, quota, caveman, cavemanGuidance })
-
-  if (selected.length === 0) warn('No token optimization tools selected')
-  else success('Token optimization step completed')
-
-  return { rtk, quota, caveman, cavemanGuidance, obGlobal }
-}
+import { checkbox, confirm } from '@inquirer/prompts'
+import fse from 'fs-extra'
+import path from 'path'
+import { fileURLToPath } from 'url'
+import { code, commandExists, header, info, loading, success, warn } from '../../utils/exec.js'
+import { installQuota } from './quota.js'
+import { installCaveman } from './caveman.js'
+import { installCodegraph } from './codegraph.js'
+import { enableCavemanGuidance } from './caveman-guidance.js'
+import { configureObGlobal } from './global.js'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const OPTIMIZATION_PRESET_PATH = path.resolve(__dirname, '../../presets/optimization.json')
+const optimizationPreset = await fse.readJson(OPTIMIZATION_PRESET_PATH)
+
+export async function checkRtk(options = {}) {
+  if (!options.skipHeader) header('Checking rtk')
+
+  let shouldCheck = true
+  if (!options.skipPrompt) {
+    info('Recommended: install and verify rtk for safer agent CLI command execution.')
+    shouldCheck = await confirm({
+      message: 'Check rtk now?',
+      default: true,
+    })
+  }
+
+  if (!shouldCheck) {
+    warn('Skipped rtk check (you can install it later)')
+    return { optedIn: false, checked: false, available: false }
+  }
+
+  loading('checking rtk...')
+
+  const available = await commandExists('rtk')
+
+  if (available) {
+    success('rtk is available')
+    return { optedIn: true, checked: true, available: true }
+  }
+
+  warn('rtk not found on PATH.')
+  console.log()
+  info('rtk is required for agents to run CLI commands safely.')
+  info('Install it from: https://github.com/rtk-ai/rtk#pre-built-binaries')
+  console.log()
+  info('After installing, verify with:')
+  code(['rtk --version'])
+  return { optedIn: true, checked: true, available: false }
+}
+
+export async function tokenOptimizationStep(options = {}) {
+  header('Step 8, Token optimization tools')
+
+  const defaultSelected = optimizationPreset.choices
+    .filter(choice => choice.checked)
+    .map(choice => choice.value)
+  let selected = defaultSelected
+
+  if (!options.skipPrompt && process.stdin.isTTY) {
+    info(optimizationPreset.info)
+    const timeoutMs = optimizationPreset.timeoutMs
+    const choice = await Promise.race([
+      checkbox({
+        message: optimizationPreset.message,
+        choices: optimizationPreset.choices,
+      }),
+      new Promise(resolve => { setTimeout(() => resolve(defaultSelected), timeoutMs) }),
+    ])
+    selected = Array.isArray(choice) ? choice : defaultSelected
+  }
+
+  loading('applying token optimization selections...')
+
+  const installScope = options.ctx?.installScope || 'local'
+
+  const has = value => selected.includes(value)
+
+  const rtk = has('rtk')
+    ? await checkRtk({ skipHeader: true, skipPrompt: true })
+    : { optedIn: false, checked: false, available: false }
+
+  const quota = has('quota')
+    ? await installQuota({ skipHeader: true, skipPrompt: true })
+    : { optedIn: false, installed: false }
+
+  const caveman = has('caveman')
+    ? await installCaveman({
+      skipHeader: true,
+      skipPrompt: true,
+      installScope,
+    })
+    : { optedIn: false, installed: false }
+
+  const cavemanGuidance = has('caveman')
+    ? await enableCavemanGuidance(caveman)
+    : { enabled: false }
+
+  const codegraph = has('codegraph')
+    ? await installCodegraph({ skipHeader: true, installScope })
+    : { optedIn: false, installed: false }
+
+  const obGlobal = await configureObGlobal(options.ctx || {}, { rtk, quota, caveman, cavemanGuidance, codegraph })
+
+  if (selected.length === 0) warn('No token optimization tools selected')
+  else success('Token optimization step completed')
+
+  return { rtk, quota, caveman, cavemanGuidance, codegraph, obGlobal }
+}

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

@@ -1,93 +1,101 @@
-import { beforeEach, describe, expect, it, vi } from 'vitest'
-
-vi.mock('@inquirer/prompts', () => ({
-  checkbox: vi.fn(),
-  confirm: vi.fn(),
-}))
-
-vi.mock('../../utils/exec.js', () => ({
-  code: vi.fn(),
-  commandExists: vi.fn(),
-  header: vi.fn(),
-  info: vi.fn(),
-  loading: vi.fn(),
-  success: vi.fn(),
-  warn: vi.fn(),
-}))
-
-vi.mock('./quota.js', () => ({ installQuota: vi.fn() }))
-vi.mock('./caveman.js', () => ({ installCaveman: vi.fn() }))
-vi.mock('./caveman-guidance.js', () => ({ enableCavemanGuidance: vi.fn() }))
-vi.mock('./global.js', () => ({ configureObGlobal: vi.fn() }))
-
-vi.mock('fs-extra', () => ({
-  default: {
-    readJson: vi.fn().mockResolvedValue({
-      info: 'Token optimization info',
-      message: 'Select tools',
-      timeoutMs: 5000,
-      choices: [
-        { value: 'rtk', checked: false },
-        { value: 'quota', checked: false },
-        { value: 'caveman', checked: false },
-      ],
-    }),
-  },
-}))
-
-import { checkbox } from '@inquirer/prompts'
-import { commandExists, warn } from '../../utils/exec.js'
-import { installQuota } from './quota.js'
-import { installCaveman } from './caveman.js'
-import { enableCavemanGuidance } from './caveman-guidance.js'
-import { configureObGlobal } from './global.js'
-import { tokenOptimizationStep } from './index.js'
-
-describe('tokenOptimizationStep()', () => {
-  beforeEach(() => {
-    vi.clearAllMocks()
-  })
-
-  it('runs all optimizations by default selection', async () => {
-    const originalIsTTY = process.stdin.isTTY
-    Object.defineProperty(process.stdin, 'isTTY', { value: true, configurable: true })
-
-    checkbox.mockResolvedValue(['rtk', 'quota', 'caveman'])
-    commandExists.mockResolvedValue(true)
-    installQuota.mockResolvedValue({ optedIn: true, installed: true })
-    installCaveman.mockResolvedValue({ optedIn: true, installed: true })
-    enableCavemanGuidance.mockResolvedValue({ enabled: true })
-    configureObGlobal.mockResolvedValue({ configured: true })
-
-    const result = await tokenOptimizationStep()
-
-    Object.defineProperty(process.stdin, 'isTTY', { value: originalIsTTY, configurable: true })
-
-    expect(commandExists).toHaveBeenCalledWith('rtk')
-    expect(installQuota).toHaveBeenCalledWith({ skipHeader: true, skipPrompt: true })
-    expect(installCaveman).toHaveBeenCalledWith({ skipHeader: true, skipPrompt: true })
-    expect(enableCavemanGuidance).toHaveBeenCalledWith({ optedIn: true, installed: true })
-    expect(configureObGlobal).toHaveBeenCalled()
-    expect(result.rtk.available).toBe(true)
-    expect(result.quota.installed).toBe(true)
-    expect(result.caveman.installed).toBe(true)
-    expect(result.cavemanGuidance.enabled).toBe(true)
-  })
-
-  it('skips all tools when nothing is selected', async () => {
-    checkbox.mockResolvedValue([])
-
-    const result = await tokenOptimizationStep()
-
-    expect(commandExists).not.toHaveBeenCalled()
-    expect(installQuota).not.toHaveBeenCalled()
-    expect(installCaveman).not.toHaveBeenCalled()
-    expect(enableCavemanGuidance).not.toHaveBeenCalled()
-    expect(configureObGlobal).toHaveBeenCalled()
-    expect(warn).toHaveBeenCalledWith('No token optimization tools selected')
-    expect(result.rtk.optedIn).toBe(false)
-    expect(result.quota.optedIn).toBe(false)
-    expect(result.caveman.optedIn).toBe(false)
-    expect(result.cavemanGuidance.enabled).toBe(false)
-  })
-})
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+
+vi.mock('@inquirer/prompts', () => ({
+  checkbox: vi.fn(),
+  confirm: vi.fn(),
+}))
+
+vi.mock('../../utils/exec.js', () => ({
+  code: vi.fn(),
+  commandExists: vi.fn(),
+  header: vi.fn(),
+  info: vi.fn(),
+  loading: vi.fn(),
+  success: vi.fn(),
+  warn: vi.fn(),
+}))
+
+vi.mock('./quota.js', () => ({ installQuota: vi.fn() }))
+vi.mock('./caveman.js', () => ({ installCaveman: vi.fn() }))
+vi.mock('./codegraph.js', () => ({ installCodegraph: vi.fn() }))
+vi.mock('./caveman-guidance.js', () => ({ enableCavemanGuidance: vi.fn() }))
+vi.mock('./global.js', () => ({ configureObGlobal: vi.fn() }))
+
+vi.mock('fs-extra', () => ({
+  default: {
+    readJson: vi.fn().mockResolvedValue({
+      info: 'Token optimization info',
+      message: 'Select tools',
+      timeoutMs: 5000,
+      choices: [
+        { value: 'rtk', checked: false },
+        { value: 'quota', checked: false },
+        { value: 'caveman', checked: false },
+        { value: 'codegraph', checked: false },
+      ],
+    }),
+  },
+}))
+
+import { checkbox } from '@inquirer/prompts'
+import { commandExists, warn } from '../../utils/exec.js'
+import { installQuota } from './quota.js'
+import { installCaveman } from './caveman.js'
+import { installCodegraph } from './codegraph.js'
+import { enableCavemanGuidance } from './caveman-guidance.js'
+import { configureObGlobal } from './global.js'
+import { tokenOptimizationStep } from './index.js'
+
+describe('tokenOptimizationStep()', () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+  })
+
+  it('runs all optimizations by default selection', async () => {
+    const originalIsTTY = process.stdin.isTTY
+    Object.defineProperty(process.stdin, 'isTTY', { value: true, configurable: true })
+
+    checkbox.mockResolvedValue(['rtk', 'quota', 'caveman', 'codegraph'])
+    commandExists.mockResolvedValue(true)
+    installQuota.mockResolvedValue({ optedIn: true, installed: true })
+    installCaveman.mockResolvedValue({ optedIn: true, installed: true })
+    installCodegraph.mockResolvedValue({ optedIn: true, installed: true })
+    enableCavemanGuidance.mockResolvedValue({ enabled: true })
+    configureObGlobal.mockResolvedValue({ configured: true })
+
+    const result = await tokenOptimizationStep()
+
+    Object.defineProperty(process.stdin, 'isTTY', { value: originalIsTTY, configurable: true })
+
+    expect(commandExists).toHaveBeenCalledWith('rtk')
+    expect(installQuota).toHaveBeenCalledWith({ skipHeader: true, skipPrompt: true })
+    expect(installCaveman).toHaveBeenCalledWith(expect.objectContaining({ skipHeader: true, skipPrompt: true }))
+    expect(installCodegraph).toHaveBeenCalledWith(expect.objectContaining({ skipHeader: true }))
+    expect(enableCavemanGuidance).toHaveBeenCalledWith({ optedIn: true, installed: true })
+    expect(configureObGlobal).toHaveBeenCalled()
+    expect(result.rtk.available).toBe(true)
+    expect(result.quota.installed).toBe(true)
+    expect(result.caveman.installed).toBe(true)
+    expect(result.cavemanGuidance.enabled).toBe(true)
+    expect(result.codegraph.installed).toBe(true)
+  })
+
+  it('skips all tools when nothing is selected', async () => {
+    checkbox.mockResolvedValue([])
+
+    const result = await tokenOptimizationStep()
+
+    expect(commandExists).not.toHaveBeenCalled()
+    expect(installQuota).not.toHaveBeenCalled()
+    expect(installCaveman).not.toHaveBeenCalled()
+    expect(installCodegraph).not.toHaveBeenCalled()
+    expect(enableCavemanGuidance).not.toHaveBeenCalled()
+    expect(configureObGlobal).toHaveBeenCalled()
+    expect(warn).toHaveBeenCalledWith('No token optimization tools selected')
+    expect(result.rtk.optedIn).toBe(false)
+    expect(result.quota.optedIn).toBe(false)
+    expect(result.caveman.optedIn).toBe(false)
+    expect(result.cavemanGuidance.enabled).toBe(false)
+    expect(result.codegraph.optedIn).toBe(false)
+  })
+})