command-preview.ts

export type CommandClassification = {
  readOnly: boolean
  destructive: boolean
  idempotent: boolean
}

/**
 * The subset of oclif's parse metadata we rely on: which flags were filled in from
 * `default:` rather than typed by the user. Pass `metadata.flags` from `this.parse()`.
 */
export type FlagMetadata = Record<string, { setFromDefault?: boolean } | undefined>

export type CommandPreview = {
  command: string
  description: string
  changes: string[]
  flags: Record<string, unknown>
  flagMetadata?: FlagMetadata
  args?: Record<string, unknown>
  classification: CommandClassification
}

export type AgentPreviewResponse = {
  status: 'confirmation_required' | 'dry_run'
  command: string
  description: string
  classification: CommandClassification
  changes: string[]
  confirmCommand: string
}

const OMITTED_FLAGS: ReadonlySet<string> = new Set(['output', 'force', 'dry-run'])

export function buildConfirmCommand (
  command: string,
  flags: Record<string, unknown>,
  args?: Record<string, unknown>,
  flagMetadata?: FlagMetadata,
): string {
  const parts = ['checkly', command]

  if (args) {
    for (const value of Object.values(args)) {
      parts.push(String(value))
    }
  }

  for (const [key, value] of Object.entries(flags)) {
    if (OMITTED_FLAGS.has(key)) continue
    if (value === undefined || value === null) continue
    // Defaults are not part of what the user asked for, and a default `false` renders as
    // `--no-x`, which only parses when the flag sets `allowNo: true`.
    if (flagMetadata?.[key]?.setFromDefault) continue

    if (Array.isArray(value)) {
      for (const item of value) {
        parts.push(`--${key}="${item}"`)
      }
    } else if (typeof value === 'boolean') {
      parts.push(value ? `--${key}` : `--no-${key}`)
    } else {
      parts.push(`--${key}="${value}"`)
    }
  }

  parts.push('--force')
  return parts.join(' ')
}

export function formatPreviewForAgent (
  preview: CommandPreview,
  status: 'confirmation_required' | 'dry_run',
): AgentPreviewResponse {
  return {
    status,
    command: preview.command,
    description: preview.description,
    classification: preview.classification,
    changes: preview.changes,
    confirmCommand: buildConfirmCommand(preview.command, preview.flags, preview.args, preview.flagMetadata),
  }
}

export function formatPreviewForTerminal (preview: CommandPreview): string {
  if (preview.changes.length === 1) {
    return `This will ${preview.changes[0]}`
  }

  const lines: string[] = []
  lines.push('This will:')
  for (const change of preview.changes) {
    lines.push(`  - ${change}`)
  }
  return lines.join('\n')
}