From 4938b2522a157eea75c25bd71a5ebdb37482875f Mon Sep 17 00:00:00 2001 From: Tben Date: Thu, 17 Aug 2023 16:47:02 +0100 Subject: [PATCH] First Commit --- .gitignore | 2 + README.md | 109 ++++++++++++++++++++++ console-colors.js | 31 +++++++ index.js | 224 ++++++++++++++++++++++++++++++++++++++++++++++ package.json | 20 +++++ 5 files changed, 386 insertions(+) create mode 100644 .gitignore create mode 100644 README.md create mode 100644 console-colors.js create mode 100644 index.js create mode 100644 package.json diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4e8b4f1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules +/test diff --git a/README.md b/README.md new file mode 100644 index 0000000..90ea93a --- /dev/null +++ b/README.md @@ -0,0 +1,109 @@ +# Run multiple concurrent processes + +Do you run an application that needs multiple processes? Like `npm run dev` and `npm run tailwind`. Typically in a dev environment you would need to have more than one terminal open if you're running more than on processes. But with batch run you only need one terminal to run all processes concurrently. + +## Installation + +You can install and run this package directly by running: + +```bash +npx batch-run "npm run dev, npm run tailwind" +``` + +To install this module globally simply run: + +```bash +npm install -G batch-run +``` + +To install this module locally(for just the project) run: + +```bash +npm install batch-run +``` + +_NOTE_: You will have to append `npx` to your command for just a local installation. + +## Requirements + +For this package to work you need an argument of strings in the terminal command, or a `batchrun.config.json` file at the root of your project directory, which is simply an array of strings, each string being the command to run. Example: + +```json +["node index.js", "npm run tailwind"] +``` + +More entries mean more processes. + +# Usage + +To fire up the process without a `batchrun.config.json` file simply run: + +```bash +batch-run "npm run dev, npm run tailwind" +``` + +If you did not install the package globally, run: + +```bash +npx batch-run "npm run dev, npm run tailwind" +``` + +If you already have a `batchrun.config.json` file just run + +```bash +batch-run +``` + +# Process actions + +When your process is up and running, you can perform a few more actions to your running processes. + +### Reload all processes + +To reload all processes, while the process is active in your terminal type + +```bash +reload +``` + +Press `Enter` after tyring this. This will reload all the processes you started. Alternatively, you can simply press `Ctrl+R`: this does the same thing. `restart` amd `reboot` commands work also. + +### Reload processes + +You can also target a single process and reload it. This will need an index appended to the `reload` command. Example: + +```bash +- Processes Started ... +... +reload 0 +``` + +This will reload the first command in your list of commands. You can add more indexes by separating them with a comma(,): Example: + +```bash +- Processes Started ... +... +reload 0,3,4 +``` + +_NOTE_: Do not add a space between the commands or else the `reload` command won't work. + +### Kill processes + +To kill all processes simply type: + +```bash +- Processes Started ... +... +kill +``` + +This is the equivalent of pressing `Ctrl+C`. To kill specific processes just follow the same convention as the `reload` command. Example: + +```bash +- Processes Started ... +... +kill 1,2 +``` + +To restart a killed process simple use the `reload` command again. diff --git a/console-colors.js b/console-colors.js new file mode 100644 index 0000000..bec5d22 --- /dev/null +++ b/console-colors.js @@ -0,0 +1,31 @@ +const colors = { + Reset: "\x1b[0m", + Bright: "\x1b[1m", + Dim: "\x1b[2m", + Underscore: "\x1b[4m", + Blink: "\x1b[5m", + Reverse: "\x1b[7m", + Hidden: "\x1b[8m", + + FgBlack: "\x1b[30m", + FgRed: "\x1b[31m", + FgGreen: "\x1b[32m", + FgYellow: "\x1b[33m", + FgBlue: "\x1b[34m", + FgMagenta: "\x1b[35m", + FgCyan: "\x1b[36m", + FgWhite: "\x1b[37m", + FgGray: "\x1b[90m", + + BgBlack: "\x1b[40m", + BgRed: "\x1b[41m", + BgGreen: "\x1b[42m", + BgYellow: "\x1b[43m", + BgBlue: "\x1b[44m", + BgMagenta: "\x1b[45m", + BgCyan: "\x1b[46m", + BgWhite: "\x1b[47m", + BgGray: "\x1b[100m", +}; + +module.exports = colors; diff --git a/index.js b/index.js new file mode 100644 index 0000000..6de91b9 --- /dev/null +++ b/index.js @@ -0,0 +1,224 @@ +#! /usr/bin/env node +// @ts-check + +const fs = require("fs"); +const path = require("path"); +const { spawn, ChildProcess, execSync } = require("child_process"); +const readline = require("readline"); +const colors = require("./console-colors"); + +//////////////////////////////////////////// +//////////////////////////////////////////// +//////////////////////////////////////////// + +/** @type {string[]} */ +const processesStrings = []; + +/** @type {ChildProcess[]} */ +let processes = []; + +//////////////////////////////////////////// +//////////////////////////////////////////// +//////////////////////////////////////////// + +const rl = readline.createInterface({ + input: process.stdin, + output: process.stdout, +}); + +// Listen for user input +rl.on("line", (input) => { + if (input?.match(/^(reload|restart|reboot)$/i)) { + console.log(` - ${colors.FgBlue}Reloading processes ...${colors.Reset}`); + restartAll(); + } else if (input?.match(/^(reload|restart|reboot) \d/i)) { + const processedIndexesString = input.split(" ")[1]; + const processedIndexes = processedIndexesString ? processedIndexesString.split(",") : null; + + if (!processedIndexes?.length) { + console.log(` - ${colors.FgRed}Error:${colors.Reset} No processes to reload`); + return; + } else { + console.log(` - ${colors.FgBlue}Reloading processes ${processedIndexesString} ...${colors.Reset}`); + processedIndexes.forEach((index) => { + restartOne(index); + }); + console.log(` - ${colors.FgGreen}Processes Restarted Successfully ${processedIndexesString} ...${colors.Reset}`); + } + } + + if (input?.match(/^kill$/i)) { + console.log(` - ${colors.FgYellow}Killing processes ...${colors.Reset}`); + process.exit(); + } else if (input?.match(/^kill \d/i)) { + const processedIndexesString = input.split(" ")[1]; + const processedIndexes = processedIndexesString ? processedIndexesString.split(",") : null; + + if (!processedIndexes?.length) { + console.log(` - ${colors.FgRed}Error:${colors.Reset} No processes to reload`); + return; + } else { + console.log(` - ${colors.FgYellow}Killing processes ${processedIndexesString} ...${colors.Reset}`); + processedIndexes.forEach((index) => { + killOne(index); + }); + + console.log(` - ${colors.FgGreen}Processes Killed ${processedIndexesString} ...${colors.Reset}`); + } + } +}); + +process.stdin.on("keypress", (character, key) => { + if (key.ctrl && key.name === "r") { + console.log(` - ${colors.FgBlue}Reloading processes ...${colors.Reset}`); + restartAll(); + } +}); + +process.on("exit", (code) => { + console.log(` - ${colors.FgBlue}Process exited with code ${code}${colors.Reset}`); + rl.close(); +}); + +//////////////////////////////////////////// +//////////////////////////////////////////// +//////////////////////////////////////////// + +const argvProcessListIndex = process.argv.indexOf("batch-run") + 1; +const argvProcessList = process.argv.at(-1); + +const processesFilePath = path.resolve(process.cwd(), "batchrun.config.json"); + +if (argvProcessList) { + const processesArray = argvProcessList.split(","); + for (let i = 0; i < processesArray.length; i++) { + const processString = processesArray[i]; + const strippedProcessString = processString.trim(); + processesStrings.push(strippedProcessString); + } +} else if (fs.existsSync(processesFilePath)) { + const processesFile = fs.readFileSync(processesFilePath, "utf8"); + const processesArray = JSON.parse(processesFile); + for (let i = 0; i < processesArray.length; i++) { + const processString = processesArray[i]; + const strippedProcessString = processString.trim(); + processesStrings.push(strippedProcessString); + } +} else { + console.error(` - ${colors.FgRed}Error:${colors.Reset} No arguments to run or \`batchrun.config.json\` file present`); + process.exit(1); +} + +if (!processesStrings?.[0]) { + console.error(` - ${colors.FgRed}Error:${colors.Reset} No processes to run`); + process.exit(1); +} + +/** @type {import("child_process").SpawnOptions} */ +const spawnOptions = { + cwd: process.cwd(), + shell: process.platform.match(/win/i) ? "bash.exe" : undefined, + stdio: "inherit", +}; + +/** + * Start all processes + */ +function startProcesses() { + for (let i = 0; i < processesStrings.length; i++) { + const processString = processesStrings[i]; + const processStringArray = processString.split(" "); + const targetProcess = processStringArray.shift(); + if (targetProcess) { + const process = spawn(targetProcess, processStringArray, spawnOptions); + processes.push(process); + } else { + console.error(` - ${colors.FgRed}Error:${colors.Reset} A target process is not defined in \`${processString}\``); + process.exit(1); + } + } +} + +/** + * Restart All Processes + */ +function restartAll() { + for (let i = 0; i < processes.length; i++) { + const childProcess = processes[i]; + + try { + if (childProcess.pid) killProcessForce(childProcess.pid); + childProcess.kill(); + // processes.splice(i, 1); + } catch (error) { + console.log(` - ${colors.FgRed}Error:${colors.Reset} Failed to kill process ${childProcess.pid}`); + process.exit(); + } + } + + console.log(` - ${colors.FgGreen}Restarted ${processes.length} processes${colors.Reset}`); + + processes = []; + + setTimeout(() => { + startProcesses(); + }, 500); +} + +/** + * Restart a single process + * @param {string} index + */ +function restartOne(index) { + const childProcess = processes[parseInt(index)]; + + try { + if (childProcess.pid) killProcessForce(childProcess.pid); + childProcess.kill(); + } catch (error) { + console.log(` - ${colors.FgRed}Error:${colors.Reset} Failed to kill process ${childProcess.pid}`); + process.exit(); + } + + const processString = processesStrings[index]; + const processStringArray = processString.split(" "); + const targetProcess = processStringArray.shift(); + const newChildProcess = spawn(targetProcess, processStringArray, spawnOptions); + processes.splice(parseInt(index), 1, newChildProcess); +} + +/** + * Kill a single process + * @param {string} index + */ +function killOne(index) { + const childProcess = processes[parseInt(index)]; + if (childProcess.pid) killProcessForce(childProcess.pid); + childProcess.kill(); + + try { + } catch (error) { + console.log(` - ${colors.FgRed}Error:${colors.Reset} Failed to kill process ${childProcess.pid}`); + process.exit(); + } +} + +/** + * Kill a process by PID + * @param {number} pid + */ +function killProcessForce(pid) { + if (typeof pid !== "number") { + return; + } + try { + if (process.platform.match(/win/i)) { + execSync(`taskkill /F /PID ${pid} /T`); + } else { + execSync(`kill -9 ${pid}`); + } + } catch (error) {} +} + +console.log(` - ${colors.FgGreen}Started ${processes.length} processes${colors.Reset}`); +startProcesses(); diff --git a/package.json b/package.json new file mode 100644 index 0000000..6e0b57f --- /dev/null +++ b/package.json @@ -0,0 +1,20 @@ +{ + "name": "batch-run", + "version": "1.0.0", + "description": "Run and manage multiple processes concurrently in one terminal", + "main": "index.js", + "bin": { + "batch-run": "index.js" + }, + "keywords": [ + "process", + "batch", + "autoreload", + "terminal", + "cli", + "server", + "monitor" + ], + "author": "Benjamin Toby", + "license": "MIT" +}