@neo4j-cypher/language-server 2.0.0-next.38 → 2.0.0-next.39

package/dist/server.js

@@ -16,6 +16,7 @@ const syntaxHighlighting_1 = require("./syntaxHighlighting");
 const workerpool_1 = __importDefault(require("workerpool"));
 const lint_worker_1 = require("@neo4j-cypher/lint-worker");
 const path_1 = require("path");
+const hoverInfo_js_1 = require("./hoverInfo.js");
 const defaultWorkerPath = (0, path_1.join)(__dirname, 'lintWorker.cjs');
 let workerPath = defaultWorkerPath;
 exports.languageService = new language_support_1.CypherLanguageService({
@@ -121,6 +122,7 @@ connection.onInitialize(() => {
             signatureHelpProvider: {
                 triggerCharacters: ['(', ',', ')'],
             },
+            hoverProvider: true,
             documentFormattingProvider: true,
         },
     };
@@ -141,7 +143,6 @@ connection.onInitialized(() => {
     void connection.client.register(node_1.SemanticTokensRegistrationType.type, registrationOptions);
 });
 connection.onDidChangeConfiguration((params) => {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
     settings = params.settings?.neo4j;
     relintAllDocuments();
 });
@@ -168,6 +169,9 @@ connection.onNotification('connectionUpdated', (connectionSettings) => {
     changeConnection(connectionSettings);
     neo4jSchemaPoller.events.once('schemaFetched', relintAllDocuments);
 });
+connection.onHover((params) => {
+    return (0, hoverInfo_js_1.doHoverInfo)(documents, neo4jSchemaPoller, params);
+});
 connection.onNotification('fetchSymbolTable', (params) => {
     neo4jSchemaPoller.events.once('schemaFetched', () => symbolFetcher.queueSymbolJob(params.query, params.uri, params.schema));
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neo4j-cypher/language-server",
-  "version": "2.0.0-next.38",
+  "version": "2.0.0-next.39",
   "description": "Cypher Language Server",
   "keywords": [
     "cypher",
@@ -34,9 +34,9 @@
     "vscode-languageserver": "^8.1.0",
     "vscode-languageserver-textdocument": "^1.0.8",
     "workerpool": "^9.3.3",
-    "@neo4j-cypher/language-support": "2.0.0-next.37",
-    "@neo4j-cypher/query-tools": "2.0.0-next.37",
-    "@neo4j-cypher/lint-worker": "1.10.1-next.14"
+    "@neo4j-cypher/language-support": "2.0.0-next.38",
+    "@neo4j-cypher/query-tools": "2.0.0-next.38",
+    "@neo4j-cypher/lint-worker": "1.10.1-next.15"
   },
   "devDependencies": {
     "@types/lodash.debounce": "^4.0.9",
@@ -51,6 +51,6 @@
     "bundle": "esbuild ./src/server.ts --bundle --format=cjs --platform=node --outfile=dist/cypher-language-server.js --minify --conditions=require",
     "dev": "tsc --watch",
     "make-executable": "cd dist && echo '#!/usr/bin/env node' > cypher-language-server && cat cypher-language-server.js >> cypher-language-server",
-    "clean": "rm -rf {dist,tsconfig.tsbuildinfo}"
+    "clean": "rm -rf dist tsconfig*.tsbuildinfo"
   }
 }

package/src/autocompletion.ts

@@ -1,21 +1,21 @@
-import {
+import type {
   CompletionParams,
-  CompletionTriggerKind,
   Position,
   TextDocuments,
 } from 'vscode-languageserver/node';
+import { CompletionTriggerKind } from 'vscode-languageserver/node';
 
 import type { CompletionItem } from '@neo4j-cypher/language-support';
 import { shouldAutoCompleteYield } from '@neo4j-cypher/language-support';
-import { Neo4jSchemaPoller } from '@neo4j-cypher/query-tools';
-import { TextDocument } from 'vscode-languageserver-textdocument';
+import type { Neo4jSchemaPoller } from '@neo4j-cypher/query-tools';
+import type { TextDocument } from 'vscode-languageserver-textdocument';
 import { languageService } from './server';
 
 export function doAutoCompletion(
   documents: TextDocuments<TextDocument>,
   neo4j: Neo4jSchemaPoller,
 ) {
-  return (completionParams: CompletionParams) => {
+  return (completionParams: CompletionParams): CompletionItem[] | undefined => {
     const textDocument = documents.get(completionParams.textDocument.uri);
     if (textDocument === undefined) return [];
 
@@ -53,5 +53,6 @@ export function doAutoCompletion(
 
       return result;
     }
+    return undefined;
   };
 }

package/src/formatting.ts

@@ -1,10 +1,10 @@
 import { formatQuery } from '@neo4j-cypher/language-support';
-import { TextDocument } from 'vscode-languageserver-textdocument';
-import {
+import type { TextDocument } from 'vscode-languageserver-textdocument';
+import type {
   DocumentFormattingParams,
   TextDocuments,
-  TextEdit,
 } from 'vscode-languageserver/node';
+import { TextEdit } from 'vscode-languageserver/node';
 
 export const formatDocument = (
   params: DocumentFormattingParams,

package/src/hoverInfo.ts

@@ -0,0 +1,20 @@
+import type { Hover, HoverParams, TextDocuments } from 'vscode-languageserver';
+import type { TextDocument } from 'vscode-languageserver-textdocument';
+import { languageService } from './server.js';
+import type { Neo4jSchemaPoller } from '@neo4j-cypher/query-tools';
+
+export function doHoverInfo(
+  documents: TextDocuments<TextDocument>,
+  neo4jSchemaPoller: Neo4jSchemaPoller,
+  params: HoverParams,
+): Hover | null {
+  const textDocument = documents.get(params.textDocument.uri);
+  if (textDocument === undefined) return null;
+  const position = params.position;
+  const offset = textDocument.offsetAt(position);
+  const hoverInfo = languageService.hoverInfo(textDocument.getText(), {
+    caretPosition: offset,
+    dbSchema: neo4jSchemaPoller.metadata?.dbSchema ?? {},
+  });
+  return hoverInfo ? hoverInfo : null;
+}

package/src/linting.ts

@@ -1,20 +1,19 @@
+import type {
+  SymbolTable,
+  SyntaxDiagnostic,
+} from '@neo4j-cypher/language-support';
 import {
   clampUnsafePositions,
   isNotParamError,
-  SymbolTable,
-  SyntaxDiagnostic,
 } from '@neo4j-cypher/language-support';
-import { Neo4jSchemaPoller } from '@neo4j-cypher/query-tools';
+import type { Neo4jSchemaPoller } from '@neo4j-cypher/query-tools';
 import debounce from 'lodash.debounce';
 import { join } from 'path';
-import { Diagnostic } from 'vscode-languageserver';
-import { TextDocument } from 'vscode-languageserver-textdocument';
+import type { Diagnostic } from 'vscode-languageserver';
+import type { TextDocument } from 'vscode-languageserver-textdocument';
 import workerpool from 'workerpool';
-import {
-  convertDbSchema,
-  LinterTask,
-  LintWorker,
-} from '@neo4j-cypher/lint-worker';
+import type { LinterTask, LintWorker } from '@neo4j-cypher/lint-worker';
+import { convertDbSchema } from '@neo4j-cypher/lint-worker';
 import { languageService } from './server';
 
 const defaultWorkerPath = join(__dirname, 'lintWorker.cjs');

package/src/server.ts

@@ -1,19 +1,22 @@
+import type {
+  Diagnostic,
+  Hover,
+  HoverParams,
+  InitializeResult,
+  SemanticTokensRegistrationOptions,
+} from 'vscode-languageserver/node';
 import {
   createConnection,
-  Diagnostic,
   DidChangeConfigurationNotification,
-  InitializeResult,
   ProposedFeatures,
-  SemanticTokensRegistrationOptions,
   SemanticTokensRegistrationType,
   TextDocuments,
   TextDocumentSyncKind,
 } from 'vscode-languageserver/node';
 
 import { TextDocument } from 'vscode-languageserver-textdocument';
+import type { DbSchema, SymbolTable } from '@neo4j-cypher/language-support';
 import {
-  DbSchema,
-  SymbolTable,
   syntaxHighlightingLegend,
   CypherLanguageService,
 } from '@neo4j-cypher/language-support';
@@ -23,15 +26,17 @@ import { formatDocument } from './formatting';
 import { cleanupWorkers, lintDocument, setLintWorker } from './linting';
 import { doSignatureHelp } from './signatureHelp';
 import { highlightSyntaxForDocument } from './syntaxHighlighting';
-import {
+import type {
   LintWorkerSettings,
   Neo4jConnectionSettings,
   Neo4jParameters,
   Neo4jSettings,
 } from './types';
 import workerpool from 'workerpool';
-import { convertDbSchema, LintWorker } from '@neo4j-cypher/lint-worker';
+import type { LintWorker } from '@neo4j-cypher/lint-worker';
+import { convertDbSchema } from '@neo4j-cypher/lint-worker';
 import { join } from 'path';
+import { doHoverInfo } from './hoverInfo.js';
 
 const defaultWorkerPath: string = join(__dirname, 'lintWorker.cjs');
 let workerPath = defaultWorkerPath;
@@ -172,6 +177,7 @@ connection.onInitialize(() => {
       signatureHelpProvider: {
         triggerCharacters: ['(', ',', ')'],
       },
+      hoverProvider: true,
       documentFormattingProvider: true,
     },
   };
@@ -199,7 +205,6 @@ connection.onInitialized(() => {
 });
 
 connection.onDidChangeConfiguration((params) => {
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
   settings = params.settings?.neo4j as Neo4jSettings;
   relintAllDocuments();
 });
@@ -238,6 +243,10 @@ connection.onNotification(
   },
 );
 
+connection.onHover((params: HoverParams): Hover | null => {
+  return doHoverInfo(documents, neo4jSchemaPoller, params);
+});
+
 connection.onNotification(
   'fetchSymbolTable',
   (params: {

package/src/signatureHelp.ts

@@ -1,11 +1,11 @@
-import {
+import type {
   SignatureHelp,
   SignatureHelpParams,
   TextDocuments,
 } from 'vscode-languageserver/node';
 
-import { Neo4jSchemaPoller } from '@neo4j-cypher/query-tools';
-import { TextDocument } from 'vscode-languageserver-textdocument';
+import type { Neo4jSchemaPoller } from '@neo4j-cypher/query-tools';
+import type { TextDocument } from 'vscode-languageserver-textdocument';
 import { languageService } from './server';
 
 const emptyResult: SignatureHelp = {

package/src/syntaxHighlighting.ts

@@ -1,10 +1,10 @@
 import { mapCypherToSemanticTokenIndex } from '@neo4j-cypher/language-support';
-import {
-  SemanticTokensBuilder,
+import type {
   SemanticTokensParams,
   TextDocument,
   TextDocuments,
 } from 'vscode-languageserver';
+import { SemanticTokensBuilder } from 'vscode-languageserver';
 import { languageService } from './server';
 
 export function highlightSyntaxForDocument(

package/src/types.ts

@@ -1,4 +1,4 @@
-import { DbSchema } from '@neo4j-cypher/language-support';
+import type { DbSchema } from '@neo4j-cypher/language-support';
 
 // These settings are defined in the package.json
 export type Neo4jConnectionSettings = {