Autocomplete details (#267)

* Adds autcomplete details via mongosh i18n package

* Aligned i18n version with mongosh version

* Back to version 0.8.0 of the i18n package

* Markdown is possible after all.

Author: mmarcon

package-lock.json

@@ -868,6 +868,7 @@
     "@iconify/react": "^1.1.3",
     "@leafygreen-ui/toggle": "3.0.1",
     "@mongosh/browser-runtime-electron": "^0.6.1",
+    "@mongosh/i18n": "^0.8.0",
     "@mongosh/service-provider-server": "^0.6.1",
     "@mongosh/shell-api": "^0.6.1",
     "analytics-node": "^3.5.0",

package.json

@@ -1,9 +1,10 @@
 /* eslint-disable no-sync */
 import * as util from 'util';
-import { CompletionItemKind, CancellationToken, Connection, CompletionItem } from 'vscode-languageserver';
+import { CompletionItemKind, CancellationToken, Connection, CompletionItem, MarkupContent, MarkupKind } from 'vscode-languageserver';
 import fs from 'fs';
 import path from 'path';
 import { signatures } from '@mongosh/shell-api';
+import Translator from '@mongosh/i18n/lib/translator';
 import { Worker as WorkerThreads } from 'worker_threads';
 
 import { CollectionItem } from '../types/collectionItemType';
@@ -398,14 +399,28 @@ export default class MongoDBService {
   // Get shell API symbols/methods completion from mongosh.
   _getShellCompletionItems(): ShellCompletionItem {
     const shellSymbols = {};
+    const translator = new Translator();
 
     Object.keys(signatures).map((symbol) => {
       shellSymbols[symbol] = Object.keys(
         signatures[symbol].attributes || {}
-      ).map((item) => ({
-        label: item,
-        kind: CompletionItemKind.Method
-      }));
+      ).map((item) => {
+        const documentation = translator.translate(`shell-api.classes.${symbol}.help.attributes.${item}.description`) || '';
+        const link = translator.translate(`shell-api.classes.${symbol}.help.attributes.${item}.link`) || '';
+        const detail = translator.translate(`shell-api.classes.${symbol}.help.attributes.${item}.example`) || '';
+
+        const markdownDocumentation: MarkupContent = {
+          kind: MarkupKind.Markdown,
+          value: link ? `${documentation}\n\n[Read More](${link})` : documentation
+        };
+
+        return {
+          label: item,
+          kind: CompletionItemKind.Method,
+          documentation: markdownDocumentation,
+          detail
+        };
+      });
     });
 
     return shellSymbols;

src/language/mongoDBService.ts

@@ -106,7 +106,7 @@ suite('MongoDBService Test Suite', () => {
     const testMongoDBService = new MongoDBService(connection);
 
     before(async () => {
-      testMongoDBService._getDatabasesCompletionItems = (): void => {};
+      testMongoDBService._getDatabasesCompletionItems = (): void => { };
       testMongoDBService._getCollectionsCompletionItems = (): Promise<boolean> =>
         Promise.resolve(true);
       testMongoDBService._getFieldsCompletionItems = (): Promise<boolean> =>
@@ -642,6 +642,12 @@ suite('MongoDBService Test Suite', () => {
         'kind',
         CompletionItemKind.Method
       );
+      expect(findShellCompletion).to.have.property(
+        'documentation'
+      );
+      expect(findShellCompletion).to.have.property(
+        'detail'
+      );
     });
 
     test('provide only collection names and shell db symbol completion after find cursor', async () => {
@@ -673,6 +679,12 @@ suite('MongoDBService Test Suite', () => {
         'kind',
         CompletionItemKind.Method
       );
+      expect(findShellCompletion).to.have.property(
+        'documentation'
+      );
+      expect(findShellCompletion).to.have.property(
+        'detail'
+      );
       expect(findCursorCompletion).to.be.undefined;
     });
 
@@ -711,6 +723,12 @@ suite('MongoDBService Test Suite', () => {
         'kind',
         CompletionItemKind.Method
       );
+      expect(findShellCompletion).to.have.property(
+        'documentation'
+      );
+      expect(findShellCompletion).to.have.property(
+        'detail'
+      );
       expect(findCursorCompletion).to.be.undefined;
     });