avoid ANSI clearScreen

clearScreen is quite aggressive and can e.g. brick the user's shell theme. Better use eraseScreen and cursorTo instead.
jestjs · Dec 17, 2018 · 6b6ed81 · 6b6ed81
1 parent 2dbd627
commit 6b6ed81
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -43,6 +43,7 @@
 - `[jest-mock]` [**BREAKING**] Fix bugs with mock/spy result tracking of recursive functions ([#6381](https://github.com/facebook/jest/pull/6381))
 - `[jest-haste-map]` [**BREAKING**] Recover files correctly after haste name collisions are fixed ([#7329](https://github.com/facebook/jest/pull/7329))
 - `[pretty-format]` [**BREAKING**] Omit non-enumerable symbol properties ([#7448](https://github.com/facebook/jest/pull/7448))
+- `[jest-cli]` Avoid watch mode causing bad terminal behavior in some cases (TODO)
 - `[expect]` Standardize file naming in `expect` ([#7306](https://github.com/facebook/jest/pull/7306))
 - `[jest-each]` Add empty array validation check ([#7249](https://github.com/facebook/jest/pull/7249))
 - `[jest-cli]` Interrupt tests if interactive watch plugin key is pressed ([#7222](https://github.com/facebook/jest/pull/7222))

diff --git a/packages/jest-cli/src/SnapshotInteractiveMode.js b/packages/jest-cli/src/SnapshotInteractiveMode.js
@@ -90,7 +90,8 @@ export default class SnapshotInteractiveMode {
   }
 
   _drawUIDoneWithSkipped() {
-    this._pipe.write(ansiEscapes.clearScreen);
+    this._pipe.write(ansiEscapes.eraseScreen);
+    this._pipe.write(ansiEscapes.cursorTo(0, 0));
     const numPass = this._countPaths - this._testAssertions.length;
 
     let stats = chalk.bold.dim(
@@ -123,7 +124,8 @@ export default class SnapshotInteractiveMode {
   }
 
   _drawUIDone() {
-    this._pipe.write(ansiEscapes.clearScreen);
+    this._pipe.write(ansiEscapes.eraseScreen);
+    this._pipe.write(ansiEscapes.cursorTo(0, 0));
     const numPass = this._countPaths - this._testAssertions.length;
 
     let stats = chalk.bold.dim(

diff --git a/packages/jest-cli/src/__tests__/SnapshotInteractiveMode.test.js b/packages/jest-cli/src/__tests__/SnapshotInteractiveMode.test.js
@@ -10,13 +10,13 @@ import {KEYS} from 'jest-watcher';
 import SnapshotInteractiveMode from '../SnapshotInteractiveMode';
 
 jest.mock('ansi-escapes', () => ({
-  clearScreen: '[MOCK - eraseDown]',
   cursorRestorePosition: '[MOCK - cursorRestorePosition]',
   cursorSavePosition: '[MOCK - cursorSavePosition]',
   cursorScrollDown: '[MOCK - cursorScrollDown]',
   cursorTo: (x, y) => `[MOCK - cursorTo(${x}, ${y})]`,
   cursorUp: () => '[MOCK - cursorUp]',
   eraseDown: '[MOCK - eraseDown]',
+  eraseScreen: '[MOCK - eraseScreen]',
 }));
 
 jest.doMock('chalk', () =>

diff --git a/packages/jest-cli/src/__tests__/__snapshots__/SnapshotInteractiveMode.test.js.snap b/packages/jest-cli/src/__tests__/__snapshots__/SnapshotInteractiveMode.test.js.snap
@@ -16,7 +16,8 @@ exports[`SnapshotInteractiveMode skip 1 test, then quit 1`] = `
 `;
 
 exports[`SnapshotInteractiveMode skip 1 test, then quit 2`] = `
-"[MOCK - eraseDown]
+"[MOCK - eraseScreen]
+[MOCK - cursorTo(0, 0)]
 
 <bold>Interactive Snapshot Result</>
  › <bold><dim>1 snapshot reviewed<bold></>, <bold><yellow>1 snapshot skipped</></>
@@ -43,7 +44,8 @@ exports[`SnapshotInteractiveMode skip 1 test, then restart 1`] = `
 `;
 
 exports[`SnapshotInteractiveMode skip 1 test, then restart 2`] = `
-"[MOCK - eraseDown]
+"[MOCK - eraseScreen]
+[MOCK - cursorTo(0, 0)]
 
 <bold>Interactive Snapshot Result</>
  › <bold><dim>1 snapshot reviewed<bold></>, <bold><yellow>1 snapshot skipped</></>
@@ -100,7 +102,8 @@ exports[`SnapshotInteractiveMode skip 1 test, update 1 test, then finish and res
 `;
 
 exports[`SnapshotInteractiveMode skip 1 test, update 1 test, then finish and restart 3`] = `
-"[MOCK - eraseDown]
+"[MOCK - eraseScreen]
+[MOCK - cursorTo(0, 0)]
 
 <bold>Interactive Snapshot Result</>
  › <bold><dim>2 snapshots reviewed<bold></>, <bold><green>1 snapshot updated</></>, <bold><yellow>1 snapshot skipped</></>
@@ -157,7 +160,8 @@ exports[`SnapshotInteractiveMode skip 2 tests, then finish and restart 2`] = `
 `;
 
 exports[`SnapshotInteractiveMode skip 2 tests, then finish and restart 3`] = `
-"[MOCK - eraseDown]
+"[MOCK - eraseScreen]
+[MOCK - cursorTo(0, 0)]
 
 <bold>Interactive Snapshot Result</>
  › <bold><dim>2 snapshots reviewed<bold></>, <bold><yellow>2 snapshots skipped</></>
@@ -214,7 +218,8 @@ exports[`SnapshotInteractiveMode update 1 test, skip 1 test, then finish and res
 `;
 
 exports[`SnapshotInteractiveMode update 1 test, skip 1 test, then finish and restart 3`] = `
-"[MOCK - eraseDown]
+"[MOCK - eraseScreen]
+[MOCK - cursorTo(0, 0)]
 
 <bold>Interactive Snapshot Result</>
  › <bold><dim>2 snapshots reviewed<bold></>, <bold><green>1 snapshot updated</></>, <bold><yellow>1 snapshot skipped</></>
@@ -256,7 +261,8 @@ exports[`SnapshotInteractiveMode update 1 test, then finish and return 1`] = `
 `;
 
 exports[`SnapshotInteractiveMode update 1 test, then finish and return 2`] = `
-"[MOCK - eraseDown]
+"[MOCK - eraseScreen]
+[MOCK - cursorTo(0, 0)]
 
 <bold>Interactive Snapshot Result</>
  › <bold><dim>1 snapshot reviewed<bold></>, <bold><green>1 snapshot updated</></>
@@ -297,7 +303,8 @@ exports[`SnapshotInteractiveMode update 2 tests, then finish and return 2`] = `
 `;
 
 exports[`SnapshotInteractiveMode update 2 tests, then finish and return 3`] = `
-"[MOCK - eraseDown]
+"[MOCK - eraseScreen]
+[MOCK - cursorTo(0, 0)]
 
 <bold>Interactive Snapshot Result</>
  › <bold><dim>2 snapshots reviewed<bold></>, <bold><green>2 snapshots updated</></>

diff --git a/packages/jest-cli/src/__tests__/__snapshots__/watch_filename_pattern_mode.test.js.snap b/packages/jest-cli/src/__tests__/__snapshots__/watch_filename_pattern_mode.test.js.snap
@@ -92,7 +92,8 @@ Object {
 
 exports[`Watch mode flows Pressing "c" clears the filters 1`] = `
 "[MOCK - cursorHide]
-[MOCK - clearScreen]
+[MOCK - eraseScreen]
+[MOCK - cursorTo(0, 0)]
 
 Pattern Mode Usage
  › Press Esc to exit pattern mode.

diff --git a/packages/jest-cli/src/__tests__/watch_filename_pattern_mode.test.js b/packages/jest-cli/src/__tests__/watch_filename_pattern_mode.test.js
@@ -14,13 +14,13 @@ import {KEYS} from 'jest-watcher';
 const runJestMock = jest.fn();
 
 jest.mock('ansi-escapes', () => ({
-  clearScreen: '[MOCK - clearScreen]',
   cursorDown: (count = 1) => `[MOCK - cursorDown(${count})]`,
   cursorHide: '[MOCK - cursorHide]',
   cursorRestorePosition: '[MOCK - cursorRestorePosition]',
   cursorSavePosition: '[MOCK - cursorSavePosition]',
   cursorShow: '[MOCK - cursorShow]',
   cursorTo: (x, y) => `[MOCK - cursorTo(${x}, ${y})]`,
+  eraseScreen: '[MOCK - eraseScreen]',
 }));
 
 jest.mock(

diff --git a/packages/jest-cli/src/__tests__/watch_test_name_pattern_mode.test.js b/packages/jest-cli/src/__tests__/watch_test_name_pattern_mode.test.js
@@ -14,13 +14,13 @@ import {KEYS} from 'jest-watcher';
 const runJestMock = jest.fn();
 
 jest.mock('ansi-escapes', () => ({
-  clearScreen: '[MOCK - clearScreen]',
   cursorDown: (count = 1) => `[MOCK - cursorDown(${count})]`,
   cursorHide: '[MOCK - cursorHide]',
   cursorRestorePosition: '[MOCK - cursorRestorePosition]',
   cursorSavePosition: '[MOCK - cursorSavePosition]',
   cursorShow: '[MOCK - cursorShow]',
   cursorTo: (x, y) => `[MOCK - cursorTo(${x}, ${y})]`,
+  eraseScreen: '[MOCK - eraseScreen]',
 }));
 
 jest.mock(

diff --git a/packages/jest-cli/src/watch.js b/packages/jest-cli/src/watch.js
@@ -395,7 +395,8 @@ export default function watch(
 
   const onCancelPatternPrompt = () => {
     outputStream.write(ansiEscapes.cursorHide);
-    outputStream.write(ansiEscapes.clearScreen);
+    outputStream.write(ansiEscapes.eraseScreen);
+    outputStream.write(ansiEscapes.cursorTo(0, 0));
     outputStream.write(usage(globalConfig, watchPlugins));
     outputStream.write(ansiEscapes.cursorShow);
   };

diff --git a/packages/jest-watcher/src/PatternPrompt.js b/packages/jest-watcher/src/PatternPrompt.js
@@ -38,7 +38,8 @@ export default class PatternPrompt {
 
   run(onSuccess: Function, onCancel: Function, options?: {header: string}) {
     this._pipe.write(ansiEscapes.cursorHide);
-    this._pipe.write(ansiEscapes.clearScreen);
+    this._pipe.write(ansiEscapes.eraseScreen);
+    this._pipe.write(ansiEscapes.cursorTo(0, 0));
 
     if (options && options.header) {
       this._pipe.write(options.header + '\n');