File size: 10,695 Bytes
064bfd6 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 | /**
* LSP Plugin Recommendation Utility
*
* Scans installed marketplaces for LSP plugins and recommends plugins
* based on file extensions, but ONLY when the LSP binary is already
* installed on the system.
*
* Limitation: Can only detect LSP plugins that declare their servers
* inline in the marketplace entry. Plugins with separate .lsp.json files
* are not detectable until after installation.
*/
import { extname } from 'path'
import { isBinaryInstalled } from '../binaryCheck.js'
import { getGlobalConfig, saveGlobalConfig } from '../config.js'
import { logForDebugging } from '../debug.js'
import { isPluginInstalled } from './installedPluginsManager.js'
import {
getMarketplace,
loadKnownMarketplacesConfig,
} from './marketplaceManager.js'
import {
ALLOWED_OFFICIAL_MARKETPLACE_NAMES,
type PluginMarketplaceEntry,
} from './schemas.js'
/**
* LSP plugin recommendation returned to the caller
*/
export type LspPluginRecommendation = {
pluginId: string // "plugin-name@marketplace-name"
pluginName: string // Human-readable plugin name
marketplaceName: string // Marketplace name
description?: string // Plugin description
isOfficial: boolean // From official marketplace?
extensions: string[] // File extensions this plugin supports
command: string // LSP server command (e.g., "typescript-language-server")
}
// Maximum number of times user can ignore recommendations before we stop showing
const MAX_IGNORED_COUNT = 5
/**
* Check if a marketplace is official (from Anthropic)
*/
function isOfficialMarketplace(name: string): boolean {
return ALLOWED_OFFICIAL_MARKETPLACE_NAMES.has(name.toLowerCase())
}
/**
* Internal type for LSP info extracted from plugin manifest
*/
type LspInfo = {
extensions: Set<string>
command: string
}
/**
* Extract LSP info (extensions and command) from inline lspServers config.
*
* NOTE: Can only read inline configs, not external .lsp.json files.
* String paths are skipped as they reference files only available after installation.
*
* @param lspServers - The lspServers field from PluginMarketplaceEntry
* @returns LSP info with extensions and command, or null if not extractable
*/
function extractLspInfoFromManifest(
lspServers: PluginMarketplaceEntry['lspServers'],
): LspInfo | null {
if (!lspServers) {
return null
}
// If it's a string path (e.g., "./.lsp.json"), we can't read it from marketplace
if (typeof lspServers === 'string') {
logForDebugging(
'[lspRecommendation] Skipping string path lspServers (not readable from marketplace)',
)
return null
}
// If it's an array, process each element
if (Array.isArray(lspServers)) {
for (const item of lspServers) {
// Skip string paths in arrays
if (typeof item === 'string') {
continue
}
// Try to extract from inline config object
const info = extractFromServerConfigRecord(item)
if (info) {
return info
}
}
return null
}
// It's an inline config object: Record<string, LspServerConfig>
return extractFromServerConfigRecord(lspServers)
}
/**
* Extract LSP info from a server config record (inline object format)
*/
/**
* Type guard to check if a value is a record object
*/
function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null
}
function extractFromServerConfigRecord(
serverConfigs: Record<string, unknown>,
): LspInfo | null {
const extensions = new Set<string>()
let command: string | null = null
for (const [_serverName, config] of Object.entries(serverConfigs)) {
if (!isRecord(config)) {
continue
}
// Get command from first valid server config
if (!command && typeof config.command === 'string') {
command = config.command
}
// Collect all extensions from extensionToLanguage mapping
const extMapping = config.extensionToLanguage
if (isRecord(extMapping)) {
for (const ext of Object.keys(extMapping)) {
extensions.add(ext.toLowerCase())
}
}
}
if (!command || extensions.size === 0) {
return null
}
return { extensions, command }
}
/**
* Internal type for plugin with LSP info
*/
type LspPluginInfo = {
entry: PluginMarketplaceEntry
marketplaceName: string
extensions: Set<string>
command: string
isOfficial: boolean
}
/**
* Get all LSP plugins from all installed marketplaces
*
* @returns Map of pluginId to plugin info with LSP metadata
*/
async function getLspPluginsFromMarketplaces(): Promise<
Map<string, LspPluginInfo>
> {
const result = new Map<string, LspPluginInfo>()
try {
const config = await loadKnownMarketplacesConfig()
for (const marketplaceName of Object.keys(config)) {
try {
const marketplace = await getMarketplace(marketplaceName)
const isOfficial = isOfficialMarketplace(marketplaceName)
for (const entry of marketplace.plugins) {
// Skip plugins without lspServers
if (!entry.lspServers) {
continue
}
const lspInfo = extractLspInfoFromManifest(entry.lspServers)
if (!lspInfo) {
continue
}
const pluginId = `${entry.name}@${marketplaceName}`
result.set(pluginId, {
entry,
marketplaceName,
extensions: lspInfo.extensions,
command: lspInfo.command,
isOfficial,
})
}
} catch (error) {
logForDebugging(
`[lspRecommendation] Failed to load marketplace ${marketplaceName}: ${error}`,
)
}
}
} catch (error) {
logForDebugging(
`[lspRecommendation] Failed to load marketplaces config: ${error}`,
)
}
return result
}
/**
* Find matching LSP plugins for a file path.
*
* Returns recommendations for plugins that:
* 1. Support the file's extension
* 2. Have their LSP binary installed on the system
* 3. Are not already installed
* 4. Are not in the user's "never suggest" list
*
* Results are sorted with official marketplace plugins first.
*
* @param filePath - Path to the file to find LSP plugins for
* @returns Array of matching plugin recommendations (empty if none or disabled)
*/
export async function getMatchingLspPlugins(
filePath: string,
): Promise<LspPluginRecommendation[]> {
// Check if globally disabled
if (isLspRecommendationsDisabled()) {
logForDebugging('[lspRecommendation] Recommendations are disabled')
return []
}
// Extract file extension
const ext = extname(filePath).toLowerCase()
if (!ext) {
logForDebugging('[lspRecommendation] No file extension found')
return []
}
logForDebugging(`[lspRecommendation] Looking for LSP plugins for ${ext}`)
// Get all LSP plugins from marketplaces
const allLspPlugins = await getLspPluginsFromMarketplaces()
// Get config for filtering
const config = getGlobalConfig()
const neverPlugins = config.lspRecommendationNeverPlugins ?? []
// Filter to matching plugins
const matchingPlugins: Array<{ info: LspPluginInfo; pluginId: string }> = []
for (const [pluginId, info] of allLspPlugins) {
// Check extension match
if (!info.extensions.has(ext)) {
continue
}
// Filter: not in "never" list
if (neverPlugins.includes(pluginId)) {
logForDebugging(
`[lspRecommendation] Skipping ${pluginId} (in never suggest list)`,
)
continue
}
// Filter: not already installed
if (isPluginInstalled(pluginId)) {
logForDebugging(
`[lspRecommendation] Skipping ${pluginId} (already installed)`,
)
continue
}
matchingPlugins.push({ info, pluginId })
}
// Filter: binary must be installed (async check)
const pluginsWithBinary: Array<{ info: LspPluginInfo; pluginId: string }> = []
for (const { info, pluginId } of matchingPlugins) {
const binaryExists = await isBinaryInstalled(info.command)
if (binaryExists) {
pluginsWithBinary.push({ info, pluginId })
logForDebugging(
`[lspRecommendation] Binary '${info.command}' found for ${pluginId}`,
)
} else {
logForDebugging(
`[lspRecommendation] Skipping ${pluginId} (binary '${info.command}' not found)`,
)
}
}
// Sort: official marketplaces first
pluginsWithBinary.sort((a, b) => {
if (a.info.isOfficial && !b.info.isOfficial) return -1
if (!a.info.isOfficial && b.info.isOfficial) return 1
return 0
})
// Convert to recommendations
return pluginsWithBinary.map(({ info, pluginId }) => ({
pluginId,
pluginName: info.entry.name,
marketplaceName: info.marketplaceName,
description: info.entry.description,
isOfficial: info.isOfficial,
extensions: Array.from(info.extensions),
command: info.command,
}))
}
/**
* Add a plugin to the "never suggest" list
*
* @param pluginId - Plugin ID to never suggest again
*/
export function addToNeverSuggest(pluginId: string): void {
saveGlobalConfig(currentConfig => {
const current = currentConfig.lspRecommendationNeverPlugins ?? []
if (current.includes(pluginId)) {
return currentConfig
}
return {
...currentConfig,
lspRecommendationNeverPlugins: [...current, pluginId],
}
})
logForDebugging(`[lspRecommendation] Added ${pluginId} to never suggest`)
}
/**
* Increment the ignored recommendation count.
* After MAX_IGNORED_COUNT ignores, recommendations are disabled.
*/
export function incrementIgnoredCount(): void {
saveGlobalConfig(currentConfig => {
const newCount = (currentConfig.lspRecommendationIgnoredCount ?? 0) + 1
return {
...currentConfig,
lspRecommendationIgnoredCount: newCount,
}
})
logForDebugging('[lspRecommendation] Incremented ignored count')
}
/**
* Check if LSP recommendations are disabled.
* Disabled when:
* - User explicitly disabled via config
* - User has ignored MAX_IGNORED_COUNT recommendations
*/
export function isLspRecommendationsDisabled(): boolean {
const config = getGlobalConfig()
return (
config.lspRecommendationDisabled === true ||
(config.lspRecommendationIgnoredCount ?? 0) >= MAX_IGNORED_COUNT
)
}
/**
* Reset the ignored count (useful if user re-enables recommendations)
*/
export function resetIgnoredCount(): void {
saveGlobalConfig(currentConfig => {
const currentCount = currentConfig.lspRecommendationIgnoredCount ?? 0
if (currentCount === 0) {
return currentConfig
}
return {
...currentConfig,
lspRecommendationIgnoredCount: 0,
}
})
logForDebugging('[lspRecommendation] Reset ignored count')
}
|