Merge pull request #408 from rznzippy/feat/add-no-progress-option

feat: Adds `--no-progress` flag that disables the progress bar
plopjs · Dec 22, 2023 · 6f3c9f2 · 6f3c9f2
2 parents 9240760 + 776cef5
commit 6f3c9f2
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 1 deletion.
diff --git a/.changeset/lemon-cooks-repeat.md b/.changeset/lemon-cooks-repeat.md
@@ -0,0 +1,5 @@
+---
+"plop": patch
+---
+
+Adds --no-progress flag that disables the progress bar
diff --git a/packages/plop/src/console-out.js b/packages/plop/src/console-out.js
@@ -78,6 +78,7 @@ function displayHelpScreen() {
  chalk.dim(
  " --dest Output to this directory instead of the plopfile's parent directory",
  ),
+ chalk.dim(" --no-progress Disable the progress bar"),
  "",
  chalk.bold("Examples:"),
  " $ " + chalk.blue("plop"),

diff --git a/packages/plop/src/plop.js b/packages/plop/src/plop.js
@@ -26,7 +26,7 @@ const isInJest = process.env.NODE_ENV === "test";
 const progressSpinner = ora({
  // Default is stderr
  stream: isInJest ? process.stdout : process.stderr,
- isEnabled: !isInJest,
+ isEnabled: !isInJest && argv.progress !== false,
 });
 
 /**

diff --git a/packages/plop/tests/__snapshots__/input-processing.spec.js.snap b/packages/plop/tests/__snapshots__/input-processing.spec.js.snap
@@ -21,6 +21,7 @@ Options:
  --cwd Directory from which relative paths are calculated against while locating the plopfile
  --preload String or array of modules to require before running plop
  --dest Output to this directory instead of the plopfile's parent directory
+ --no-progress Disable the progress bar
 
 Examples:
  $ plop