@inspecto-dev/cli 0.2.0-alpha.5 → 0.3.0-alpha.1

package/src/index.ts

@@ -1,5 +1,20 @@
+export { apply } from './commands/apply.js'
+export { detect } from './commands/detect.js'
 export { init } from './commands/init.js'
-export { doctor } from './commands/doctor.js'
+export { collectDoctorResult, doctor } from './commands/doctor.js'
+export { onboard } from './commands/onboard.js'
+export { plan } from './commands/plan.js'
 export { teardown } from './commands/teardown.js'
-export type { InitOptions, BuildTool, PackageManager, InstallLock } from './types.js'
+export { writeCommandOutput, reportCommandError } from './utils/output.js'
+export type {
+  InitOptions,
+  BuildTool,
+  PackageManager,
+  InstallLock,
+  DoctorDiagnostic,
+  DoctorResult,
+  OnboardStatus,
+  OnboardCommandResult,
+  ResolvedOnboardingSession,
+} from './types.js'
 export type { Framework } from './detect/framework.js'

package/src/inject/ast-injector.ts

@@ -15,7 +15,7 @@
 
 import path from 'node:path'
 import { loadFile, writeFile as writeAstFile } from 'magicast'
-import { exists, readFile } from '../utils/fs.js'
+import { readFile } from '../utils/fs.js'
 import { log } from '../utils/logger.js'
 import type { BuildToolDetection, Mutation } from '../types.js'
 import { STRATEGIES } from './strategies/index.js'
@@ -25,7 +25,9 @@ function printManualInstructions(
   strategy: InjectStrategy | undefined,
   detection: BuildToolDetection,
   reason: string,
+  quiet = false,
 ) {
+  if (quiet) return
   log.warn(`Could not automatically configure ${detection.configPath}`)
   log.hint(`(reason: ${reason})`)
   log.blank()
@@ -33,7 +35,7 @@ function printManualInstructions(
 
   if (strategy) {
     const instructions = strategy.getManualInstructions(detection, reason)
-    log.codeBlock(instructions)
+    log.copyableCodeBlock(instructions)
   } else {
     log.error(`Unsupported build tool: ${detection.tool}`)
   }
@@ -73,6 +75,7 @@ export async function injectPlugin(
   root: string,
   detection: BuildToolDetection,
   dryRun: boolean,
+  quiet = false,
 ): Promise<InjectionResult> {
   const configPath = path.join(root, detection.configPath)
   const mutations: Mutation[] = []
@@ -82,13 +85,15 @@ export async function injectPlugin(
   // Step 1: Read config file to check existence and idempotency
   const content = await readFile(configPath)
   if (!content) {
-    printManualInstructions(strategy, detection, 'config file not readable')
+    printManualInstructions(strategy, detection, 'config file not readable', quiet)
     return { success: false, mutations, failureReason: 'config file not readable' }
   }
 
   // Step 2: Idempotency check
   if (isAlreadyInjected(content)) {
-    log.success(`Plugin already configured in ${detection.configPath} (skipped)`)
+    if (!quiet) {
+      log.success(`Plugin already configured in ${detection.configPath} (skipped)`)
+    }
 
     mutations.push({
       type: 'file_modified',
@@ -104,13 +109,16 @@ export async function injectPlugin(
       strategy,
       detection,
       `No injection strategy found for ${detection.tool}`,
+      quiet,
     )
     return { success: false, mutations, failureReason: 'No strategy found' }
   }
 
   // Step 3: Automatic configuration
   if (dryRun) {
-    log.dryRun(`Would automatically configure plugin in ${detection.configPath}`)
+    if (!quiet) {
+      log.dryRun(`Would automatically configure plugin in ${detection.configPath}`)
+    }
     return { success: true, mutations: [] }
   }
 
@@ -132,7 +140,9 @@ export async function injectPlugin(
       description: 'Automatically configured inspecto() plugin',
     })
 
-    log.success(`Configured plugin in ${detection.configPath}`)
+    if (!quiet) {
+      log.success(`Configured plugin in ${detection.configPath}`)
+    }
     return { success: true, mutations }
   } catch (err) {
     // Graceback degradation
@@ -140,6 +150,7 @@ export async function injectPlugin(
       strategy,
       detection,
       `Automatic configuration unavailable: ${err instanceof Error ? err.message : String(err)}`,
+      quiet,
     )
     return {
       success: false,

package/src/inject/extension.ts

@@ -69,9 +69,15 @@ async function tryOpenURI(uri: string): Promise<boolean> {
 /**
  * Attempt to install the VS Code extension using waterfall degradation.
  */
-export async function installExtension(dryRun: boolean, ide?: string): Promise<Mutation | null> {
+export async function installExtension(
+  dryRun: boolean,
+  ide?: string,
+  quiet = false,
+): Promise<Mutation | null> {
   if (dryRun) {
-    log.dryRun('Would attempt to install VS Code extension')
+    if (!quiet) {
+      log.dryRun('Would attempt to install VS Code extension')
+    }
     return null
   }
 
@@ -82,7 +88,9 @@ export async function installExtension(dryRun: boolean, ide?: string): Promise<M
     if (await which('code')) {
       try {
         await run('code', ['--install-extension', EXTENSION_ID])
-        log.success('VS Code extension installed via CLI')
+        if (!quiet) {
+          log.success('VS Code extension installed via CLI')
+        }
         return { type: 'extension_installed', id: EXTENSION_ID }
       } catch {
         // Fall through to next level
@@ -94,10 +102,12 @@ export async function installExtension(dryRun: boolean, ide?: string): Promise<M
     if (codePath) {
       try {
         await run(codePath, ['--install-extension', EXTENSION_ID])
-        log.success('VS Code extension installed via binary path')
-        log.info(
-          'Tip: Add "code" to your PATH to help Inspecto detect other AI tools in the future',
-        )
+        if (!quiet) {
+          log.success('VS Code extension installed via binary path')
+          log.info(
+            'Tip: Add "code" to your PATH to help Inspecto detect other AI tools in the future',
+          )
+        }
         return { type: 'extension_installed', id: EXTENSION_ID }
       } catch {
         // Fall through to next level
@@ -107,29 +117,37 @@ export async function installExtension(dryRun: boolean, ide?: string): Promise<M
     // Level 3: URI scheme
     const uri = `vscode:extension/${EXTENSION_ID}`
     if (await tryOpenURI(uri)) {
-      log.warn('Opened extension page in VS Code')
-      log.hint('Please click "Install" in the opened VS Code window to complete setup.')
+      if (!quiet) {
+        log.warn('Opened extension page in VS Code')
+        log.hint('Please click "Install" in the opened VS Code window to complete setup.')
+      }
       return { type: 'extension_installed', id: EXTENSION_ID, manual_action_required: true }
     }
 
     // Level 4: Manual fallback
-    log.warn('Could not auto-install VS Code extension')
-    log.hint('Please install it manually to enable Inspector features:')
-    log.hint('  1. Open VS Code')
-    log.hint('  2. Press Ctrl+Shift+X (or Cmd+Shift+X)')
-    log.hint('  3. Search for "Inspecto"')
-    log.hint(`  Or visit: https://marketplace.visualstudio.com/items?itemName=${EXTENSION_ID}`)
+    if (!quiet) {
+      log.warn('Could not auto-install VS Code extension')
+      log.hint('Please install it manually to enable Inspector features:')
+      log.hint('  1. Open VS Code')
+      log.hint('  2. Press Ctrl+Shift+X (or Cmd+Shift+X)')
+      log.hint('  3. Search for "Inspecto"')
+      log.hint(`  Or visit: https://marketplace.visualstudio.com/items?itemName=${EXTENSION_ID}`)
+    }
     return null
   }
 
   // Other IDEs: Prompt to install via VSIX
-  log.warn(`Could not auto-install extension for ${ide}`)
-  log.hint('Please install it manually to enable Inspector features:')
-  log.hint('  1. Download the latest .vsix file from Inspecto releases')
-  log.hint(`  2. Open ${ide}`)
-  log.hint('  3. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P)')
-  log.hint('  4. Type and select "Extensions: Install from VSIX..."')
-  log.hint('  5. Select the downloaded .vsix file')
+  if (!quiet) {
+    log.warn(`Could not auto-install extension for ${ide}`)
+    log.hint('Please install it manually to enable Inspector features:')
+    log.hint(
+      '  1. Download the latest .vsix file (Open VSX: https://open-vsx.org/extension/inspecto/inspecto)',
+    )
+    log.hint(`  2. Open ${ide}`)
+    log.hint('  3. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P)')
+    log.hint('  4. Type and select "Extensions: Install from VSIX..."')
+    log.hint('  5. Select the downloaded .vsix file')
+  }
   return null
 }
 

package/src/inject/gitignore.ts

@@ -21,6 +21,7 @@ export async function updateGitignore(
   root: string,
   shared: boolean,
   dryRun: boolean,
+  quiet = false,
 ): Promise<void> {
   const gitignorePath = path.join(root, '.gitignore')
   let content = (await readFile(gitignorePath)) ?? ''
@@ -34,7 +35,9 @@ export async function updateGitignore(
     if (!dryRun) {
       await writeFile(gitignorePath, content)
     }
-    log.success('Updated .gitignore: .inspecto/ is no longer fully ignored')
+    if (!quiet) {
+      log.success('Updated .gitignore: .inspecto/ is no longer fully ignored')
+    }
     return
   }
 
@@ -49,10 +52,14 @@ export async function updateGitignore(
   content = content.trimEnd() + '\n' + section
 
   if (dryRun) {
-    log.dryRun(`Would update .gitignore with: ${missingRules.join(', ')}`)
+    if (!quiet) {
+      log.dryRun(`Would update .gitignore with: ${missingRules.join(', ')}`)
+    }
   } else {
     await writeFile(gitignorePath, content)
-    log.success('Updated .gitignore')
+    if (!quiet) {
+      log.success('Updated .gitignore')
+    }
   }
 }
 

package/src/instructions.ts

@@ -2,54 +2,68 @@ import { log } from './utils/logger.js'
 
 export function printNuxtManualInstructions() {
   log.blank()
-  log.hint('To enable Inspecto in Nuxt, update your nuxt.config.ts:')
-  console.log(`\x1b[36m
-  import { vitePlugin as inspecto } from '@inspecto-dev/plugin'
-  export default defineNuxtConfig({
-    vite: {
-      plugins: [inspecto()]
-    }
-  })
-\x1b[0m`)
-  log.hint('And create a Nuxt plugin at plugins/inspecto.client.ts:')
-  console.log(`\x1b[36m
-  export default defineNuxtPlugin(() => {
-    if (import.meta.dev) {
-      import('@inspecto-dev/core').then(({ mountInspector }) => {
-        mountInspector()
-      })
-    }
-  })
-\x1b[0m`)
+  log.hint('Nuxt requires manual setup in the current version.')
+  log.hint('1. Update `nuxt.config.ts` to register the Inspecto Vite plugin:')
+  log.copyableCodeBlock([
+    "import { vitePlugin as inspecto } from '@inspecto-dev/plugin'",
+    '',
+    'export default defineNuxtConfig({',
+    '  vite: {',
+    '    plugins: [inspecto()],',
+    '  },',
+    '})',
+  ])
+  log.hint('2. Create `plugins/inspecto.client.ts` to mount `@inspecto-dev/core` in development:')
+  log.copyableCodeBlock([
+    'export default defineNuxtPlugin(() => {',
+    '  if (import.meta.dev) {',
+    "    import('@inspecto-dev/core').then(({ mountInspector }) => {",
+    '      mountInspector()',
+    '    })',
+    '  }',
+    '})',
+  ])
+  log.hint('3. Restart your Nuxt dev server after updating the config.')
 }
 
 export function printNextJsManualInstructions() {
   log.blank()
-  log.hint('To enable Inspecto in Next.js, update your next.config.mjs:')
-  console.log(`\x1b[36m
-  import { webpackPlugin as inspecto } from '@inspecto-dev/plugin'
-  const nextConfig = {
-    webpack: (config, { dev, isServer }) => {
-      if (dev && !isServer) config.plugins.push(inspecto())
-      return config
-    }
-  }
-  export default nextConfig
-\x1b[0m`)
-  log.hint('And initialize the client dynamically in your app/layout.tsx (or pages/_app.tsx):')
-  console.log(`\x1b[36m
-  'use client'
-  import { useEffect } from 'react'
-
-  export default function RootLayout({ children }) {
-    useEffect(() => {
-      if (process.env.NODE_ENV !== 'production') {
-        import('@inspecto-dev/core').then(({ mountInspector }) => {
-          mountInspector({ serverUrl: 'http://127.0.0.1:5678' })
-        })
-      }
-    }, [])
-    return <html><body>{children}</body></html>
-  }
-\x1b[0m`)
+  log.hint('Next.js requires manual setup in the current version.')
+  log.hint('1. Update `next.config.mjs` to register the Inspecto webpack plugin:')
+  log.copyableCodeBlock([
+    "import { webpackPlugin as inspecto } from '@inspecto-dev/plugin'",
+    '',
+    "/** @type {import('next').NextConfig} */",
+    'const nextConfig = {',
+    '  webpack: (config, { dev, isServer }) => {',
+    '    if (dev && !isServer) {',
+    '      config.plugins.push(inspecto())',
+    '    }',
+    '    return config',
+    '  },',
+    '}',
+    '',
+    'export default nextConfig',
+  ])
+  log.hint(
+    '2. Initialize `@inspecto-dev/core` from a client component such as `app/layout.tsx` or `pages/_app.tsx`:',
+  )
+  log.copyableCodeBlock([
+    "'use client'",
+    '',
+    "import { useEffect } from 'react'",
+    '',
+    'export default function RootLayout({ children }) {',
+    '  useEffect(() => {',
+    "    if (process.env.NODE_ENV !== 'production') {",
+    "      import('@inspecto-dev/core').then(({ mountInspector }) => {",
+    "        mountInspector({ serverUrl: 'http://127.0.0.1:5678' })",
+    '      })',
+    '    }',
+    '  }, [])',
+    '',
+    '  return <html><body>{children}</body></html>',
+    '}',
+  ])
+  log.hint('3. Restart your Next.js dev server after updating the config.')
 }