Merge pull request #2891 from tigercat2000/autocomplete_documentation

Terminal: There is now an interface definition for the autocomplete() 'data' argument.

src/ScriptEditor/NetscriptDefinitions.d.ts

@@ -6904,3 +6904,14 @@ interface GameInfo {
   commit: string;
   platform: string;
 }
+
+/**
+ * Used for autocompletion
+ * @public
+ */
+interface AutocompleteData {
+  servers: string[];
+  scripts: string[];
+  txts: string[];
+  flags(schema: [string, string | number | boolean | string[]][]): any;
+}

src/Terminal/determineAllPossibilitiesForTabCompletion.ts

@@ -10,6 +10,7 @@ import { HelpTexts } from "./HelpText";
 import { isScriptFilename } from "../Script/isScriptFilename";
 import { compile } from "../NetscriptJSEvaluator";
 import { Flags } from "../NetscriptFunctions/Flags";
+import { AutocompleteData } from "../ScriptEditor/NetscriptDefinitions";
 import * as libarg from "arg";
 
 // An array of all Terminal commands
@@ -298,26 +299,27 @@ export async function determineAllPossibilitiesForTabCompletion(
       argv: command.slice(2),
     });
     const flagFunc = Flags(flags._);
+    const autocompleteData: AutocompleteData = {
+      servers: GetAllServers().map((server) => server.hostname),
+      scripts: currServ.scripts.map((script) => script.filename),
+      txts: currServ.textFiles.map((txt) => txt.fn),
+      flags: (schema: any) => {
+        pos2 = schema.map((f: any) => {
+          if (f[0].length === 1) return "-" + f[0];
+          return "--" + f[0];
+        });
+        try {
+          return flagFunc(schema);
+        } catch (err) {
+          return undefined;
+        }
+      },
+    }
     let pos: string[] = [];
     let pos2: string[] = [];
     pos = pos.concat(
       loadedModule.autocomplete(
-        {
+        autocompleteData,
-          servers: GetAllServers().map((server) => server.hostname),
-          scripts: currServ.scripts.map((script) => script.filename),
-          txts: currServ.textFiles.map((txt) => txt.fn),
-          flags: (schema: any) => {
-            pos2 = schema.map((f: any) => {
-              if (f[0].length === 1) return "-" + f[0];
-              return "--" + f[0];
-            });
-            try {
-              return flagFunc(schema);
-            } catch (err) {
-              return undefined;
-            }
-          },
-        },
         flags._,
       ),
     );