Merge pull request #2206 from micalevisk/fix/preservewatch

feat: add `--preserveWatchOutput` to 'build' command and support using this option from tsconfig file
nestjs · Jul 31, 2023 · 226d506 · 226d506
2 parents ddcaaa1 + fd2f735
commit 226d506
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 12 deletions.
diff --git a/actions/build.action.ts b/actions/build.action.ts
@@ -186,7 +186,9 @@ export class BuildAction extends AbstractAction {
     watchMode: boolean,
     onSuccess: (() => void) | undefined,
   ) {
-    const { WebpackCompiler } = await import('../lib/compiler/webpack-compiler')
+    const { WebpackCompiler } = await import(
+      '../lib/compiler/webpack-compiler'
+    );
     const webpackCompiler = new WebpackCompiler(this.pluginsLoader);
 
     const webpackPath =
@@ -230,12 +232,12 @@ export class BuildAction extends AbstractAction {
       const isPreserveWatchOutputEnabled = options.find(
         (option) =>
           option.name === 'preserveWatchOutput' && option.value === true,
-      );
+      )?.value as boolean | undefined;
       watchCompiler.run(
         configuration,
         pathToTsconfig,
         appName,
-        { preserveWatchOutput: !!isPreserveWatchOutputEnabled },
+        { preserveWatchOutput: isPreserveWatchOutputEnabled },
         onSuccess,
       );
     } else {

diff --git a/commands/build.command.ts b/commands/build.command.ts
@@ -18,7 +18,11 @@ export class BuildCommand extends AbstractCommand {
       )
       .option('--type-check', 'Enable type checking (when SWC is used).')
       .option('--webpackPath [path]', 'Path to webpack configuration.')
-      .option('--tsc', 'Use tsc for compilation.')
+      .option('--tsc', 'Use typescript compiler for compilation.')
+      .option(
+        '--preserveWatchOutput',
+        'Use "preserveWatchOutput" option when using tsc watch mode.',
+      )
       .description('Build Nest application.')
       .action(async (app: string, command: Command) => {
         const options: Input[] = [];
@@ -67,6 +71,14 @@ export class BuildCommand extends AbstractCommand {
           value: command.typeCheck,
         });
 
+        options.push({
+          name: 'preserveWatchOutput',
+          value:
+            !!command.preserveWatchOutput &&
+            !!command.watch &&
+            !isWebpackEnabled,
+        });
+
         const inputs: Input[] = [];
         inputs.push({ name: 'app', value: app });
         await this.action.handle(inputs, options);

diff --git a/commands/start.command.ts b/commands/start.command.ts
@@ -23,7 +23,7 @@ export class StartCommand extends AbstractCommand {
       )
       .option('--webpackPath [path]', 'Path to webpack configuration.')
       .option('--type-check', 'Enable type checking (when SWC is used).')
-      .option('--tsc', 'Use tsc for compilation.')
+      .option('--tsc', 'Use typescript compiler for compilation.')
       .option(
         '--sourceRoot [sourceRoot]',
         'Points at the root of the source code for the single project in standard mode structures, or the default project in monorepo mode structures.',
@@ -35,7 +35,7 @@ export class StartCommand extends AbstractCommand {
       .option('-e, --exec [binary]', 'Binary to run (default: "node").')
       .option(
         '--preserveWatchOutput',
-        'Use "preserveWatchOutput" option when tsc watch mode.',
+        'Use "preserveWatchOutput" option when using tsc watch mode.',
       )
       .description('Run Nest application.')
       .action(async (app: string, command: Command) => {

diff --git a/lib/compiler/defaults/swc-defaults.ts b/lib/compiler/defaults/swc-defaults.ts
@@ -25,7 +25,7 @@ export const swcDefaultsFactory = (
         transform: {
           legacyDecorator: true,
           decoratorMetadata: true,
-          useDefineForClassFields: false
+          useDefineForClassFields: false,
         },
         keepClassNames: true,
         baseUrl: tsOptions?.baseUrl,

diff --git a/lib/compiler/watch-compiler.ts b/lib/compiler/watch-compiler.ts
@@ -16,7 +16,11 @@ import {
 import { TypeScriptBinaryLoader } from './typescript-loader';
 
 type TypescriptWatchCompilerExtras = {
-  preserveWatchOutput: boolean;
+  /**
+   * If `undefined`, the value of 'preserveWatchOutput' option from tsconfig
+   * file will be used instead.
+   */
+  preserveWatchOutput: boolean | undefined;
 };
 
 export class WatchCompiler extends BaseCompiler<TypescriptWatchCompilerExtras> {
@@ -60,7 +64,8 @@ export class WatchCompiler extends BaseCompiler<TypescriptWatchCompilerExtras> {
       configPath,
       {
         ...options,
-        preserveWatchOutput: extras.preserveWatchOutput,
+        preserveWatchOutput:
+          extras.preserveWatchOutput ?? options.preserveWatchOutput,
       },
       tsBin.sys,
       createProgram,

diff --git a/lib/runners/abstract.runner.ts b/lib/runners/abstract.runner.ts
@@ -3,7 +3,10 @@ import { ChildProcess, spawn, SpawnOptions } from 'child_process';
 import { MESSAGES } from '../ui';
 
 export class AbstractRunner {
-  constructor(protected binary: string, protected args: string[] = []) {}
+  constructor(
+    protected binary: string,
+    protected args: string[] = [],
+  ) {}
 
   public async run(
     command: string,

diff --git a/lib/schematics/abstract.collection.ts b/lib/schematics/abstract.collection.ts
@@ -3,7 +3,10 @@ import { Schematic } from './nest.collection';
 import { SchematicOption } from './schematic.option';
 
 export abstract class AbstractCollection {
-  constructor(protected collection: string, protected runner: AbstractRunner) {}
+  constructor(
+    protected collection: string,
+    protected runner: AbstractRunner,
+  ) {}
 
   public async execute(
     name: string,

diff --git a/lib/schematics/schematic.option.ts b/lib/schematics/schematic.option.ts
@@ -1,7 +1,10 @@
 import { normalizeToKebabOrSnakeCase } from '../utils/formatting';
 
 export class SchematicOption {
-  constructor(private name: string, private value: boolean | string) {}
+  constructor(
+    private name: string,
+    private value: boolean | string,
+  ) {}
 
   get normalizedName() {
     return normalizeToKebabOrSnakeCase(this.name);