UNPKG

projex

Version:

A command line to manage the workflow

github.com/Maik3345/projex-toolbet

Maik3345/projex-toolbet

23 lines (22 loc) • 1.76 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/** * The `runCommand` function executes a command in a specified directory, logs success and error * messages, and allows for retries. * @param {string} cmd - The `cmd` parameter is a string that represents the command to be executed. It * can be any valid command that can be run in the command line. * @param {string} cwd - The `cwd` parameter stands for "current working directory". It specifies the * directory in which the command should be executed. * @param {string} successMessage - The `successMessage` parameter is a string that represents the * message to be displayed when the command is executed successfully. * @param [hideOutput=false] - A boolean flag indicating whether to hide the output of the command * being executed. If set to true, the output will not be displayed in the console. If set to false, * the output will be displayed in the console. * @param [retries=0] - The `retries` parameter is used to specify the number of times the command * should be retried if it fails. If the command fails and the number of retries is greater than 0, the * function will recursively call itself with the same parameters, except for the `retries` parameter * which will * @param [hideSuccessMessage=false] - The `hideSuccessMessage` parameter is a boolean flag that * determines whether the success message should be displayed or not. If set to `true`, the success * message will be hidden. If set to `false` (default), the success message will be displayed. * @returns The function `runCommand` returns the output of the executed command. */ export declare const runCommand: (cmd: string, cwd: string, successMessage: string, hideOutput?: boolean, retries?: number, hideSuccessMessage?: boolean, makeThrow?: boolean) => any;