@neo4j-cypher/language-server 2.0.0-next.0

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@neo4j-cypher/language-server",
+  "description": "Cypher Language Server",
+  "author": "Neo4j Inc.",
+  "license": "Apache-2.0",
+  "files": [
+    "./dist/cypher-language-server.js",
+    "./src",
+    "package.json",
+    "README.md",
+    "LICENSE.md",
+    "CHANGELOG.md"
+  ],
+  "keywords": [
+    "neo4j",
+    "cypher",
+    "language server"
+  ],
+  "version": "2.0.0-next.0",
+  "main": "./dist/cypher-language-server.js",
+  "types": "src/server.ts",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/neo4j/cypher-language-support.git"
+  },
+  "bugs": {
+    "url": "https://github.com/neo4j/cypher-language-support/issues"
+  },
+  "engineStrict": true,
+  "engines": {
+    "node": ">=18.18.2"
+  },
+  "dependencies": {
+    "@neo4j-cypher/language-support": "2.0.0-next.0",
+    "neo4j-driver": "^5.3.0",
+    "vscode-languageserver": "^8.1.0",
+    "vscode-languageserver-textdocument": "^1.0.8"
+  },
+  "scripts": {
+    "build": "tsc -b && npm run bundle",
+    "bundle": "esbuild ./src/server.ts --bundle --format=cjs --platform=node --outfile=dist/cypher-language-server.js",
+    "clean": "rm -rf dist",
+    "watch": "tsc -b -w"
+  },
+  "devDependencies": {
+    "esbuild": "^0.19.4"
+  }
+}

package/src/autocompletion.ts

@@ -0,0 +1,34 @@
+import {
+  Position,
+  TextDocumentPositionParams,
+  TextDocuments,
+} from 'vscode-languageserver/node';
+
+import { Range } from 'vscode-languageserver-types';
+
+import { autocomplete } from '@neo4j-cypher/language-support';
+import { Neo4jSchemaPoller } from '@neo4j-cypher/schema-poller';
+import { TextDocument } from 'vscode-languageserver-textdocument';
+
+export function doAutoCompletion(
+  documents: TextDocuments<TextDocument>,
+  neo4j: Neo4jSchemaPoller,
+) {
+  return (textDocumentPosition: TextDocumentPositionParams) => {
+    const textDocument = documents.get(textDocumentPosition.textDocument.uri);
+    if (textDocument === undefined) return [];
+
+    const position: Position = textDocumentPosition.position;
+    const range: Range = {
+      // TODO Nacho: We are parsing from the begining of the file.
+      // Do we need to parse from the begining of the current query?
+      start: Position.create(0, 0),
+      end: position,
+    };
+
+    return autocomplete(
+      textDocument.getText(range),
+      neo4j.metadata?.dbSchema ?? {},
+    );
+  };
+}

package/src/server.ts

@@ -0,0 +1,124 @@
+import {
+  createConnection,
+  DidChangeConfigurationNotification,
+  InitializeResult,
+  ProposedFeatures,
+  SemanticTokensRegistrationOptions,
+  SemanticTokensRegistrationType,
+  TextDocuments,
+  TextDocumentSyncKind,
+} from 'vscode-languageserver/node';
+
+import { TextDocument } from 'vscode-languageserver-textdocument';
+
+import {
+  syntaxColouringLegend,
+  validateSyntax,
+} from '@neo4j-cypher/language-support';
+import { Neo4jSchemaPoller } from '@neo4j-cypher/schema-poller';
+import { doAutoCompletion } from './autocompletion';
+import { doSignatureHelp } from './signatureHelp';
+import { applySyntaxColouringForDocument } from './syntaxColouring';
+import { Neo4jSettings } from './types';
+
+const connection = createConnection(ProposedFeatures.all);
+
+// Create a simple text document manager.
+const documents: TextDocuments<TextDocument> = new TextDocuments(TextDocument);
+
+const neo4jSdk = new Neo4jSchemaPoller();
+
+connection.onInitialize(() => {
+  const result: InitializeResult = {
+    capabilities: {
+      textDocumentSync: TextDocumentSyncKind.Full,
+      // Tell the client what features does the server support
+      completionProvider: {
+        resolveProvider: false,
+        triggerCharacters: ['.'],
+      },
+      semanticTokensProvider: {
+        documentSelector: null,
+        legend: syntaxColouringLegend,
+        range: false,
+        full: {
+          delta: false,
+        },
+      },
+      signatureHelpProvider: {
+        triggerCharacters: ['(', ',', ')'],
+      },
+    },
+  };
+
+  return result;
+});
+
+connection.onInitialized(() => {
+  void connection.client.register(DidChangeConfigurationNotification.type, {
+    section: 'neo4j',
+  });
+
+  const registrationOptions: SemanticTokensRegistrationOptions = {
+    documentSelector: null,
+    legend: syntaxColouringLegend,
+    range: false,
+    full: {
+      delta: false,
+    },
+  };
+  void connection.client.register(
+    SemanticTokensRegistrationType.type,
+    registrationOptions,
+  );
+});
+
+// Trigger the syntactic errors highlighting on every document change
+documents.onDidChangeContent((change) => {
+  const document = change.document;
+  const diagnostics = validateSyntax(
+    document.getText(),
+    neo4jSdk.metadata?.dbSchema ?? {},
+  );
+  void connection.sendDiagnostics({
+    uri: document.uri,
+    diagnostics: diagnostics,
+  });
+});
+
+// Trigger the syntax colouring
+connection.languages.semanticTokens.on(
+  applySyntaxColouringForDocument(documents),
+);
+
+// Trigger the signature help, providing info about functions / procedures
+connection.onSignatureHelp(doSignatureHelp(documents, neo4jSdk));
+// Trigger the auto completion
+connection.onCompletion(doAutoCompletion(documents, neo4jSdk));
+
+connection.onDidChangeConfiguration(
+  (params: { settings: { neo4j: Neo4jSettings } }) => {
+    neo4jSdk.disconnect();
+
+    const neo4jConfig = params.settings.neo4j;
+    if (
+      neo4jSdk.connection === undefined &&
+      neo4jConfig.connect &&
+      neo4jConfig.password &&
+      neo4jConfig.URL &&
+      neo4jConfig.user
+    ) {
+      void neo4jSdk.persistentConnect(
+        neo4jConfig.URL,
+        {
+          username: neo4jConfig.user,
+          password: neo4jConfig.password,
+        },
+        { appName: 'cypher-language-server' },
+      );
+    }
+  },
+);
+
+documents.listen(connection);
+connection.listen();

package/src/signatureHelp.ts

@@ -0,0 +1,39 @@
+import { signatureHelp } from '@neo4j-cypher/language-support';
+import {
+  Position,
+  Range,
+  SignatureHelp,
+  SignatureHelpParams,
+  TextDocuments,
+} from 'vscode-languageserver/node';
+
+import { Neo4jSchemaPoller } from '@neo4j-cypher/schema-poller';
+import { TextDocument } from 'vscode-languageserver-textdocument';
+
+export const emptyResult: SignatureHelp = {
+  signatures: [],
+  activeSignature: undefined,
+  activeParameter: undefined,
+};
+
+export function doSignatureHelp(
+  documents: TextDocuments<TextDocument>,
+  neo4j: Neo4jSchemaPoller,
+) {
+  return (params: SignatureHelpParams) => {
+    const textDocument = documents.get(params.textDocument.uri);
+    const endOfTriggerHelp = params.context?.triggerCharacter === ')';
+    if (textDocument === undefined || endOfTriggerHelp) return emptyResult;
+
+    const position = params.position;
+    const range: Range = {
+      start: Position.create(0, 0),
+      end: position,
+    };
+
+    return signatureHelp(
+      textDocument.getText(range),
+      neo4j.metadata?.dbSchema ?? {},
+    );
+  };
+}

package/src/syntaxColouring.ts

@@ -0,0 +1,39 @@
+import {
+  applySyntaxColouring,
+  mapCypherToSemanticTokenIndex,
+} from '@neo4j-cypher/language-support';
+import {
+  SemanticTokensBuilder,
+  SemanticTokensParams,
+  TextDocument,
+  TextDocuments,
+} from 'vscode-languageserver';
+
+export function applySyntaxColouringForDocument(
+  documents: TextDocuments<TextDocument>,
+) {
+  return (params: SemanticTokensParams) => {
+    const textDocument = documents.get(params.textDocument.uri);
+    if (textDocument === undefined) return { data: [] };
+
+    const tokens = applySyntaxColouring(textDocument.getText());
+
+    const builder = new SemanticTokensBuilder();
+
+    tokens.forEach((token) => {
+      const tokenColour = mapCypherToSemanticTokenIndex(token.tokenType);
+
+      if (tokenColour !== undefined) {
+        builder.push(
+          token.position.line,
+          token.position.startCharacter,
+          token.length,
+          tokenColour,
+          0,
+        );
+      }
+    });
+    const results = builder.build();
+    return results;
+  };
+}

package/src/types.ts

@@ -0,0 +1,10 @@
+// These settings are defined in the package.json
+export type Neo4jSettings = {
+  trace: {
+    server: 'off' | 'messages' | 'verbose';
+  };
+  connect?: boolean;
+  password?: string;
+  URL?: string;
+  user?: string;
+};