/** * Adapter Interface for Multi-Tool Support * * Defines the contract that all SpecWeave adapters must implement. * Enables SpecWeave to work with ANY AI coding tool (Claude, Cursor, Copilot/ChatGPT/Gemini via generic, etc.) */ import type { Plugin } from '../core/types/plugin.js'; export interface AdapterOptions { projectPath: string; projectName: string; techStack?: { language: string; framework?: string; }; docsApproach?: 'comprehensive' | 'incremental'; } export interface RequirementsResult { met: boolean; missing: string[]; warnings: string[]; } export interface AdapterFile { sourcePath: string; targetPath: string; description: string; } export type AutomationLevel = 'full' | 'semi' | 'basic' | 'manual'; /** * Base Adapter Interface * * All adapters (Cursor, Generic) must implement this interface. * Note: Claude Code is NOT an adapter - it's the native baseline experience. */ export interface IAdapter { /** * Adapter name (e.g., 'cursor', 'generic') */ name: string; /** * Human-readable description of what this adapter provides */ description: string; /** * Automation level this adapter provides * - full: Complete automation (skills, agents, hooks auto-activate) * - semi: Semi-automated (context shortcuts, multi-file editing) * - basic: Basic automation (workspace instructions, suggestions) * - manual: Manual workflow (step-by-step guide) */ automationLevel: AutomationLevel; /** * Detect if this adapter's tool is present in the environment * * Examples: * - Cursor: Check for .cursor/ directory or Cursor process * - Generic: Always true (fallback for any tool) * * @returns Promise True if tool detected */ detect(): Promise; /** * Check if system requirements are met for this adapter * * Examples: * - Node.js version >= 18 * - Git installed * - Tool-specific requirements * * @returns Promise Requirements check result */ checkRequirements(): Promise; /** * Get list of files this adapter will install * * @returns AdapterFile[] Array of files to install */ getFiles(): AdapterFile[]; /** * Install this adapter to a project * * Creates tool-specific files (e.g., .cursorrules for Cursor, AGENTS.md for all) * Installs relevant skills/agents if applicable * * @param options Installation options * @returns Promise */ install(options: AdapterOptions): Promise; /** * Post-installation actions * * Examples: * - Create symlinks * - Update config files * - Display setup instructions to user * * @param options Installation options * @returns Promise */ postInstall(options: AdapterOptions): Promise; /** * Get human-readable instructions for using this adapter * * Displayed to user after installation * * @returns string Markdown-formatted instructions */ getInstructions(): string; /** * Check if this adapter supports plugins * * Returns true if the adapter can install and compile plugins * (Cursor AGENTS.md compilation, Generic AGENTS.md) * Returns false for manual-only adapters * * @returns boolean True if plugins are supported */ supportsPlugins(): boolean; /** * Compile and install a plugin for this adapter * * Transforms plugin content (skills/agents/commands) to tool-specific format: * - Cursor: Compile to AGENTS.md + team commands JSON * - Generic: Compile to AGENTS.md for Copilot/ChatGPT/Gemini * * Note: Claude Code uses native plugin system (no compilation needed) * * @param plugin Plugin to compile and install * @returns Promise */ compilePlugin(plugin: Plugin): Promise; /** * Unload (disable) a plugin for this adapter * * Removes plugin-specific files and restores previous state * * @param pluginName Name of plugin to unload * @returns Promise */ unloadPlugin(pluginName: string): Promise; /** * Get plugin installation status * * Returns information about which plugins are currently installed * * @returns Promise Array of installed plugin names */ getInstalledPlugins(): Promise; /** * Get the tool-specific skills directory path (relative to project root). * * Used by refresh-plugins to determine where to copy skill files * for this adapter's AI tool. * * @returns string Relative path like '.cursor/skills' or '.opencode/skills' */ getSkillsDirectory(): string; } //# sourceMappingURL=adapter-interface.d.ts.map