feat(core): add interactive env var (#14994)

nrwl · Feb 16, 2023 · 40deb00 · 40deb00 · vercel · Feb 16, 2023
1 parent 497a90e
commit 40deb00
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 4 deletions.
diff --git a/docs/shared/reference/environment-variables.md b/docs/shared/reference/environment-variables.md
@@ -14,3 +14,5 @@
 | NX_SKIP_NX_CACHE                 | boolean | Rerun the tasks even when the results are available in the cache                                                                                                                                                             |
 | NX_TASKS_RUNNER_DYNAMIC_OUTPUT   | boolean | If set to `false`, will use non-dynamic terminal output strategy (what you see in CI), even when you terminal can support the dynamic version                                                                                |
 | NX_VERBOSE_LOGGING               | boolean | If set to `true`, will print debug information useful for troubleshooting                                                                                                                                                    |
+| NX_DRY_RUN                       | boolean | If set to `true`, will perform a dry run of the generator. No files will be created and no packages will be installed.                                                                                                       |
+| NX_INTERACTIVE                   | boolean | If set to `true`, will allow Nx to prompt you in the terminal to answer some further questions when running generators.                                                                                                      |
diff --git a/packages/devkit/src/utils/package-json.ts b/packages/devkit/src/utils/package-json.ts
@@ -395,7 +395,8 @@ export async function ensurePackage(
 ): Promise<void> {
   // Read package and version from root package.json file.
   const dev = options.dev ?? true;
-  const throwOnMissing = options.throwOnMissing ?? !!process.env.NX_DRY_RUN; // NX_DRY_RUN is set in `packages/nx/src/command-line/generate.ts`
+  const throwOnMissing =
+    options.throwOnMissing ?? process.env.NX_DRY_RUN === 'true'; // NX_DRY_RUN is set in `packages/nx/src/command-line/nx-commands.ts`
   const pmc = getPackageManagerCommand();
 
   let version = getPackageVersion(pkg);

diff --git a/packages/nx/src/command-line/generate.ts b/packages/nx/src/command-line/generate.ts
@@ -317,9 +317,7 @@ export async function generate(cwd: string, args: { [k: string]: any }) {
       'generate',
       projectsConfigurations
     );
-    if (opts.dryRun) {
-      process.env.NX_DRY_RUN = 'true';
-    }
+
     const {
       normalizedGeneratorName,
       schema,

diff --git a/packages/nx/src/command-line/nx-commands.ts b/packages/nx/src/command-line/nx-commands.ts
@@ -36,6 +36,7 @@ export const commandsObject = yargs
     handler: async (args) => {
       // Remove the command from the args
       args._ = args._.slice(1);
+
       process.exit(
         await (await import('./generate')).generate(process.cwd(), args)
       );
@@ -732,6 +733,18 @@ function withGenerateOptions(yargs: yargs.Argv) {
         'Prints additional information about the commands (e.g., stack traces)',
       type: 'boolean',
       default: false,
+    })
+    .middleware((args) => {
+      if (process.env.NX_INTERACTIVE !== 'false') {
+        args.interactive = true;
+      } else {
+        process.env.NX_INTERACTIVE = `${args.interactive}`;
+      }
+      if (process.env.NX_DRY_RUN === 'true') {
+        args.dryRun = true;
+      } else {
+        process.env.NX_DRY_RUN = `${args.dryRun}`;
+      }
     });
 
   if (generatorWillShowHelp) {