Auto complete separated into recipes and building completion items

Author: znorman-harris

libs/parsing/index/src/lib/auto-complete/auto-complete-recipe.interface.ts

@@ -65,8 +65,8 @@ import {
 export type AutoCompleteType =
   | CompileOptCompletion
   | ExecutiveCommandCompletion
-  | FunctionMethodCompletion
   | FunctionCompletion
+  | FunctionMethodCompletion
   | IncludeCompletion
   | KeywordCompletion
   | ProcedureCompletion
@@ -124,3 +124,45 @@ export type AutoCompleteRecipe<T extends AutoCompleteType> = {
   /** Options to add auto-complete values */
   options: AutoCompleteRecipeOptions<T>;
 };
+
+/**
+ * Strictly typed lookup for completion types
+ */
+interface IAutoCompleteTypeLookup {
+  COMPILE_OPT: CompileOptCompletion;
+  EXECUTIVE_COMMAND: ExecutiveCommandCompletion;
+  FUNCTION: FunctionCompletion;
+  FUNCTION_METHOD: FunctionMethodCompletion;
+  INCLUDE: IncludeCompletion;
+  KEYWORD: KeywordCompletion;
+  PROCEDURE: ProcedureCompletion;
+  PROCEDURE_METHOD: ProcedureMethodCompletion;
+  PROPERTY: PropertyCompletion;
+  PROPERTY_IN_STRUCTURE: PropertyInStructureCompletion;
+  SPECIAL_FUNCTION: SpecialFunctionCompletion;
+  SPECIAL_PROCEDURE: SpecialProcedureCompletion;
+  STRUCTURE_NAME: StructureNameCompletion;
+  SYSTEM_VARIABLE: SystemVariableCompletion;
+  VARIABLE: VariableCompletion;
+}
+
+/**
+ * Lookup of all types of auto-complete
+ */
+export const AUTO_COMPLETE_TYPE_LOOKUP: IAutoCompleteTypeLookup = {
+  COMPILE_OPT: 'compile-opt',
+  EXECUTIVE_COMMAND: 'executive-command',
+  FUNCTION: 'function',
+  FUNCTION_METHOD: 'function-method',
+  INCLUDE: 'include',
+  KEYWORD: 'keyword',
+  PROCEDURE: 'procedure',
+  PROCEDURE_METHOD: 'procedure-method',
+  PROPERTY: 'property',
+  PROPERTY_IN_STRUCTURE: 'property-in-structure',
+  SPECIAL_FUNCTION: 'special-function',
+  SPECIAL_PROCEDURE: 'special-procedure',
+  STRUCTURE_NAME: 'structure-name',
+  SYSTEM_VARIABLE: 'system-variable',
+  VARIABLE: 'variable',
+};

libs/parsing/index/src/lib/auto-complete/build-completion-items.ts

@@ -1,6 +1,8 @@
 import { FormatterType, IAssemblerOptions } from '@idl/assembling/config';
-import { CompletionItem } from 'vscode-languageserver';
+import { IDLExtensionConfig } from '@idl/vscode/extension-config';
+import { CompletionItem, MarkupKind } from 'vscode-languageserver';
 
+import { ResolveHoverHelpLinks } from '../helpers/resolve-hover-help-links';
 import { IDLIndex } from '../idl-index.class';
 import {
   AutoCompleteRecipe,
@@ -12,9 +14,10 @@ import { ALL_COMPLETION_ITEM_BUILDERS } from './build-completion-items.interface
  * Builds auto-complete items from our recipes
  */
 export function BuildCompletionItems(
+  index: IDLIndex,
   recipes: AutoCompleteRecipe<AutoCompleteType>[],
   formatting: IAssemblerOptions<FormatterType>,
-  index: IDLIndex
+  config: IDLExtensionConfig
 ) {
   /** initial list of completion items */
   const complete: CompletionItem[] = [];
@@ -32,5 +35,19 @@ export function BuildCompletionItems(
     }
   }
 
+  // resolve links in any completion items and indicate that
+  // we have markdown to present
+  for (let i = 0; i < complete.length; i++) {
+    if (complete[i].documentation) {
+      complete[i].documentation = {
+        kind: MarkupKind.Markdown,
+        value: ResolveHoverHelpLinks(
+          complete[i].documentation as string,
+          config
+        ),
+      };
+    }
+  }
+
   return complete;
 }