Add --echo flag for dry run preview

center-key · Aug 27, 2023 · cb391a9 · cb391a9
1 parent 18c60f5
commit cb391a9
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -53,11 +53,12 @@ You can also install **recursive-exec** globally (`--global`) and then run it an
 
 ### 3. CLI flags
 Command-line flags:
-| Flag         | Description                                           | Value      |
-| ------------ | ----------------------------------------------------- | ---------- |
+| Flag         | Description                                               | Value      |
+| ------------ | --------------------------------------------------------- | ---------- |
+| `--echo`     | Show dry run preview of each command without executig it. | N/A        |
 | `--ext`      | Filter files by file extension, such as `.js`.<br>Use a comma to specify multiple extensions. | **string** |
-| `--note`     | Place to add a comment only for humans.               | **string** |
-| `--quiet`    | Suppress informational messages.                      | N/A        |
+| `--note`     | Place to add a comment only for humans.                   | **string** |
+| `--quiet`    | Suppress informational messages.                          | N/A        |
 
 Examples:
    - `recursive-exec src/web --ext=.less 'lessc src/web/{{filename}} build/web/{{basename}}.css'`<br>

diff --git a/bin/cli.js b/bin/cli.js
@@ -24,7 +24,7 @@ import { cliArgvUtil } from 'cli-argv-util';
 import { recursiveExec } from '../dist/recursive-exec.js';
 
 // Parameters and flags
-const validFlags = ['ext', 'note', 'quiet'];
+const validFlags = ['echo', 'ext', 'note', 'quiet'];
 const cli =        cliArgvUtil.parse(validFlags);
 const folder =     cli.params[0];
 const command =    cli.params[1];
@@ -39,6 +39,7 @@ const error =
 if (error)
    throw Error('[recursive-exec] ' + error);
 const options = {
+   echo:       cli.flagOn.echo,
    quiet:      cli.flagOn.quiet,
    extensions: cli.flagMap.ext?.split(',') ?? null,
    };

diff --git a/recursive-exec.ts b/recursive-exec.ts
@@ -11,6 +11,7 @@ import slash from 'slash';
 
 // Types
 export type Settings = {
+   echo:       boolean,          //show dry run preview of each command without executig it
    extensions: string[] | null,  //filter files by file extensions, example: ['.js', '.css']
    quiet:      boolean,          //suppress informational messages
    };
@@ -72,14 +73,17 @@ const recursiveExec = {
             };
          };
       const results = files.map(slash).map(calcResult);
+      const previewCommand = (result: Result) => {
+         log(logName, chalk.blue.bold('preview:'), chalk.yellow(result.command));
+         };
       const execCommand = (result: Result) => {
          if (!settings.quiet)
             log(logName, chalk.blue.bold('command:'), chalk.cyanBright(result.command));
          const task = spawnSync(result.command, { shell: true, stdio: 'inherit' });
          if (task.status !== 0)
             throw Error(`[recursive-exec] Status: ${task.status}\nCommand: ${result.command}`);
          };
-      results.forEach(execCommand);
+      results.forEach(settings.echo ? previewCommand : execCommand);
       const summary = `(files: ${results.length}, ${Date.now() - startTime}ms)`;
       if (!settings.quiet)
          log(logName, chalk.green('done'), chalk.white(summary));

diff --git a/spec/mocha.spec.js b/spec/mocha.spec.js
@@ -149,7 +149,9 @@ describe('Executing the CLI', () => {
       });
 
    it('to rename copies of files with camel case names preserves the source folder structure', () => {
-      run('recursive-exec spec/fixtures/source --ext=.html "copy-file {{file}} spec/fixtures/target/html/{{path}}/{{name}}.{{nameCamelCase}}.html"');
+      const template = 'copy-file {{file}} spec/fixtures/target/html/{{path}}/{{name}}.{{nameCamelCase}}.html';
+      run(`recursive-exec spec/fixtures/source --ext=.html --echo "${template}"`);
+      run(`recursive-exec spec/fixtures/source --ext=.html "${template}"`);
       const actual = cliArgvUtil.readFolder('spec/fixtures/target/html');
       const expected = [
          'mock-file1.mockFile1.html',