typescript-virtual-container 1.4.0 → 1.4.2

package/.vscode/settings.json

@@ -9,6 +9,8 @@
 
         ".ssh-mimic": true,
         ".vfs": true,
+        "builds": true,
+        "examples": true,
         
         "LICENSE": true,
         "tsconfig.tsbuildinfo": true

package/README.md

@@ -82,6 +82,10 @@ curl -s https://raw.githubusercontent.com/itsrealfortune/typescript-virtual-cont
 curl -s https://raw.githubusercontent.com/itsrealfortune/typescript-virtual-container/refs/heads/main/builds/standalone-wo-sftp.js -o standalone.js && node standalone.js && rm -f standalone.js
 ```
 
+> [!NOTE]
+> The standalone builds are intended for quick demos and testing. For production use, it's recommended to install the package and import the relevant classes directly in your codebase for better performance, stability, and security.
+> It implies command `man` is not available in standalone mode because manuals are not included in the minimal build, but you can always refer to the [API Reference](#api-reference) for detailed documentation.
+
 **`self-standalone.js` options:**
 
 ```bash
@@ -427,7 +431,7 @@ new VirtualUserManager(
 )
 ```
 
-Auth data is stored at `/virtual-env-js/.auth/` inside the VFS.
+Auth data is stored at `/etc/` inside the VFS.
 
 **Methods**
 

package/benchmark-virtualshell.ts

@@ -1,20 +1,16 @@
 #!/usr/bin/env bun
-
-import { mkdirSync, rmSync } from "node:fs";
-import { join } from "node:path";
 import { VirtualShell } from "./src/index.ts";
 
 const counts = [1, 2, 5, 10, 20, 50, 100];
-const rootBenchmarkPath = join(process.cwd(), ".benchmark-shells");
 
 function bytesToMb(bytes: number): string {
 	return `${Math.round(bytes / 1024 / 1024)} MB`;
 }
 
 async function createShell(baseName: string, index: number): Promise<VirtualShell> {
-	const basePath = join(rootBenchmarkPath, `${baseName}-${index}`);
-	mkdirSync(basePath, { recursive: true });
-	const shell = new VirtualShell(`${baseName}-${index}`, undefined, basePath);
+	const shell = new VirtualShell(`${baseName}-${index}`, undefined, {
+		mode: "memory",
+	});
 	await shell.ensureInitialized();
 	return shell;
 }
@@ -59,8 +55,6 @@ async function runSingleBenchmark(count: number) {
 }
 
 async function main() {
-	rmSync(rootBenchmarkPath, { recursive: true, force: true });
-	mkdirSync(rootBenchmarkPath, { recursive: true });
 
 	console.log("Benchmarking VirtualShell concurrency:\n");
 	const results = [];
@@ -86,8 +80,6 @@ async function main() {
 			`${row.count}\t${row.initMs}\t${row.commandMs}\t${bytesToMb(row.initRss)}\t${bytesToMb(row.finalRss)}\t${bytesToMb(row.deltaRss)}`,
 		);
 	}
-
-	console.log(`\nBenchmark data stored under ${rootBenchmarkPath}`);
 }
 
 main().catch((error) => {