Address comments

gilamran · Mar 27, 2024 · 2a86a37 · 2a86a37
1 parent 11b89b2
commit 2a86a37
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -11,8 +11,8 @@
 | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `--onSuccess COMMAND`             | Executes `COMMAND` on **every successful** compilation.                                                                                             |
 | `--onFirstSuccess COMMAND`        | Executes `COMMAND` on the **first successful** compilation.                                                                                         |
-| `--onEmit COMMAND`                | Executes debounced `COMMAND` on **every emitted file**.                                                                                             |
-| `--onEmitDebounceMs DELAY`        | Delay by which to debounce `--onEmit`.                                                                                                              |
+| `--onEmit COMMAND`                | Executes debounced `COMMAND` on **every emitted file**, ignoring unchanged inputs and regardless of success or failure.                             |
+| `--onEmitDebounceMs DELAY`        | Delay by which to debounce `--onEmit` (default: 300).                                                                                               |
 | `--onFailure COMMAND`             | Executes `COMMAND` on **every failed** compilation.                                                                                                 |
 | `--onCompilationStarted COMMAND`  | Executes `COMMAND` on **every compilation start** event (initial and incremental).                                                                  |
 | `--onCompilationComplete COMMAND` | Executes `COMMAND` on **every successful or failed** compilation.                                                                                   |
@@ -122,5 +122,7 @@ Notes:
 - The (`onSuccess`) `COMMAND` will not run if the compilation failed.
 - The (`onEmit`) `COMMAND` will not run if the compilation succeeded with no changed files, unless it is the first success.
 - The (`onEmit`) `COMMAND` will run if the compilation failed, but still emitted changed files.
+- The (`onEmit`) `COMMAND` will not run 100 times for 100 files, due to `--onEmitDebounce`
+- The (`onEmit`) `COMMAND` will not cancel the `onSuccess`/`onFirstSuccess`/`onFailure`/`onCompilationComplete`/`onCompilationStarted` commands and vice versa.
 - `tsc-watch` is using the currently installed TypeScript compiler.
 - `tsc-watch` is not changing the compiler, just adds the new arguments, compilation is the same, and all other arguments are the same.
diff --git a/src/lib/stdout-manipulator.ts b/src/lib/stdout-manipulator.ts
@@ -22,8 +22,8 @@ const newAdditionToSyntax = [
   ' --onSuccess COMMAND                                Executes `COMMAND` on **every successful** compilation.',
   ' --onFirstSuccess COMMAND                           Executes `COMMAND` on the **first successful** compilation.',
   ' --onFailure COMMAND                                Executes `COMMAND` on **every failed** compilation.',
-  ' --onEmit COMMAND                                   Executes debounced `COMMAND` on **every emitted file**.',
-  ' --onEmitDebounceMs DELAY                           Delay by which to debounce `--onEmit`.',
+  ' --onEmit COMMAND                                   Executes debounced `COMMAND` on **every emitted file**, ignoring unchanged inputs and regardless of success or failure.',
+  ' --onEmitDebounceMs DELAY                           Delay by which to debounce `--onEmit` (default: 300).',
   ' --onCompilationStarted COMMAND                     Executes `COMMAND` on **every compilation start** event.',
   ' --onCompilationComplete COMMAND                    Executes `COMMAND` on **every successful or failed** compilation.',
   ' --noColors                                         Removes the red/green colors from the compiler output',

diff --git a/src/lib/tsc-watch.ts b/src/lib/tsc-watch.ts
@@ -75,20 +75,20 @@ function killProcesses(currentCompilationId: number, killAll: boolean): Promise<
   return runningKillProcessesPromise;
 }
 
+// We separate this from `runningKillProcessesPromise` to avoid canceling each other
 let runningKillEmitProcessesPromise: Promise<number> | null = null;
 function killEmitProcesses(currentEmitId: number): Promise<number> {
   if (runningKillEmitProcessesPromise) {
     return runningKillEmitProcessesPromise.then(() => currentEmitId);
   }
 
-  const promisesToWaitFor: Promise<any>[] = [];
-
+  let emitKilled = Promise.resolve();
   if (emitKiller) {
-    promisesToWaitFor.push(emitKiller());
+    emitKilled = emitKiller();
     emitKiller = null;
   }
 
-  runningKillEmitProcessesPromise = Promise.all(promisesToWaitFor).then(() => {
+  runningKillEmitProcessesPromise = emitKilled.then(() => {
     runningKillEmitProcessesPromise = null;
     return currentEmitId;
   });