mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-10-24 02:33:16 +02:00
e0272ad4af
* Added new types for various file paths, all in the Paths folder. * TypeSafety and other helper functions related to these types * Added basic globbing support with * and ?. Currently only implemented for Script/Text, on nano and download terminal commands * Enforcing the new types throughout the codebase, plus whatever rewrites happened along the way * Server.textFiles is now a map * TextFile no longer uses a fn property, now it is filename * Added a shared ContentFile interface for shared functionality between TextFile and Script. * related to ContentFile change above, the player is now allowed to move a text file to a script file and vice versa. * File paths no longer conditionally start with slashes, and all directory names other than root have ending slashes. The player is still able to provide paths starting with / but this now indicates that the player is specifying an absolute path instead of one relative to root. * Singularized the MessageFilename and LiteratureName enums * Because they now only accept correct types, server.writeToXFile functions now always succeed (the only reasons they could fail before were invalid filepath). * Fix several issues with tab completion, which included pretty much a complete rewrite * Changed the autocomplete display options so there's less chance it clips outside the display area. * Turned CompletedProgramName into an enum. * Got rid of programsMetadata, and programs and DarkWebItems are now initialized immediately instead of relying on initializers called from the engine. * For any executable (program, cct, or script file) pathing can be used directly to execute without using the run command (previously the command had to start with ./ and it wasn't actually using pathing).
31 lines
1.3 KiB
TypeScript
31 lines
1.3 KiB
TypeScript
import { Directory } from "./Directory";
|
|
import { FilePath, resolveFilePath } from "./FilePath";
|
|
|
|
/** Type for just checking a .js extension with no other verification*/
|
|
type WithScriptExtension = string & { __fileType: "Script" };
|
|
/** Type for a valid absolute FilePath with a script extension */
|
|
export type ScriptFilePath = FilePath & WithScriptExtension;
|
|
|
|
/** Valid extensions. Used for some error messaging. */
|
|
export type ScriptExtension = ".js" | ".script";
|
|
export const validScriptExtensions: ScriptExtension[] = [".js", ".script"];
|
|
|
|
/** Sanitize a player input, resolve any relative paths, and for imports add the correct extension if missing
|
|
* @param path The player-provided path to a file. Can contain relative parts.
|
|
* @param base The base
|
|
*/
|
|
export function resolveScriptFilePath(
|
|
path: string,
|
|
base = "" as FilePath | Directory,
|
|
extensionToAdd?: ScriptExtension,
|
|
): ScriptFilePath | null {
|
|
if (extensionToAdd && !path.endsWith(extensionToAdd)) path = path + extensionToAdd;
|
|
const result = resolveFilePath(path, base);
|
|
return result && hasScriptExtension(result) ? result : null;
|
|
}
|
|
|
|
/** Just check extension */
|
|
export function hasScriptExtension(path: string): path is WithScriptExtension {
|
|
return validScriptExtensions.some((extension) => path.endsWith(extension));
|
|
}
|