Split process spawning concept into guides/concept

Author: Corb3nik

.vitepress/sidebars/guides.ts

@@ -34,6 +34,10 @@ export const guidesSidebar: DefaultTheme.SidebarItem[] = [
         text: "Sending HTTP Requests",
         link: "/guides/components/request",
       },
+      {
+        text: "Spawning a Process",
+        link: "/guides/components/spawning_process",
+      },
     ],
   },
   {

src/concepts/index.md

@@ -10,4 +10,4 @@ Here you will find explanations of the core concepts that underpin Caido plugins
 
 ## Modules
 
-- **[Child Process](./modules/child_process.md)** - spawn processes using the `child_process` module.
+- [Child Process](./modules/child_process.md) - Caido's implementation of NodeJS's `child_process` module.

src/concepts/modules/child_process.md

@@ -1,96 +1,14 @@
 # Child Process
 
-This module tries to replicate the `child_process` module from `NodeJS`. For an exhaustive list of implemented features, refer to the [child_process.d.ts](https://github.com/caido/dependency-llrt/blob/main/types/child_process.d.ts) file.
+Caido plugins offer a `child_process` module similiar to NodeJS's `child_process` module. This allows you to spawn child processes from your code, with some limitations.
 
-## Spawning a process
+This page will cover the differences between NodeJS's `child_process` module and Caido's implementation.
 
-To spawn a process, you can use the `spawn` function.
+::: info
+For an exhaustive list of implemented features, refer to the [child_process.d.ts](https://github.com/caido/dependency-llrt/blob/main/types/child_process.d.ts) file.
+:::
 
-```js
-import { spawn } from "child_process";
-
-const child = spawn("echo", ["Hello, world!"]);
-```
-
-### Reading stdout and stderr
-
-To handle the output and error streams of the child process, you can use the `stdout` and `stderr` properties of the child process.
-
-```js
-let output = "";
-child.stdout.on("data", (data) => {
-  output += data.toString();
-});
-
-let error = "";
-child.stderr.on("data", (data) => {
-  error += data.toString();
-});
-```
-
-### Waiting for exit
-
-To wait for the child process to close and check the exit code, you can use the `close` event of the child process.
-
-```js
-const exitCode = await new Promise((resolve, reject) => {
-  child.on("close", resolve);
-});
-
-if (exitCode) {
-  throw new Error(`subprocess error exit ${exitCode}, ${error}`);
-}
-```
-
-### Driving a process to completion
-
-Combining the two methods, we can drive any child process to completion and get its output.
-
-```js
-async function driveChild(child) {
-  let output = "";
-  child.stdout.on("data", (data) => {
-    output += data.toString();
-  });
-
-  let error = "";
-  child.stderr.on("data", (data) => {
-    error += data.toString();
-  });
-
-  const exitCode = await new Promise((resolve, reject) => {
-    child.on("close", resolve);
-  });
-
-  if (exitCode) {
-    throw new Error(`subprocess error exit ${exitCode}, ${error}`);
-  }
-
-  return output;
-}
-
-export async function test() {
-  const child = spawn("echo", ["Hello, world!"]);
-  const result = await driveChild(child);
-  return result;
-}
-```
-
-## Executing within in a shell
-
-You can use the `shell: true` or `shell: '/shell/path'` options to execute the command in a shell.
-
-```js
-import { spawn } from "child_process";
-
-export async function test() {
-  const child = spawn("echo", ["Hello, world!"], { shell: true });
-  const result = await driveChild(child);
-  return result;
-}
-```
-
-## Limitations
+## Differences
 
 - The function `exec` is not implemented, use `spawn` with the `shell` option instead.
 - The method `pipe` is not available to streams (like `stdout` and `stderr`).

src/guides/components/spawning_process.md

@@ -0,0 +1,97 @@
+# Spawning a process
+
+You might want to spawn a process to interact with external tools or programs.
+
+To do this, you can use the `spawn` function from the `child_process` module.
+
+::: info
+This module is similar to NodeJS's `child_process` module, but with some differences. You can find more information in the [child_process](/concepts/modules/child_process.md) documentation.
+:::
+
+## Launching a process
+
+The code below spawns a process that echoes "Hello, world!" to the console.
+
+```js
+import { spawn } from "child_process";
+
+const child = spawn("echo", ["Hello, world!"]);
+```
+
+## Reading STDOUT and STDERR
+
+To handle the output and error streams of the child process, you can use the `stdout` and `stderr` properties of the child process.
+
+```js
+let output = "";
+child.stdout.on("data", (data) => {
+  output += data.toString();
+});
+
+let error = "";
+child.stderr.on("data", (data) => {
+  error += data.toString();
+});
+```
+
+## Waiting for exit
+
+To wait for the child process to close and check the exit code, you can use the `close` event of the child process.
+
+```js
+const exitCode = await new Promise((resolve, reject) => {
+  child.on("close", resolve);
+});
+
+if (exitCode) {
+  throw new Error(`subprocess error exit ${exitCode}, ${error}`);
+}
+```
+
+## Driving a process to completion
+
+Combining the two methods, we can drive any child process to completion and get its output.
+
+```js
+async function driveChild(child) {
+  let output = "";
+  child.stdout.on("data", (data) => {
+    output += data.toString();
+  });
+
+  let error = "";
+  child.stderr.on("data", (data) => {
+    error += data.toString();
+  });
+
+  const exitCode = await new Promise((resolve, reject) => {
+    child.on("close", resolve);
+  });
+
+  if (exitCode) {
+    throw new Error(`subprocess error exit ${exitCode}, ${error}`);
+  }
+
+  return output;
+}
+
+export async function test() {
+  const child = spawn("echo", ["Hello, world!"]);
+  const result = await driveChild(child);
+  return result;
+}
+```
+
+## Executing within in a shell
+
+You can use the `shell: true` or `shell: '/shell/path'` options to execute the command in a shell.
+
+```js
+import { spawn } from "child_process";
+
+export async function test() {
+  const child = spawn("echo", ["Hello, world!"], { shell: true });
+  const result = await driveChild(child);
+  return result;
+}
+```