core: Updated shell tests + docs

Author: Prozilla

packages/core/src/features/shell/command.ts

@@ -1,30 +1,52 @@
 import { ShellContext } from "./shell";
 
+/**
+ * Represents a command-line flag or parameter.
+ */
 export interface Option {
+	/** The full name of the option (e.g., "all" for --all). */
 	long: string;
+	/** The single-character alias (e.g., "a" for -a). */
 	short: string;
+	/** If true, the shell expects a value to follow this option (e.g., --file <name>). */
 	isInput: boolean;
 }
 
+/**
+ * Documentation metadata used by the `help` or `man` commands.
+ */
 export interface Manual {
+	/** A brief one-line summary of what the command does. */
 	purpose?: string;
+	/** A string representing the syntax (e.g., "ls [OPTION]... [FILE]..."). */
 	usage?: string;
+	/** A detailed explanation of the command's behavior. */
 	description?: string;
+	/** A mapping of option names to their descriptions for the help output. */
 	options?: object;
 }
 
 export type CommandOutput = number | undefined | void;
 export type Execute = (args: string[], context: ShellContext) => Promise<CommandOutput> | CommandOutput;
 
+/**
+ * Defines a shell command, including its execution logic, arguments requirements, and manual page.
+ */
 export class Command {
 	#name?: string;
 	options: Option[] = [];
 	manual?: Manual;
 	requireArgs?: boolean;
 	requireOptions?: boolean;
 
+	/**
+	 * The core logic to run when the command is invoked.
+	 */
 	execute: Execute = () => {};
 
+	/**
+	 * Sets the command name and initializes the default usage string if not already set.
+	 */
 	setName(name?: string): Command {
 		this.#name = name;
 
@@ -60,11 +82,17 @@ export class Command {
 		return this;
 	}
 
+	/**
+	 * Registers a new option/flag for this command.
+	 */
 	addOption({ short, long, isInput = false }: Omit<Option, "isInput"> & { isInput?: boolean }): Command {
 		this.options.push({ short, long, isInput });
 		return this;
 	}
 
+	/**
+	 * Retrieves an option definition by either its short or long name.
+	 */
 	getOption(key: string): Option | undefined {
 		return this.options.find((option) => option.short === key || option.long === key);
 	}

packages/core/src/features/shell/index.ts

@@ -1,4 +1,6 @@
 export * from "./command";
 export * from "./commands";
 export * from "./shell";
-export * from "./stream";
+export * from "./stream";
+export * from "./shellEnvironment";
+export * from "./shellInterpreter";