just-bash 1.0.0 → 1.1.0

package/dist/custom-commands.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Custom Commands API
+ *
+ * Provides types and utilities for registering user-provided TypeScript commands.
+ */
+import type { Command, CommandContext, ExecResult } from "./types.js";
+/**
+ * A custom command - either a Command object or a lazy loader.
+ */
+export type CustomCommand = Command | LazyCommand;
+/**
+ * Lazy-loaded custom command (for code-splitting).
+ */
+export interface LazyCommand {
+    name: string;
+    load: () => Promise<Command>;
+}
+/**
+ * Type guard to check if a custom command is lazy-loaded.
+ */
+export declare function isLazyCommand(cmd: CustomCommand): cmd is LazyCommand;
+/**
+ * Define a TypeScript command with type inference.
+ * Convenience wrapper - you can also just use the Command interface directly.
+ *
+ * @example
+ * ```ts
+ * const hello = defineCommand("hello", async (args, ctx) => {
+ *   const name = args[0] || "world";
+ *   return { stdout: `Hello, ${name}!\n`, stderr: "", exitCode: 0 };
+ * });
+ *
+ * const bash = new Bash({ customCommands: [hello] });
+ * await bash.exec("hello Alice"); // "Hello, Alice!\n"
+ * ```
+ */
+export declare function defineCommand(name: string, execute: (args: string[], ctx: CommandContext) => Promise<ExecResult>): Command;
+/**
+ * Create a lazy-loaded wrapper for a custom command.
+ * The command is only loaded when first executed.
+ */
+export declare function createLazyCustomCommand(lazy: LazyCommand): Command;

package/dist/index.d.ts

@@ -2,11 +2,14 @@ export type { BashOptions, ExecOptions } from "./Bash.js";
 export { Bash } from "./Bash.js";
 export type { AllCommandName, CommandName, NetworkCommandName, } from "./commands/registry.js";
 export { getCommandNames, getNetworkCommandNames, } from "./commands/registry.js";
-export { VirtualFs } from "./fs.js";
-export type { BufferEncoding, CpOptions, DirectoryEntry, FileContent, FileEntry, FileInit, FileSystemFactory, FsEntry, FsStat, InitialFiles, MkdirOptions, RmOptions, SymlinkEntry, } from "./fs-interface.js";
+export type { CustomCommand, LazyCommand } from "./custom-commands.js";
+export { defineCommand } from "./custom-commands.js";
+export { InMemoryFs } from "./fs/in-memory-fs/index.js";
+export type { BufferEncoding, CpOptions, DirectoryEntry, FileContent, FileEntry, FileInit, FileSystemFactory, FsEntry, FsStat, InitialFiles, MkdirOptions, RmOptions, SymlinkEntry, } from "./fs/interface.js";
+export { OverlayFs, type OverlayFsOptions } from "./fs/overlay-fs/index.js";
+export { ReadWriteFs, type ReadWriteFsOptions, } from "./fs/read-write-fs/index.js";
 export type { NetworkConfig } from "./network/index.js";
 export { NetworkAccessDeniedError, RedirectNotAllowedError, TooManyRedirectsError, } from "./network/index.js";
-export { OverlayFs, type OverlayFsOptions } from "./overlay-fs/index.js";
 export type { CommandFinished as SandboxCommandFinished, OutputMessage, SandboxOptions, WriteFilesInput, } from "./sandbox/index.js";
 export { Command as SandboxCommand, Sandbox } from "./sandbox/index.js";
 export type { BashExecResult, Command, CommandContext, ExecResult, IFileSystem, } from "./types.js";

package/dist/interpreter/interpreter.d.ts

@@ -10,7 +10,7 @@
  * - Redirections (redirections.ts)
  */
 import type { ScriptNode } from "../ast/types.js";
-import type { IFileSystem } from "../fs-interface.js";
+import type { IFileSystem } from "../fs/interface.js";
 import type { ExecutionLimits } from "../limits.js";
 import type { SecureFetch } from "../network/index.js";
 import type { CommandRegistry, ExecResult } from "../types.js";
@@ -46,7 +46,7 @@ export declare class Interpreter {
      * Resolution order:
      * 1. If command contains "/", resolve as a path
      * 2. Search PATH directories for the command file
-     * 3. Fall back to registry lookup (for non-VirtualFs filesystems like OverlayFs)
+     * 3. Fall back to registry lookup (for non-InMemoryFs filesystems like OverlayFs)
      */
     private resolveCommand;
     /**

package/dist/interpreter/types.d.ts

@@ -2,7 +2,7 @@
  * Interpreter Types
  */
 import type { CommandNode, FunctionDefNode, ScriptNode, StatementNode } from "../ast/types.js";
-import type { IFileSystem } from "../fs-interface.js";
+import type { IFileSystem } from "../fs/interface.js";
 import type { ExecutionLimits } from "../limits.js";
 import type { SecureFetch } from "../network/index.js";
 import type { CommandRegistry, ExecResult } from "../types.js";

package/dist/sandbox/Sandbox.d.ts

@@ -1,5 +1,5 @@
 import { Bash } from "../Bash.js";
-import type { IFileSystem } from "../fs-interface.js";
+import type { IFileSystem } from "../fs/interface.js";
 import type { NetworkConfig } from "../network/index.js";
 import type { CommandFinished } from "./Command.js";
 import { Command } from "./Command.js";

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { IFileSystem } from "./fs-interface.js";
+import type { IFileSystem } from "./fs/interface.js";
 import type { ExecutionLimits } from "./limits.js";
 import type { SecureFetch } from "./network/index.js";
 export interface ExecResult {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "just-bash",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A simulated bash environment with virtual filesystem",
   "repository": {
     "type": "git",
@@ -87,7 +87,7 @@
     "build:ai": "esbuild dist/ai/index.js --bundle --platform=node --format=esm --minify --outfile=dist/bundle/ai/index.js --external:ai --external:zod --external:diff --external:minimatch --external:sprintf-js --external:turndown",
     "build:cli": "esbuild dist/cli/just-bash.js --bundle --splitting --platform=node --format=esm --minify --outdir=dist/bin --entry-names=[name] --chunk-names=chunks/[name]-[hash] --banner:js='#!/usr/bin/env node'",
     "build:shell": "esbuild dist/cli/shell.js --bundle --splitting --platform=node --format=esm --minify --outdir=dist/bin/shell --entry-names=[name] --chunk-names=chunks/[name]-[hash] --banner:js='#!/usr/bin/env node'",
-    "validate": "pnpm build && pnpm typecheck && pnpm lint && pnpm knip && pnpm test:run && pnpm test:dist",
+    "validate": "pnpm lint && pnpm knip && pnpm typecheck &&  pnpm build && pnpm test:run && pnpm test:dist",
     "typecheck": "tsc --noEmit",
     "lint": "biome check .",
     "lint:fix": "biome check --write .",