feat(watch): add optional stdin key to exit watch mode cleanly (#472)

* feat(watch): add optional stdin key to exit watch mode cleanly
lerna-lite · Feb 4, 2023 · d0cf2d9 · d0cf2d9
1 parent 5387b4e
commit d0cf2d9
Show file tree

Hide file tree

Showing 20 changed files with 73 additions and 5 deletions.
diff --git a/package.json b/package.json
@@ -16,8 +16,9 @@
     "pack-tarball": "lerna run pack-tarball",
     "pack-tarball:nx": "lerna run pack-tarball --stream --use-nx",
     "preview:build": "lerna run build --stream --include-dependents --scope=@lerna-lite/listable",
-    "preview:watch:build": "lerna watch --no-bail --scope=@lerna-lite/listable --include-dependents -- cross-env-shell lerna run build --stream --include-dependents --scope=$LERNA_PACKAGE_NAME",
-    "preview:watch:build:pnpm": "lerna watch --no-bail --scope=@lerna-lite/listable --include-dependents -- cross-env-shell pnpm run --stream --filter ...$LERNA_PACKAGE_NAME build",
+    "preview:watch:build": "lerna watch --no-bail --scope=@lerna-lite/listable --include-dependents -- cross-env-shell lerna run build:incremental --stream --include-dependents --scope=$LERNA_PACKAGE_NAME",
+    "preview:watch:build:pnpm": "lerna watch --no-bail --scope=@lerna-lite/listable --include-dependents -- cross-env-shell pnpm run --stream --filter ...$LERNA_PACKAGE_NAME build:incremental",
+    "postpreview:watch:build:pnpm": "echo clean exit",
     "preview:watch:files": "lerna watch --glob=\"src/**/*.ts\" --scope=@lerna-lite/listable --include-dependents -- cross-env-shell echo $LERNA_FILE_CHANGES in package $LERNA_PACKAGE_NAME\"",
     "preview:watch:all": "lerna watch --watch-all-events --scope {@lerna-lite/watch,@lerna-lite/exec} -- cross-env-shell echo \"Changed files $LERNA_FILE_CHANGES in package $LERNA_PACKAGE_NAME\"",
     "preview:publish-alpha-dry-run": "lerna publish --dry-run --exact --include-merged-tags --preid alpha --dist-tag next prerelease",

diff --git a/packages/changed/package.json b/packages/changed/package.json
@@ -14,6 +14,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -18,6 +18,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -14,6 +14,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",

diff --git a/packages/diff/package.json b/packages/diff/package.json
@@ -14,6 +14,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",

diff --git a/packages/exec/package.json b/packages/exec/package.json
@@ -14,6 +14,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",

diff --git a/packages/filter-packages/package.json b/packages/filter-packages/package.json
@@ -14,6 +14,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",

diff --git a/packages/info/package.json b/packages/info/package.json
@@ -14,6 +14,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",

diff --git a/packages/init/package.json b/packages/init/package.json
@@ -14,6 +14,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",

diff --git a/packages/list/package.json b/packages/list/package.json
@@ -14,6 +14,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",

diff --git a/packages/listable/package.json b/packages/listable/package.json
@@ -14,6 +14,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",

diff --git a/packages/profiler/package.json b/packages/profiler/package.json
@@ -14,6 +14,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",

diff --git a/packages/publish/package.json b/packages/publish/package.json
@@ -14,6 +14,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",

diff --git a/packages/run/package.json b/packages/run/package.json
@@ -14,6 +14,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",

diff --git a/packages/tsconfig.bundle.json b/packages/tsconfig.bundle.json
@@ -23,5 +23,5 @@
     "sourceMap": true,
     "strict": true
   },
-  "exclude": ["**/*.spec.ts", "**/*.test.js", "**/*.test.ts", "**/__fixtures__/**/*.*", "**/__mocks__/**/*.*"]
+  "exclude": ["**/dist/**", "**/__fixtures__/**/*.*", "**/__mocks__/**/*.*", "**/__tests__/**/*.*"]
 }
diff --git a/packages/version/package.json b/packages/version/package.json
@@ -14,6 +14,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",

diff --git a/packages/watch/package.json b/packages/watch/package.json
@@ -14,6 +14,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --project tsconfig.bundle.json --newLine LF",
+    "build:incremental": "tsc --incremental --project tsconfig.bundle.json --newLine LF --sourceMap false --excludeDirectories dist",
     "pack-tarball": "npm pack"
   },
   "license": "MIT",
@@ -38,6 +39,7 @@
     "path": "^0.12.7"
   },
   "devDependencies": {
+    "mock-stdin": "^1.0.0",
     "rimraf": "^3.0.2",
     "yargs-parser": "^21.1.1"
   }

diff --git a/packages/watch/src/__tests__/watch-command.spec.ts b/packages/watch/src/__tests__/watch-command.spec.ts
@@ -43,6 +43,7 @@ jest.mock('@lerna-lite/watch', () => jest.requireActual('../watch-command'));
 
 // jest.useFakeTimers({ timerLimit: 100 });
 
+import mockStdin from 'mock-stdin';
 import path from 'path';
 import yargParser from 'yargs-parser';
 
@@ -87,7 +88,18 @@ const createArgv = (cwd: string, ...args: string[]) => {
 };
 
 describe('Watch Command', () => {
+  const stdinIsTTY = process.stdin.isTTY;
+  const stdoutIsTTY = process.stdout.isTTY;
+  const stdin = mockStdin.stdin();
+
+  beforeEach(() => {
+    process.stdin.isTTY = true;
+    process.stdout.isTTY = true;
+  });
+
   afterEach(() => {
+    process.stdin.isTTY = stdinIsTTY;
+    process.stdout.isTTY = stdoutIsTTY;
     process.exitCode = undefined;
   });
 
@@ -494,5 +506,23 @@ describe('Watch Command', () => {
         shell: true,
       });
     });
+
+    it('should execute watch add callback and stop the watch process when typing "x" in the shell', async () => {
+      const mockExit = jest.spyOn(process, 'exit').mockImplementation((number) => {
+        throw new Error('process.exit: ' + number);
+      });
+
+      try {
+        // prettier-ignore
+        await lernaWatch(testDir)('--emit-changes-delay', '0', '--scope', 'package-2', '--', 'echo $LERNA_PACKAGE_NAME');
+        const promise = watchAddHandler('add', path.join(testDir, 'packages/package-2/some-file.ts'));
+        stdin.send('x');
+        stdin.end();
+        await promise;
+      } catch (e) {
+        expect(mockExit).toHaveBeenCalled();
+        mockExit.mockRestore();
+      }
+    });
   });
 });
diff --git a/packages/watch/src/watch-command.ts b/packages/watch/src/watch-command.ts
@@ -13,7 +13,7 @@ import chokidar from 'chokidar';
 import path from 'path';
 
 import { CHOKIDAR_AVAILABLE_OPTIONS, EMIT_CHANGES_DELAY, FILE_DELIMITER } from './constants';
-import { ChangesStructure, ChokidarEventType } from './models';
+import { ChangesStructure } from './models';
 
 export function factory(argv: WatchCommandOption) {
   return new WatchCommand(argv);
@@ -64,6 +64,19 @@ export class WatchCommand extends Command<WatchCommandOption & FilterOptions> {
 
     this._count = this._filteredPackages.length;
     this._packagePlural = this._count === 1 ? 'package' : 'packages';
+
+    // optional keystroke to exit the watch cleanly
+    if (process.stdin.isTTY) {
+      this.logger.info('watch', 'Press "x" to exit watch mode.');
+      process.stdin.setRawMode(true);
+      process.stdin.resume();
+      process.stdin.on('data', (key) => {
+        if (key.toString().toLowerCase() === 'x') {
+          this.logger.info('watch', 'Exiting the watch...');
+          process.exit(0);
+        }
+      });
+    }
   }
 
   async execute() {
@@ -142,6 +155,8 @@ export class WatchCommand extends Command<WatchCommandOption & FilterOptions> {
   }
 
   protected executeCommandCallback() {
+    const debounceDelay = this.options.emitChangesDelay ?? EMIT_CHANGES_DELAY;
+
     return new Promise((resolve) => {
       // once we reached emit change stability threshold, we'll fire events for each packages & events while the file paths array will be merged
       if (this._timer) clearTimeout(this._timer as NodeJS.Timeout);
@@ -190,7 +205,7 @@ export class WatchCommand extends Command<WatchCommandOption & FilterOptions> {
             resolve({ changedPkg, mergedFiles: changedFilesCsv });
           }
         }
-      }, this.options.emitChangesDelay ?? EMIT_CHANGES_DELAY);
+      }, debounceDelay);
     });
   }
 

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml