Nx MCP Server

import { execSync } from 'child_process'; import { readFileSync, rmSync } from 'fs'; import { join } from 'path'; import { ArrayLiteralExpression, ObjectLiteralExpression, PropertyAssignment, isObjectLiteralExpression, isPropertyAssignment, isStringLiteral, parseJsonText, } from 'typescript'; import { URI } from 'vscode-uri'; import { NxlsWrapper } from '../nxls-wrapper'; import { e2eCwd, modifyJsonFile, newWorkspace, simpleReactWorkspaceOptions, uniq, waitFor, } from '@nx-console/shared-e2e-utils'; import { Position } from 'vscode-json-languageservice'; import { CompletionList } from 'vscode-languageserver'; import { NxWorkspaceRefreshNotification } from '@nx-console/language-server-types'; let nxlsWrapper: NxlsWrapper; const workspaceName = uniq('workspace'); const nxJsonPath = join(e2eCwd, workspaceName, 'nx.json'); describe('nx.json completion - default', () => { beforeAll(async () => { newWorkspace({ name: workspaceName, options: simpleReactWorkspaceOptions, packageManager: 'npm', }); nxlsWrapper = new NxlsWrapper(); await nxlsWrapper.startNxls(join(e2eCwd, workspaceName)); }); it('should contain contain preinstalled plugins', async () => { modifyJsonFile(nxJsonPath, (data) => ({ ...data, plugins: [ { plugin: '', }, ], })); nxlsWrapper.sendNotification({ method: 'textDocument/didOpen', params: { textDocument: { uri: URI.file(nxJsonPath).toString(), languageId: 'JSON', version: 1, text: readFileSync(nxJsonPath, 'utf-8'), }, }, }); const position = getPluginAutocompletePosition(nxJsonPath); const autocompleteResponse = await nxlsWrapper.sendRequest({ method: 'textDocument/completion', params: { textDocument: { uri: URI.file(nxJsonPath).toString(), }, position, }, }); const completionItemStrings = ( (autocompleteResponse?.result as any).items as any[] ).map((item) => item.label); expect(completionItemStrings).toEqual([ '@nx/cypress/plugin', '@nx/eslint/plugin', '@nx/vite/plugin', ]); }); it('should contain proper root keys', async () => { // delete all json properties so we can see all possible completions modifyJsonFile(nxJsonPath, () => ({})); nxlsWrapper.sendNotification({ method: 'textDocument/didChange', params: { textDocument: { uri: URI.file(nxJsonPath).toString(), languageId: 'JSON', version: 2, }, contentChanges: [ { text: readFileSync(nxJsonPath, 'utf-8'), }, ], }, }); const autocompleteResponse = await nxlsWrapper.sendRequest({ method: 'textDocument/completion', params: { textDocument: { uri: URI.file(nxJsonPath).toString(), }, position: Position.create(0, 1), }, }); expect( (autocompleteResponse.result as CompletionList).items .map((item) => item.label) .sort(), ).toMatchInlineSnapshot(` Array [ "affected", "cacheDirectory", "cli", "defaultBase", "defaultProject", "extends", "generators", "implicitDependencies", "namedInputs", "neverConnectToCloud", "nxCloudAccessToken", "nxCloudEncryptionKey", "nxCloudUrl", "parallel", "plugins", "release", "sync", "targetDefaults", "targetDependencyConfig", "tasksRunnerOptions", "tui", "useDaemonProcess", "useInferencePlugins", "workspaceLayout", ] `); }); it('should not contain outdated root keys', async () => { const autocompleteResponse = await nxlsWrapper.sendRequest({ method: 'textDocument/completion', params: { textDocument: { uri: URI.file(nxJsonPath).toString(), }, position: Position.create(0, 1), }, }); const labels = (autocompleteResponse.result as CompletionList).items.map( (item) => item.label, ); expect(labels).not.toContain('npmScope'); expect(labels).not.toContain('targetDependencies'); }); // This technically works but because the nxls doesn't handle reinstallation well currently, // it creates a host of side effect issues that make the test flaky // enable when the nxls restart story is better xit('plugin autocomplete should contain playwright plugin after installing it', async () => { execSync('npm install @nx/playwright --save-dev', { cwd: join(e2eCwd, workspaceName), }); const position = getPluginAutocompletePosition(nxJsonPath); const autocompleteResponse = await nxlsWrapper.sendRequest({ method: 'textDocument/completion', params: { textDocument: { uri: URI.file(nxJsonPath).toString(), }, position, }, }); const completionItemStrings = ( (autocompleteResponse?.result as any).items as any[] ).map((item) => item.label); expect(completionItemStrings).toEqual([ '@nx/cypress/plugin', '@nx/eslint/plugin', '@nx/playwright/plugin', '@nx/vite/plugin', ]); }); it('should not error when nx-schema.json is missing', async () => { await waitFor(11000); rmSync( join( e2eCwd, workspaceName, 'node_modules', 'nx', 'schemas', 'nx-schema.json', ), ); nxlsWrapper.sendNotification({ ...NxWorkspaceRefreshNotification, params: {}, }); await nxlsWrapper.waitForNotification( NxWorkspaceRefreshNotification.method, ); const autocompleteResponse = await nxlsWrapper.sendRequest({ method: 'textDocument/completion', params: { textDocument: { uri: URI.file(nxJsonPath).toString(), }, position: Position.create(0, 1), }, }); expect(autocompleteResponse.error).toBeUndefined(); // results should only include non-static completions const completionItemStrings = ( (autocompleteResponse?.result as any).items as any[] ).map((item) => item.label); expect(completionItemStrings).toContain('tasksRunnerOptions'); expect(completionItemStrings).toContain('targetDefaults'); expect(completionItemStrings).toContain('targetDependencyConfig'); expect(completionItemStrings).toContain('plugins'); expect(completionItemStrings).not.toContain('nxCloudAccessToken'); }); afterAll(async () => { return await nxlsWrapper.stopNxls(); }); }); function getPluginAutocompletePosition(filePath: string): { line: number; character: number; } { const jsonFile = parseJsonText(filePath, readFileSync(filePath, 'utf-8')); const properties = isObjectLiteralExpression( jsonFile.statements[0].expression, ) ? jsonFile.statements[0].expression.properties : []; const pluginsProperty = properties.find( (prop) => prop.name && isStringLiteral(prop.name) && prop.name.text === 'plugins', ); const pluginDefinition = pluginsProperty && isPropertyAssignment(pluginsProperty) ? ((pluginsProperty.initializer as ArrayLiteralExpression) .elements[0] as ObjectLiteralExpression) : undefined; const pluginPropertyValue = ( pluginDefinition?.properties.find( (prop) => prop.name && isStringLiteral(prop.name) && prop.name.text === 'plugin', ) as PropertyAssignment ).initializer; return jsonFile.getLineAndCharacterOfPosition( pluginPropertyValue.getStart(jsonFile), ); }