opencodekit 0.12.0 → 0.12.2

package/dist/template/.opencode/tool/lsp.ts

@@ -1,786 +0,0 @@
-/**
- * LSP Refactor Tools for OpenCode
- * Semantic code refactoring using Language Server Protocol
- *
- * Provides: lsp_rename, lsp_code_actions, lsp_code_action_apply, lsp_organize_imports
- *
- * Uses OpenCode's bundled LSP servers when available, falls back to system-installed servers.
- * @see https://opencode.ai/docs/lsp/
- */
-
-import { resolve } from "node:path";
-import { tool } from "@opencode-ai/plugin";
-import { lspManager } from "../lib/lsp/client";
-import { resolveServer } from "../lib/lsp/config";
-import type {
-	CodeAction,
-	Diagnostic,
-	DocumentSymbol,
-	HoverResult,
-	Location,
-	LocationLink,
-	PrepareRenameResult,
-	SymbolInfo,
-	WorkspaceEdit,
-} from "../lib/lsp/types";
-import {
-	applyWorkspaceEdit,
-	formatWorkspaceEditPreview,
-} from "../lib/lsp/utils";
-
-/**
- * Rename a symbol across the entire codebase using LSP
- */
-export const lsp_rename = tool({
-	description: `Rename a symbol (function, variable, class, etc.) across the entire codebase using LSP.
-
-This tool performs semantic renaming - it understands code structure and renames all references correctly, including:
-- Function/method definitions and all their calls
-- Variable declarations and usages
-- Class names and their instantiations
-- Import/export statements
-
-IMPORTANT: This tool directly modifies files. Review the changes shown in output.`,
-
-	args: {
-		filePath: tool.schema
-			.string()
-			.describe("Path to the file containing the symbol to rename"),
-		line: tool.schema
-			.number()
-			.describe("Line number (1-based) where the symbol is located"),
-		character: tool.schema
-			.number()
-			.describe("Character position (0-based) within the line"),
-		newName: tool.schema.string().describe("The new name for the symbol"),
-	},
-
-	async execute(args) {
-		const cwd = process.cwd();
-		const absPath = resolve(cwd, args.filePath);
-		const server = resolveServer(absPath);
-
-		if (!server) {
-			return `Error: No LSP server available for file type: ${absPath}
-
-OpenCode supports 30+ languages with built-in LSP servers.
-See https://opencode.ai/docs/lsp/ for the full list.
-
-Common servers:
-- TypeScript: Requires 'typescript' in project dependencies
-- Python: Requires 'pyright' dependency installed
-- Go: Requires 'go' command available
-- Rust: Requires 'rust-analyzer' command available
-- Java: Requires Java SDK 21+ installed (OpenCode auto-installs jdtls)
-- C/C++: Requires 'clangd' available (OpenCode auto-installs for C/C++ projects)`;
-		}
-
-		try {
-			const client = await lspManager.getClient(cwd, server);
-
-			const prepareResult = (await client.prepareRename(
-				absPath,
-				args.line,
-				args.character,
-			)) as PrepareRenameResult | null;
-			if (!prepareResult) {
-				lspManager.releaseClient(cwd, server.id);
-				return "Error: Cannot rename at this position. Make sure the cursor is on a valid symbol.";
-			}
-
-			const result = (await client.rename(
-				absPath,
-				args.line,
-				args.character,
-				args.newName,
-			)) as WorkspaceEdit | null;
-			lspManager.releaseClient(cwd, server.id);
-
-			if (!result) {
-				return "Error: Rename returned no changes.";
-			}
-
-			const preview = formatWorkspaceEditPreview(result);
-			const applyResult = applyWorkspaceEdit(result);
-
-			if (!applyResult.success) {
-				return `Error applying changes: ${applyResult.error}\n\nPlanned changes:\n${preview}`;
-			}
-
-			return `Successfully renamed to "${args.newName}".
-
-Files modified:
-${applyResult.filesModified.map((f) => `  - ${f}`).join("\n")}
-
-Note: Files were modified directly. Re-read before editing.`;
-		} catch (error) {
-			return `Error: ${error instanceof Error ? error.message : String(error)}`;
-		}
-	},
-});
-
-/**
- * Get available code actions for a code range
- */
-export const lsp_code_actions = tool({
-	description: `Get available code actions (quick fixes, refactorings) for a code range.
-
-This tool lists available actions like:
-- Quick fixes for diagnostics/errors
-- Refactoring options (extract function, inline variable, etc.)
-- Source actions (organize imports, fix all)
-
-Use lsp_code_action_apply to execute a specific action.`,
-
-	args: {
-		filePath: tool.schema.string().describe("Path to the file"),
-		startLine: tool.schema.number().describe("Start line (1-based)"),
-		startCharacter: tool.schema.number().describe("Start character (0-based)"),
-		endLine: tool.schema.number().describe("End line (1-based)"),
-		endCharacter: tool.schema.number().describe("End character (0-based)"),
-		only: tool.schema
-			.array(tool.schema.string())
-			.optional()
-			.describe(
-				"Filter by action kind: 'quickfix', 'refactor', 'refactor.extract', 'source.organizeImports'",
-			),
-	},
-
-	async execute(args) {
-		const cwd = process.cwd();
-		const absPath = resolve(cwd, args.filePath);
-		const server = resolveServer(absPath);
-
-		if (!server) {
-			return `Error: No LSP server available for file type: ${absPath}`;
-		}
-
-		try {
-			const client = await lspManager.getClient(cwd, server);
-			const result = (await client.codeAction(
-				absPath,
-				args.startLine,
-				args.startCharacter,
-				args.endLine,
-				args.endCharacter,
-				args.only,
-			)) as CodeAction[] | null;
-			lspManager.releaseClient(cwd, server.id);
-
-			if (!result || result.length === 0) {
-				return "No code actions available for this range.";
-			}
-
-			const actions = result.map((action, index) => {
-				const parts = [`${index + 1}. ${action.title}`];
-				if (action.kind) parts.push(`   Kind: ${action.kind}`);
-				if (action.isPreferred) parts.push("   (Preferred)");
-				if (action.disabled)
-					parts.push(`   (Disabled: ${action.disabled.reason})`);
-				return parts.join("\n");
-			});
-
-			return `Available code actions:\n\n${actions.join("\n\n")}\n\nUse lsp_refactor_code_action_apply with the action index to apply.`;
-		} catch (error) {
-			return `Error: ${error instanceof Error ? error.message : String(error)}`;
-		}
-	},
-});
-
-/**
- * Apply a specific code action
- */
-export const lsp_code_action_apply = tool({
-	description: `Apply a specific code action from lsp_refactor_code_actions.
-
-First call lsp_refactor_code_actions to see available actions, then use this tool with the action index to apply it.`,
-
-	args: {
-		filePath: tool.schema.string().describe("Path to the file"),
-		startLine: tool.schema.number().describe("Start line (1-based)"),
-		startCharacter: tool.schema.number().describe("Start character (0-based)"),
-		endLine: tool.schema.number().describe("End line (1-based)"),
-		endCharacter: tool.schema.number().describe("End character (0-based)"),
-		actionIndex: tool.schema
-			.number()
-			.describe(
-				"Index of the action to apply (1-based, from lsp_refactor_code_actions output)",
-			),
-		only: tool.schema
-			.array(tool.schema.string())
-			.optional()
-			.describe(
-				"Filter by action kind (same filter used in lsp_refactor_code_actions)",
-			),
-	},
-
-	async execute(args) {
-		const cwd = process.cwd();
-		const absPath = resolve(cwd, args.filePath);
-		const server = resolveServer(absPath);
-
-		if (!server) {
-			return `Error: No LSP server available for file type: ${absPath}`;
-		}
-
-		try {
-			const client = await lspManager.getClient(cwd, server);
-			const actions = (await client.codeAction(
-				absPath,
-				args.startLine,
-				args.startCharacter,
-				args.endLine,
-				args.endCharacter,
-				args.only,
-			)) as CodeAction[] | null;
-
-			if (!actions || actions.length === 0) {
-				lspManager.releaseClient(cwd, server.id);
-				return "No code actions available for this range.";
-			}
-
-			if (args.actionIndex < 1 || args.actionIndex > actions.length) {
-				lspManager.releaseClient(cwd, server.id);
-				return `Invalid action index. Available: 1-${actions.length}`;
-			}
-
-			let action = actions[args.actionIndex - 1];
-
-			if (action.data && !action.edit) {
-				action = (await client.codeActionResolve(action)) as CodeAction;
-			}
-
-			lspManager.releaseClient(cwd, server.id);
-
-			if (!action.edit) {
-				if (action.command) {
-					return `Action "${action.title}" has a command instead of edits. Commands are not supported yet.`;
-				}
-				return `Action "${action.title}" produced no edits.`;
-			}
-
-			const applyResult = applyWorkspaceEdit(action.edit);
-
-			if (!applyResult.success) {
-				return `Error applying action: ${applyResult.error}`;
-			}
-
-			return `Applied: "${action.title}"
-
-Files modified:
-${applyResult.filesModified.map((f) => `  - ${f}`).join("\n")}
-
-Note: Files were modified directly. Re-read before editing.`;
-		} catch (error) {
-			return `Error: ${error instanceof Error ? error.message : String(error)}`;
-		}
-	},
-});
-
-/**
- * Organize imports in a file
- */
-export const lsp_organize_imports = tool({
-	description: `Organize imports in a file using LSP.
-
-This removes unused imports and sorts/groups remaining imports according to language conventions.`,
-
-	args: {
-		filePath: tool.schema.string().describe("Path to the file"),
-	},
-
-	async execute(args) {
-		const cwd = process.cwd();
-		const absPath = resolve(cwd, args.filePath);
-		const server = resolveServer(absPath);
-
-		if (!server) {
-			return `Error: No LSP server available for file type: ${absPath}`;
-		}
-
-		try {
-			const client = await lspManager.getClient(cwd, server);
-			const actions = (await client.codeAction(absPath, 1, 0, 10000, 0, [
-				"source.organizeImports",
-			])) as CodeAction[] | null;
-
-			if (!actions || actions.length === 0) {
-				lspManager.releaseClient(cwd, server.id);
-				return "No organize imports action available for this file.";
-			}
-
-			let action = actions[0];
-			if (action.data && !action.edit) {
-				action = (await client.codeActionResolve(action)) as CodeAction;
-			}
-			lspManager.releaseClient(cwd, server.id);
-
-			if (!action.edit) {
-				return "Organize imports produced no changes (imports may already be organized).";
-			}
-
-			const applyResult = applyWorkspaceEdit(action.edit);
-
-			if (!applyResult.success) {
-				return `Error organizing imports: ${applyResult.error}`;
-			}
-
-			return `Imports organized in ${args.filePath}
-
-Note: File was modified directly. Re-read before editing.`;
-		} catch (error) {
-			return `Error: ${error instanceof Error ? error.message : String(error)}`;
-		}
-	},
-});
-
-/**
- * Get hover information (type/documentation) at a position
- */
-export const lsp_hover = tool({
-	description: `Get type information and documentation for a symbol at a specific position.
-
-Returns type signatures, JSDoc/docstrings, and other hover information the language server provides.
-Useful for understanding what a variable/function is without reading its definition.`,
-
-	args: {
-		filePath: tool.schema.string().describe("Path to the file"),
-		line: tool.schema.number().describe("Line number (1-based)"),
-		character: tool.schema.number().describe("Character position (0-based)"),
-	},
-
-	async execute(args) {
-		const cwd = process.cwd();
-		const absPath = resolve(cwd, args.filePath);
-		const server = resolveServer(absPath);
-
-		if (!server) {
-			return `Error: No LSP server available for file type: ${absPath}`;
-		}
-
-		try {
-			const client = await lspManager.getClient(cwd, server);
-			const result = (await client.hover(
-				absPath,
-				args.line,
-				args.character,
-			)) as HoverResult | null;
-			lspManager.releaseClient(cwd, server.id);
-
-			if (!result) {
-				return "No hover information available at this position.";
-			}
-
-			return formatHoverResult(result);
-		} catch (error) {
-			return `Error: ${error instanceof Error ? error.message : String(error)}`;
-		}
-	},
-});
-
-/**
- * Go to definition of a symbol
- */
-export const lsp_goto_definition = tool({
-	description: `Find the definition location of a symbol at a specific position.
-
-Returns the file path and position where the symbol is defined.
-Works for functions, variables, classes, types, imports, etc.`,
-
-	args: {
-		filePath: tool.schema.string().describe("Path to the file"),
-		line: tool.schema.number().describe("Line number (1-based)"),
-		character: tool.schema.number().describe("Character position (0-based)"),
-	},
-
-	async execute(args) {
-		const cwd = process.cwd();
-		const absPath = resolve(cwd, args.filePath);
-		const server = resolveServer(absPath);
-
-		if (!server) {
-			return `Error: No LSP server available for file type: ${absPath}`;
-		}
-
-		try {
-			const client = await lspManager.getClient(cwd, server);
-			const result = (await client.definition(
-				absPath,
-				args.line,
-				args.character,
-			)) as Location | Location[] | LocationLink[] | null;
-			lspManager.releaseClient(cwd, server.id);
-
-			if (!result) {
-				return "No definition found at this position.";
-			}
-
-			return formatLocations(result);
-		} catch (error) {
-			return `Error: ${error instanceof Error ? error.message : String(error)}`;
-		}
-	},
-});
-
-/**
- * Find all references to a symbol
- */
-export const lsp_find_references = tool({
-	description: `Find all references to a symbol across the workspace.
-
-Returns all locations where the symbol is used, including the definition.
-Useful for understanding usage before refactoring.`,
-
-	args: {
-		filePath: tool.schema.string().describe("Path to the file"),
-		line: tool.schema.number().describe("Line number (1-based)"),
-		character: tool.schema.number().describe("Character position (0-based)"),
-		includeDeclaration: tool.schema
-			.boolean()
-			.optional()
-			.describe("Include the declaration itself (default: true)"),
-	},
-
-	async execute(args) {
-		const cwd = process.cwd();
-		const absPath = resolve(cwd, args.filePath);
-		const server = resolveServer(absPath);
-
-		if (!server) {
-			return `Error: No LSP server available for file type: ${absPath}`;
-		}
-
-		try {
-			const client = await lspManager.getClient(cwd, server);
-			const result = (await client.references(
-				absPath,
-				args.line,
-				args.character,
-				args.includeDeclaration ?? true,
-			)) as Location[] | null;
-			lspManager.releaseClient(cwd, server.id);
-
-			if (!result || result.length === 0) {
-				return "No references found.";
-			}
-
-			const locations = result.slice(0, 50); // Limit results
-			const formatted = locations.map((loc) => formatLocation(loc)).join("\n");
-			const suffix =
-				result.length > 50 ? `\n\n... and ${result.length - 50} more` : "";
-
-			return `Found ${result.length} reference(s):\n\n${formatted}${suffix}`;
-		} catch (error) {
-			return `Error: ${error instanceof Error ? error.message : String(error)}`;
-		}
-	},
-});
-
-/**
- * Get document symbols (outline) for a file
- */
-export const lsp_document_symbols = tool({
-	description: `Get the symbol outline of a file (classes, functions, variables, etc.).
-
-Returns a hierarchical structure of all symbols in the file.
-Useful for understanding file structure quickly.`,
-
-	args: {
-		filePath: tool.schema.string().describe("Path to the file"),
-	},
-
-	async execute(args) {
-		const cwd = process.cwd();
-		const absPath = resolve(cwd, args.filePath);
-		const server = resolveServer(absPath);
-
-		if (!server) {
-			return `Error: No LSP server available for file type: ${absPath}`;
-		}
-
-		try {
-			const client = await lspManager.getClient(cwd, server);
-			const result = (await client.documentSymbols(absPath)) as
-				| DocumentSymbol[]
-				| SymbolInfo[]
-				| null;
-			lspManager.releaseClient(cwd, server.id);
-
-			if (!result || result.length === 0) {
-				return "No symbols found in this file.";
-			}
-
-			return formatDocumentSymbols(result);
-		} catch (error) {
-			return `Error: ${error instanceof Error ? error.message : String(error)}`;
-		}
-	},
-});
-
-/**
- * Search for symbols across the workspace
- */
-export const lsp_workspace_symbols = tool({
-	description: `Search for symbols by name across the entire workspace.
-
-Performs fuzzy matching on symbol names (functions, classes, variables, etc.).
-Useful for finding where something is defined without knowing the exact file.`,
-
-	args: {
-		query: tool.schema
-			.string()
-			.describe("Symbol name to search for (fuzzy match)"),
-		filePath: tool.schema
-			.string()
-			.optional()
-			.describe("Any file in the project (used to determine language server)"),
-	},
-
-	async execute(args) {
-		const cwd = process.cwd();
-		const absPath = args.filePath
-			? resolve(cwd, args.filePath)
-			: resolve(cwd, ".");
-		const server = resolveServer(absPath);
-
-		if (!server) {
-			return `Error: No LSP server available. Provide a filePath to help identify the language.`;
-		}
-
-		try {
-			const client = await lspManager.getClient(cwd, server);
-			const result = (await client.workspaceSymbols(args.query)) as
-				| SymbolInfo[]
-				| null;
-			lspManager.releaseClient(cwd, server.id);
-
-			if (!result || result.length === 0) {
-				return `No symbols found matching "${args.query}".`;
-			}
-
-			const symbols = result.slice(0, 30); // Limit results
-			const formatted = symbols
-				.map(
-					(sym) =>
-						`${getSymbolKindName(sym.kind)} ${sym.name}${sym.containerName ? ` (in ${sym.containerName})` : ""}\n  ${formatUri(sym.location.uri)}:${sym.location.range.start.line + 1}`,
-				)
-				.join("\n\n");
-			const suffix =
-				result.length > 30 ? `\n\n... and ${result.length - 30} more` : "";
-
-			return `Found ${result.length} symbol(s):\n\n${formatted}${suffix}`;
-		} catch (error) {
-			return `Error: ${error instanceof Error ? error.message : String(error)}`;
-		}
-	},
-});
-
-/**
- * Get diagnostics (errors, warnings) for a file
- */
-export const lsp_diagnostics = tool({
-	description: `Get diagnostics (errors, warnings, hints) for a file from the language server.
-
-Returns type errors, lint warnings, and other issues detected by the language server.
-Useful for checking if code has problems before running tests.`,
-
-	args: {
-		filePath: tool.schema.string().describe("Path to the file"),
-		severity: tool.schema
-			.string()
-			.optional()
-			.describe(
-				"Filter by severity: 'error', 'warning', 'info', 'hint', or 'all' (default: all)",
-			),
-	},
-
-	async execute(args) {
-		const cwd = process.cwd();
-		const absPath = resolve(cwd, args.filePath);
-		const server = resolveServer(absPath);
-
-		if (!server) {
-			return `Error: No LSP server available for file type: ${absPath}`;
-		}
-
-		try {
-			const client = await lspManager.getClient(cwd, server);
-			const result = await client.diagnostics(absPath);
-			lspManager.releaseClient(cwd, server.id);
-
-			let diagnostics = result.items || [];
-
-			// Filter by severity if specified
-			if (args.severity && args.severity !== "all") {
-				const severityMap: Record<string, number> = {
-					error: 1,
-					warning: 2,
-					info: 3,
-					hint: 4,
-				};
-				const targetSeverity = severityMap[args.severity.toLowerCase()];
-				if (targetSeverity) {
-					diagnostics = diagnostics.filter(
-						(d) => d.severity === targetSeverity,
-					);
-				}
-			}
-
-			if (diagnostics.length === 0) {
-				return args.severity && args.severity !== "all"
-					? `No ${args.severity} diagnostics found.`
-					: "No diagnostics found. File appears clean.";
-			}
-
-			return formatDiagnostics(diagnostics, args.filePath);
-		} catch (error) {
-			return `Error: ${error instanceof Error ? error.message : String(error)}`;
-		}
-	},
-});
-
-// ============ Helper Functions ============
-
-function formatHoverResult(hover: HoverResult): string {
-	const contents = hover.contents;
-
-	if (typeof contents === "string") {
-		return contents;
-	}
-
-	if (Array.isArray(contents)) {
-		return contents
-			.map((c) => (typeof c === "string" ? c : c.value))
-			.join("\n\n");
-	}
-
-	if (typeof contents === "object" && "value" in contents) {
-		return contents.value;
-	}
-
-	return JSON.stringify(contents);
-}
-
-function formatUri(uri: string): string {
-	return uri.replace("file://", "").replace(process.cwd() + "/", "");
-}
-
-function formatLocation(loc: Location | LocationLink): string {
-	if ("targetUri" in loc) {
-		return `${formatUri(loc.targetUri)}:${loc.targetRange.start.line + 1}:${loc.targetRange.start.character}`;
-	}
-	return `${formatUri(loc.uri)}:${loc.range.start.line + 1}:${loc.range.start.character}`;
-}
-
-function formatLocations(
-	result: Location | Location[] | LocationLink[],
-): string {
-	const locations = Array.isArray(result) ? result : [result];
-
-	if (locations.length === 0) {
-		return "No locations found.";
-	}
-
-	if (locations.length === 1) {
-		return `Definition: ${formatLocation(locations[0] as Location | LocationLink)}`;
-	}
-
-	return `Found ${locations.length} location(s):\n${locations.map((l) => `  ${formatLocation(l as Location | LocationLink)}`).join("\n")}`;
-}
-
-function formatDocumentSymbols(
-	symbols: DocumentSymbol[] | SymbolInfo[],
-	indent = 0,
-): string {
-	const prefix = "  ".repeat(indent);
-	const lines: string[] = [];
-
-	for (const sym of symbols) {
-		const kindName = getSymbolKindName(sym.kind);
-		const line =
-			"range" in sym
-				? sym.range.start.line + 1
-				: "location" in sym
-					? sym.location.range.start.line + 1
-					: "?";
-
-		lines.push(`${prefix}${kindName} ${sym.name} (line ${line})`);
-
-		if ("children" in sym && sym.children) {
-			lines.push(formatDocumentSymbols(sym.children, indent + 1));
-		}
-	}
-
-	return lines.join("\n");
-}
-
-function formatDiagnostics(
-	diagnostics: Diagnostic[],
-	filePath: string,
-): string {
-	const severityNames = ["", "Error", "Warning", "Info", "Hint"];
-
-	const sorted = [...diagnostics].sort((a, b) => {
-		const sevA = a.severity ?? 4;
-		const sevB = b.severity ?? 4;
-		if (sevA !== sevB) return sevA - sevB;
-		return a.range.start.line - b.range.start.line;
-	});
-
-	const lines = sorted.map((d) => {
-		const sev = severityNames[d.severity ?? 4] || "Unknown";
-		const line = d.range.start.line + 1;
-		const col = d.range.start.character + 1;
-		const source = d.source ? `[${d.source}]` : "";
-		const code = d.code ? ` (${d.code})` : "";
-		return `${sev}: ${filePath}:${line}:${col}${code} ${source}\n  ${d.message}`;
-	});
-
-	const errorCount = diagnostics.filter((d) => d.severity === 1).length;
-	const warnCount = diagnostics.filter((d) => d.severity === 2).length;
-
-	let summary = `Found ${diagnostics.length} diagnostic(s)`;
-	if (errorCount > 0 || warnCount > 0) {
-		const parts: string[] = [];
-		if (errorCount > 0) parts.push(`${errorCount} error(s)`);
-		if (warnCount > 0) parts.push(`${warnCount} warning(s)`);
-		summary += `: ${parts.join(", ")}`;
-	}
-
-	return `${summary}\n\n${lines.join("\n\n")}`;
-}
-
-function getSymbolKindName(kind: number): string {
-	const kinds: Record<number, string> = {
-		1: "File",
-		2: "Module",
-		3: "Namespace",
-		4: "Package",
-		5: "Class",
-		6: "Method",
-		7: "Property",
-		8: "Field",
-		9: "Constructor",
-		10: "Enum",
-		11: "Interface",
-		12: "Function",
-		13: "Variable",
-		14: "Constant",
-		15: "String",
-		16: "Number",
-		17: "Boolean",
-		18: "Array",
-		19: "Object",
-		20: "Key",
-		21: "Null",
-		22: "EnumMember",
-		23: "Struct",
-		24: "Event",
-		25: "Operator",
-		26: "TypeParameter",
-	};
-	return kinds[kind] || `Kind(${kind})`;
-}
-
-// Default export for single-tool registration (uses rename as primary)
-export default lsp_rename;