Nx MCP Server

import { configureJsonLanguageService, getSchemaRequestService, lspLogger, } from '@nx-console/language-server-utils'; import { getProjectByRoot } from '@nx-console/language-server-workspace'; import { readAndParseJson } from '@nx-console/shared-file-system'; import { CompletionType, getNxJsonSchema, getProjectJsonSchema, implicitDependencies, namedInputs, tags, } from '@nx-console/shared-json-schema'; import { findNxPackagePath } from '@nx-console/shared-npm'; import { getExecutors, nxWorkspace, } from '@nx-console/shared-nx-workspace-info'; import { CollectionInfo } from '@nx-console/shared-schema'; import { NxWorkspace } from '@nx-console/shared-types'; import { readFile } from 'fs/promises'; import { platform } from 'os'; import { join } from 'path'; import { ClientCapabilities, JSONSchema, SchemaConfiguration, } from 'vscode-json-languageservice'; import { URI, Utils } from 'vscode-uri'; let currentBaseSchemas: SchemaConfiguration[] = []; let currentExecutors: CollectionInfo[] | undefined; let currentNxWorkspace: NxWorkspace | undefined; export async function configureSchemas( workingPath: string | undefined, capabilities: ClientCapabilities | undefined, ) { if (!workingPath) { lspLogger.log('No workspace path provided'); return; } currentNxWorkspace = await nxWorkspace(workingPath, lspLogger); const { nxVersion, nxJson, projectGraph } = currentNxWorkspace; currentExecutors = await getExecutors(workingPath); const projectJsonSchema = getProjectJsonSchema( currentExecutors, nxJson.targetDefaults, nxVersion, ); const packageJsonSchema = await getPackageJsonSchema( workingPath, projectJsonSchema, ); const nxSchema = await getNxJsonSchema( currentExecutors, projectGraph.nodes, nxVersion, workingPath, ); currentBaseSchemas = [ { uri: 'nx://schemas/project', fileMatch: ['**/project.json'], schema: projectJsonSchema, }, { uri: 'nx://schemas/package', fileMatch: ['**/package.json'], schema: packageJsonSchema, }, { uri: 'nx://schemas/nx', fileMatch: ['**/nx.json'], schema: nxSchema, }, ]; // recalculate project-specific schemas for (const key in projectSchemas.keys()) { const projectSchema = await getProjectSchema(key, workingPath); if (!projectSchema) { continue; } projectSchemas.set(key, projectSchema); } _configureJsonLanguageService( capabilities, getProjectSchemas(), currentBaseSchemas, ); } const projectSchemas: Map<string, SchemaConfiguration> = new Map(); export function projectSchemaIsRegistered(projectRoot: string): boolean { return projectSchemas.has(projectRoot); } function getProjectSchemas(): SchemaConfiguration[] { return Array.from(projectSchemas.values()); } /** * Configures the language server with a new schema for the current project. * This will reuse workspace info set by `configureSchemas` if available */ export async function configureSchemaForProject( projectRootPath: string, workingPath: string | undefined, capabilities: ClientCapabilities | undefined, ) { const projectSchema = await getProjectSchema(projectRootPath, workingPath); if (!projectSchema) { return; } projectSchemas.set(projectRootPath, projectSchema); _configureJsonLanguageService( capabilities, getProjectSchemas(), currentBaseSchemas, ); } async function getProjectSchema( projectRootPath: string, workingPath: string | undefined, ): Promise<SchemaConfiguration | undefined> { if (!workingPath) { lspLogger.log( `No workspace path provided when configuring schema for ${projectRootPath}`, ); return; } if (!currentNxWorkspace) { currentNxWorkspace = await nxWorkspace(workingPath, lspLogger); } if (!currentExecutors) { currentExecutors = await getExecutors(workingPath); } const project = await getProjectByRoot(projectRootPath, workingPath); if (!project) { return; } const { nxVersion } = currentNxWorkspace; const targetsProperties: Record<string, any> = {}; Object.entries(project.targets ?? {}).forEach(([key, target]) => { const executor = target.executor ?? 'nx:run-commands'; const matchingCollection = currentExecutors?.find( (e) => e.name === executor, ); if (!matchingCollection) { return; } const schemaRef = platform() === 'win32' ? matchingCollection.schemaPath : `file://${matchingCollection.schemaPath}`; targetsProperties[key] = { properties: { options: { $ref: schemaRef, }, configurations: { additionalProperties: { $ref: schemaRef, required: [], }, }, }, }; }); return { uri: `nx://schemas/project-${project.name}`, fileMatch: [join(workingPath, projectRootPath, 'project.json')], schema: { type: 'object', properties: { sourceRoot: { type: 'string', 'x-completion-type': CompletionType.directory, }, implicitDependencies, tags, namedInputs: namedInputs(nxVersion), targets: { type: 'object', properties: targetsProperties, }, }, }, }; } async function getPackageJsonSchema( workspacePath: string, projectJsonSchema: JSONSchema, ) { try { const projectJsonSchemaPath = await findNxPackagePath( workspacePath, join('schemas', 'project-schema.json'), ); if (projectJsonSchemaPath) { const nxProjectSchema = await readAndParseJson(projectJsonSchemaPath); return { type: 'object', properties: { nx: { ...nxProjectSchema, ...projectJsonSchema, properties: { ...nxProjectSchema?.properties, ...projectJsonSchema?.properties, }, }, }, }; } } catch (e) { // fall through to default return } return { type: 'object', properties: { nx: { ...projectJsonSchema, }, }, }; } function _configureJsonLanguageService( capabilities: ClientCapabilities | undefined, projectSchemas: SchemaConfiguration[], baseSchemas: SchemaConfiguration[], ) { configureJsonLanguageService( { schemaRequestService: getSchemaRequestService(['file']), workspaceContext: workspaceContextService, contributions: [], clientCapabilities: capabilities, }, { schemas: [...projectSchemas, ...baseSchemas], }, ); } const workspaceContextService = { resolveRelativePath: (relativePath: string, resource: string) => { const base = resource.substring(0, resource.lastIndexOf('/') + 1); return Utils.resolvePath(URI.parse(base), relativePath).toString(); }, };