WIP: Auto complete now works like hover-help

Author: znorman-harris

CHANGELOG.md

@@ -39,6 +39,8 @@ Fixed a bug where we were incorrectly detecting standalone expressions and repor
 
 Fixed a parsing issue where we would not correctly determine the end of ternary operators which could report errors incorrectly in your code.
 
+Re-worked auto-complete to function the same way as hover help. Now, we determine types of features to send from one of our worker threads and then the main thread builds out the completion items. The advantage of this is that we can now send back documentation and other information (which doesn't exist in our worker threads).
+
 ## 4.6.0 - August 2024
 
 Fixed an issue where we open a file that we have stopped in, even if it is compiled as a SAVE file. Now, only PRO files will be jumped to.

apps/parsing-worker/src/main.ts

@@ -5,6 +5,7 @@ import { PrepareNotebookCell } from '@idl/notebooks/idl-index';
 import { ParseFileSync } from '@idl/parser';
 import {
   ChangeDetection,
+  GetCompletionRecipes,
   GetHoverHelpLookup,
   GetSyntaxProblems,
   IDL_INDEX_OPTIONS,
@@ -131,6 +132,21 @@ client.on(LSP_WORKER_THREAD_MESSAGE_LOOKUP.TRACK_GLOBAL, async (message) => {
   }
 });
 
+/**
+ * Handle requests to parse and post process code for a file
+ */
+client.on(
+  LSP_WORKER_THREAD_MESSAGE_LOOKUP.AUTO_COMPLETE_RECIPE,
+  async (message, cancel) => {
+    return GetCompletionRecipes(
+      WORKER_INDEX,
+      message.file,
+      message.code,
+      message.position
+    );
+  }
+);
+
 /**
  * Handle change detection
  */

libs/parsing/index/src/index.ts

@@ -1,3 +1,4 @@
+export * from './lib/auto-complete/get-completion-recipes';
 export * from './lib/change-detection/change-detection';
 export * from './lib/global-index.class';
 export * from './lib/global-index.interface';

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

@@ -1,11 +1,11 @@
 import { FormatterType, IAssemblerOptions } from '@idl/assembling/config';
-import { CompletionItem } from 'vscode-languageserver';
-
-import { IDLIndex } from '../idl-index.class';
 import {
   AutoCompleteRecipeOptions,
   AutoCompleteType,
-} from './auto-complete-recipe.interface';
+} from '@idl/types/auto-complete';
+import { CompletionItem } from 'vscode-languageserver';
+
+import { IDLIndex } from '../idl-index.class';
 import { BuildCompileOptCompletionItems } from './completion-for/completion-compile-opts';
 import { BuildExecutiveCommandCompletionItems } from './completion-for/completion-executive-commands';
 import { BuildFunctionMethodCompletionItems } from './completion-for/completion-function-methods';

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

@@ -1,13 +1,10 @@
 import { FormatterType, IAssemblerOptions } from '@idl/assembling/config';
+import { AutoCompleteRecipe, AutoCompleteType } from '@idl/types/auto-complete';
 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,
-  AutoCompleteType,
-} from './auto-complete-recipe.interface';
 import { ALL_COMPLETION_ITEM_BUILDERS } from './build-completion-items.interface';
 
 /**
@@ -16,8 +13,8 @@ import { ALL_COMPLETION_ITEM_BUILDERS } from './build-completion-items.interface
 export function BuildCompletionItems(
   index: IDLIndex,
   recipes: AutoCompleteRecipe<AutoCompleteType>[],
-  formatting: IAssemblerOptions<FormatterType>,
-  config: IDLExtensionConfig
+  config: IDLExtensionConfig,
+  formatting: IAssemblerOptions<FormatterType>
 ) {
   /** initial list of completion items */
   const complete: CompletionItem[] = [];

libs/parsing/index/src/lib/auto-complete/completion-for/completion-compile-opts.ts

@@ -2,14 +2,14 @@ import { AdjustCase } from '@idl/assembling/shared';
 import { TreeToken } from '@idl/parsing/syntax-tree';
 import { ALLOWED_COMPILE_OPTIONS } from '@idl/parsing/syntax-validators';
 import { ControlCompileOptToken, TOKEN_NAMES } from '@idl/tokenizer';
+import {
+  CompileOptCompletion,
+  ICompileOptCompletionOptions,
+} from '@idl/types/auto-complete';
 import { CompletionItemKind } from 'vscode-languageserver';
 
 import { BuildCompletionItemsArg } from '../build-completion-items.interface';
 import { SORT_PRIORITY } from '../sort-priority.interface';
-import {
-  CompileOptCompletion,
-  ICompileOptCompletionOptions,
-} from './completion-compile-opts.interface';
 
 /**
  * Generates options for creating compile opts

libs/parsing/index/src/lib/auto-complete/completion-for/completion-executive-commands.ts

@@ -2,15 +2,15 @@ import { AdjustCase } from '@idl/assembling/shared';
 import { TreeToken } from '@idl/parsing/syntax-tree';
 import { IDLFileHelper } from '@idl/shared';
 import { TokenName } from '@idl/tokenizer';
+import {
+  ExecutiveCommandCompletion,
+  IExecutiveCommandCompletionOptions,
+} from '@idl/types/auto-complete';
 import { basename } from 'path';
 import { CompletionItemKind } from 'vscode-languageserver';
 
 import { BuildCompletionItemsArg } from '../build-completion-items.interface';
 import { SORT_PRIORITY } from '../sort-priority.interface';
-import {
-  ExecutiveCommandCompletion,
-  IExecutiveCommandCompletionOptions,
-} from './completion-executive-commands.interface';
 
 /**
  * All executive commands

libs/parsing/index/src/lib/auto-complete/completion-for/completion-function-methods.interface.ts

@@ -1,26 +1,7 @@
-import { IDLDataType } from '@idl/types/core';
+import { FunctionMethodCompletion } from '@idl/types/auto-complete';
 
 import { BuildCompletionItemsArg } from '../build-completion-items.interface';
 
-/**
- * Auto-complete for function methods
- */
-export type FunctionMethodCompletion = 'function-method';
-
-/**
- * Options for adding function method completion
- */
-export interface IFunctionMethodCompletionOptions {
-  /**
-   * Do we add parentheses or not
-   */
-  addParen: boolean;
-  /**
-   * Data type to add types for
-   */
-  type: IDLDataType;
-}
-
 export interface IFunctionMethodCompletionArg
   extends BuildCompletionItemsArg<FunctionMethodCompletion> {
   /** Current methods that we have found */

libs/parsing/index/src/lib/auto-complete/completion-for/completion-function-methods.ts

@@ -1,6 +1,7 @@
 import { TransformCase } from '@idl/assembling/shared';
 import { IDL_DISPLAY_NAMES } from '@idl/parsing/routines';
 import { IDL_TRANSLATION } from '@idl/translation';
+import { IFunctionMethodCompletionOptions } from '@idl/types/auto-complete';
 import {
   GLOBAL_TOKEN_TYPES,
   IDL_TYPE_LOOKUP,
@@ -12,10 +13,7 @@ import {
 import { Command, CompletionItemKind } from 'vscode-languageserver';
 
 import { SORT_PRIORITY } from '../sort-priority.interface';
-import {
-  IFunctionMethodCompletionArg,
-  IFunctionMethodCompletionOptions,
-} from './completion-function-methods.interface';
+import { IFunctionMethodCompletionArg } from './completion-function-methods.interface';
 
 /**
  * Display names for function methods

libs/parsing/index/src/lib/auto-complete/completion-for/completion-functions.ts

@@ -3,15 +3,15 @@ import { TransformCase } from '@idl/assembling/shared';
 import { IDL_DISPLAY_NAMES } from '@idl/parsing/routines';
 import { TaskFunctionName } from '@idl/parsing/syntax-tree';
 import { IDL_TRANSLATION } from '@idl/translation';
+import {
+  FunctionCompletion,
+  IFunctionCompletionOptions,
+} from '@idl/types/auto-complete';
 import { GLOBAL_TOKEN_TYPES, TASK_REGEX } from '@idl/types/core';
 import { Command, CompletionItemKind } from 'vscode-languageserver';
 
 import { BuildCompletionItemsArg } from '../build-completion-items.interface';
 import { SORT_PRIORITY } from '../sort-priority.interface';
-import {
-  FunctionCompletion,
-  IFunctionCompletionOptions,
-} from './completion-functions.interface';
 
 /**
  * Display names for functions