COMMAND: Custom help commands for your own scripts #2227
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,20 +1,104 @@ | ||||||
| import { Player } from "@player"; | ||||||
| import type { AutocompleteData } from "@nsdefs"; | ||||||
| import { TerminalHelpText, HelpTexts } from "../HelpText"; | ||||||
| import { Terminal } from "../../Terminal"; | ||||||
| import { compile } from "../../NetscriptJSEvaluator"; | ||||||
| import { wrapUserNode } from "../../Netscript/NetscriptHelpers"; | ||||||
| import { enums } from "../../NetscriptFunctions"; | ||||||
| import { GetAllServers } from "../../Server/AllServers"; | ||||||
| import { hasScriptExtension, resolveScriptFilePath, ScriptFilePath } from "../../Paths/ScriptFilePath"; | ||||||
| import { Flags } from "../../NetscriptFunctions/Flags"; | ||||||
| import { hasTextExtension } from "../../Paths/TextFilePath"; | ||||||
|
|
||||||
| export function help(args: (string | number | boolean)[]): void { | ||||||
| if (args.length !== 0 && args.length !== 1) { | ||||||
| Terminal.error("Incorrect usage of help command. Usage: help"); | ||||||
| return; | ||||||
| } | ||||||
| if (args.length === 0) { | ||||||
| const flushedOut = TerminalHelpText.join("\n"); | ||||||
| Terminal.print(flushedOut); | ||||||
| } else { | ||||||
| const cmd = args[0] + ""; | ||||||
| const txt = HelpTexts[cmd]; | ||||||
|
|
||||||
| if (txt == null) { | ||||||
| // Here is where flow lands if we have a player-implemented command | ||||||
|
|
||||||
| // Input sanitization | ||||||
| const cmdCopy = String(cmd).replace(/^[/.]+/, "") as ScriptFilePath; | ||||||
|
There was a problem hiding this comment. Why this? Does help not work for scripts with relative directories? This doesn't feel like the right way to be checking for a script. I think Terminal.getFilepath is what you ought to be using here. |
||||||
| const filePath = resolveScriptFilePath(cmdCopy); | ||||||
|
|
||||||
| const localServer = Player.getCurrentServer(); | ||||||
|
|
||||||
| if (filePath == null) { | ||||||
| if (hasScriptExtension(cmdCopy)) { | ||||||
| Terminal.error(`Could not find script '${cmdCopy}'\nMake sure this file exists in this server.`); | ||||||
| } else if (hasTextExtension(cmdCopy)) { | ||||||
| Terminal.error( | ||||||
| `'${cmdCopy}' needs to be either a *.js, *.ts, *.jsx or *.tsx file to have detailed help information.`, | ||||||
| ); | ||||||
| } else { | ||||||
| Terminal.error(`No help entry for '${cmdCopy}'.`); | ||||||
| } | ||||||
| return; | ||||||
| } | ||||||
|
|
||||||
| const script = localServer.scripts.get(filePath); | ||||||
|
|
||||||
| try { | ||||||
| if (script == null) { | ||||||
| throw new Error("Script pathname has no valid script object"); | ||||||
| } | ||||||
|
|
||||||
| // Deal with help() here | ||||||
|
|
||||||
| // eslint-disable-next-line @typescript-eslint/no-floating-promises | ||||||
|
There was a problem hiding this comment. This warning is legitimate, although ultimately you will still end up doing the equivalent of dangling a promise. But, the issue is that everything within here is asynchronous, whereas the help command ends immediately. So, multiple lines can end up appended to the terminal before the script comes back with the result of the help. I think what you're going to need to do is I think you might be able to get fancy and still use Terminal.print/Terminal.error and thus avoid having to do ugly things for the ANSI support, by then directly mucking with the Terminal object and essentially swapping the placeholder object you created with printRaw for the new line, and removing the placeholder after. Since this all takes place synchronously (inside the resolution of the async |
||||||
| compile(script, localServer.scripts).then((compiledModule) => { | ||||||
| if (compiledModule.help == null) { | ||||||
| Terminal.error("No help text for '" + cmdCopy + "'. Implement it by exporting a help() function."); | ||||||
| return; | ||||||
| } | ||||||
|
|
||||||
| const autocompleteData: AutocompleteData = { | ||||||
|
There was a problem hiding this comment. Surely there's a version of this already for autocomplete? They should be shared, unless there's a painful reason why they can't. There was a problem hiding this comment. While refactoring, as d0sboots said, you should be careful when making any differences (e.g., |
||||||
| hostname: localServer.hostname, | ||||||
| servers: GetAllServers() | ||||||
| .filter((server) => server.backdoorInstalled || localServer.serversOnNetwork.includes(server.hostname)) | ||||||
|
There was a problem hiding this comment.
If there is a reason that |
||||||
| .map((server) => server.hostname), | ||||||
| scripts: [...localServer.scripts.keys()], | ||||||
| txts: [...localServer.textFiles.keys()], | ||||||
| enums: enums, | ||||||
| // Pass no flags as the help command does not use flags | ||||||
| flags: Flags([""]), | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| filename: script.filename, | ||||||
| processes: Array.from(localServer.runningScriptMap.values(), (m) => | ||||||
| Array.from(m.values(), (r) => ({ | ||||||
| pid: r.pid, | ||||||
| filename: r.filename, | ||||||
| threads: r.threads, | ||||||
| args: r.args.slice(), | ||||||
| temporary: r.temporary, | ||||||
| })), | ||||||
| ).flat(), | ||||||
| // Pass the command as the script filename | ||||||
| command: `${cmdCopy}`, | ||||||
| }; | ||||||
|
|
||||||
| const helpObj = compiledModule.help(autocompleteData); | ||||||
| Terminal.print(`Usage for ${cmdCopy}:`); | ||||||
|
|
||||||
| if (typeof helpObj === "string") { | ||||||
| Terminal.print(helpObj); | ||||||
| } else { | ||||||
| Terminal.printRaw(wrapUserNode(helpObj)); | ||||||
| } | ||||||
| }); | ||||||
| } catch (err) { | ||||||
| Terminal.error("Failed to get information for '" + cmdCopy + "'. Check if the script has any syntax errors."); | ||||||
| } | ||||||
| return; | ||||||
| } | ||||||
| const flushedOut: string = txt.join("\n"); | ||||||
| Terminal.print(flushedOut); | ||||||
| } | ||||||
| } | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You need to update this example code and output. Please check my comment in
help.ts. I recommend using something that is notdata.servers. That list is too long after making the suggested change in that comment, so it's not really a good example.