Nx MCP Server

import { NxWorkspace } from '@nx-console/shared-types'; import { getNxWorkspaceProjects } from '@nx-console/vscode-nx-workspace'; import { vscodeLogger } from '@nx-console/vscode-output-channels'; import { getWorkspacePath } from '@nx-console/vscode-utils'; import { join } from 'node:path'; import type { ProjectGraphProjectNode, TargetConfiguration, } from 'nx/src/devkit-exports'; import { TreeItemCollapsibleState } from 'vscode'; interface BaseViewItem<Context extends string> { id: string; description?: string; tooltip?: string; iconPath?: string; contextValue: Context; label: string; collapsible: TreeItemCollapsibleState; } export interface FolderViewItem extends BaseViewItem<'folder'> { path: string; resource: string; } export interface ProjectViewItem extends BaseViewItem<'project'> { nxProject: NxProject; resource: string; } export interface TargetViewItem extends BaseViewItem<'target'> { nxProject: NxProject; nxTarget: NxTarget; nonAtomizedTarget?: string; } export interface TargetGroupViewItem extends BaseViewItem<'targetGroup'> { nxProject: NxProject; nxTargets: NxTarget[]; targetGroupName: string; } export interface ProjectGraphErrorViewItem extends BaseViewItem<'projectGraphError'> { errorCount: number; } export interface NxProject { project: string; root: string; } export interface NxTarget { name: string; configuration?: string; } export abstract class BaseView { workspaceData: NxWorkspace | undefined = undefined; createProjectViewItem( [projectName, projectGraphNode]: [ projectName: string, projectDefinition: ProjectGraphProjectNode, ], collapsible = TreeItemCollapsibleState.Collapsed, ): ProjectViewItem { const { data: { root, name, targets }, } = projectGraphNode; const hasChildren = !targets || Object.keys(targets).length !== 0 || Object.getPrototypeOf(targets) !== Object.prototype; const nxProject = { project: name ?? projectName, root }; if (root === undefined) { vscodeLogger.log( `Project ${nxProject.project} has no root. This could be because of an error loading the workspace configuration.`, ); } return { id: `${projectName}`, contextValue: 'project', nxProject, label: projectName, resource: join(getWorkspacePath(), nxProject.root ?? ''), collapsible: hasChildren ? collapsible : TreeItemCollapsibleState.None, }; } async createTargetsAndGroupsFromProject( parent: ProjectViewItem, ): Promise<(TargetViewItem | TargetGroupViewItem)[] | undefined> { const { nxProject } = parent; const projectDef = (await this.getProjectData())?.[nxProject.project]; if (!projectDef) { return; } const { targets } = projectDef.data; if (!targets) { return; } if (!projectDef.data.metadata?.targetGroups) { return Object.entries(targets).map((target) => this.createTargetTreeItem(nxProject, target), ); } const targetGroupMap = new Map<string, string[]>(); const nonGroupedTargets: Set<string> = new Set(Object.keys(targets)); for (const [targetGroupName, targets] of Object.entries( projectDef.data.metadata.targetGroups, )) { if (!targetGroupMap.has(targetGroupName)) { targetGroupMap.set(targetGroupName, []); } for (const target of targets) { targetGroupMap.get(targetGroupName)?.push(target); nonGroupedTargets.delete(target); } } return [ ...Array.from(targetGroupMap.entries()).map( ([targetGroupName, targets]) => this.createTargetGroupTreeItem(nxProject, targetGroupName, targets), ), ...Array.from(nonGroupedTargets).map((targetName) => this.createTargetTreeItem(nxProject, [targetName, targets[targetName]]), ), ]; } createTargetTreeItem( nxProject: NxProject, [targetName, { configurations, metadata }]: [ targetName: string, targetDefinition: TargetConfiguration, ], ): TargetViewItem { const hasChildren = configurations && Object.keys(configurations).length > 0; return { id: `target$$${nxProject.project}$$${targetName}`, contextValue: 'target', nxProject, nxTarget: { name: targetName }, label: targetName, nonAtomizedTarget: metadata?.nonAtomizedTarget, collapsible: hasChildren ? TreeItemCollapsibleState.Collapsed : TreeItemCollapsibleState.None, }; } createTargetGroupTreeItem( nxProject: NxProject, targetGroupName: string, targetNames: string[], ): TargetGroupViewItem { return { id: `targetGroup$$${nxProject.project}$$${targetGroupName}`, contextValue: 'targetGroup', nxProject, nxTargets: [...new Set(targetNames)].map((name) => ({ name })), targetGroupName, label: targetGroupName, collapsible: TreeItemCollapsibleState.Collapsed, }; } async createConfigurationsFromTarget( parent: TargetViewItem, ): Promise<TargetViewItem[] | undefined> { const { nxProject, nxTarget } = parent; const projectDef = (await this.getProjectData())?.[nxProject.project]; if (!projectDef) { return; } const { targets } = projectDef.data; if (!targets) { return; } const target = targets[nxTarget.name]; if (!target) { return; } const { configurations } = target; if (!configurations) { return; } return Object.keys(configurations).map((configuration) => ({ id: `config$$${nxProject.project}$$${nxTarget.name}$$${configuration}`, contextValue: 'target', nxProject, nxTarget: { name: nxTarget.name, configuration }, label: configuration, collapsible: TreeItemCollapsibleState.None, })); } async createTargetsFromTargetGroup( parent: TargetGroupViewItem, ): Promise<TargetViewItem[] | undefined> { const { nxProject } = parent; const projectDef = (await this.getProjectData())?.[nxProject.project]; if (!projectDef) { return; } const { targets } = projectDef.data; if (!targets) { return; } return parent.nxTargets .sort((a, b) => a.name.localeCompare(b.name)) .map((target) => this.createTargetTreeItem(nxProject, [ target.name, targets[target.name], ]), ); } createProjectGraphErrorViewItem(count: number): ProjectGraphErrorViewItem { return { id: 'projectGraphError', contextValue: 'projectGraphError', errorCount: count, label: `Project Graph Error`, collapsible: TreeItemCollapsibleState.None, }; } protected async getProjectData() { if (this.workspaceData?.projectGraph.nodes) { return this.workspaceData.projectGraph.nodes; } else { return await getNxWorkspaceProjects(); } } }