introduce interactive mode and new process model (#674)

CHANGELOG.md

@@ -4,7 +4,13 @@ Please add your own contribution below inside the Master section
 Bug-fixes within the same version aren't needed
 
 ## Master
-
+* Introducing a new interactive mode, in addition to the current "watch" mode, to run jest tests. Use the new `jest.autoRun` settings to control when and what tests should be run automatically, or not. - @connectdotz (#674) 
+* refactor jest process management to adopt queue-based model with promise-based process execution.  - @connectdotz (#674) 
+* enhance statusBar to display autoRun and workspace stats  - @connectdotz (#674)
+* added new commands, context menu, keybinding to better support interactive mode.  - @connectdotz (#674)
+* added ability to update snapshot without restarting jest.  - @connectdotz (#674)
+* added ability to get jest metadata such as all test files.  - @connectdotz (#674)
+* change editor decorators to reflect when tests are changed but tests have not been run (which might be common in the new interactive mode)  - @connectdotz (#674)
 -->
 
 ### 4.0.0-alpha.4

__mocks__/vscode.ts

@@ -1,9 +1,9 @@
 const languages = {
   createDiagnosticCollection: jest.fn(),
   registerCodeLensProvider: jest.fn(),
-}
+};
 
-const StatusBarAlignment = { Left: 1, Right: 2 }
+const StatusBarAlignment = { Left: 1, Right: 2 };
 
 const window = {
   createStatusBarItem: jest.fn(() => ({
@@ -17,7 +17,7 @@ const window = {
   showWorkspaceFolderPick: jest.fn(),
   onDidChangeActiveTextEditor: jest.fn(),
   showInformationMessage: jest.fn(),
-}
+};
 
 const workspace = {
   getConfiguration: jest.fn(),
@@ -27,32 +27,36 @@ const workspace = {
   onDidChangeConfiguration: jest.fn(),
   onDidChangeTextDocument: jest.fn(),
   onDidChangeWorkspaceFolders: jest.fn(),
-}
+  onDidCreateFiles: jest.fn(),
+  onDidDeleteFiles: jest.fn(),
+  onDidRenameFiles: jest.fn(),
+};
 
 const OverviewRulerLane = {
   Left: null,
-}
+};
 
 const Uri = {
   file: (f) => f,
   parse: jest.fn(),
-}
-const Range = jest.fn()
-const Diagnostic = jest.fn()
-const DiagnosticSeverity = { Error: 0, Warning: 1, Information: 2, Hint: 3 }
+};
+const Range = jest.fn();
+const Diagnostic = jest.fn();
+const DiagnosticSeverity = { Error: 0, Warning: 1, Information: 2, Hint: 3 };
 
 const debug = {
   onDidTerminateDebugSession: jest.fn(),
   startDebugging: jest.fn(),
   registerDebugConfigurationProvider: jest.fn(),
-}
+};
 
 const commands = {
   executeCommand: jest.fn(),
   registerCommand: jest.fn(),
-}
+  registerTextEditorCommand: jest.fn(),
+};
 
-const CodeLens = function CodeLens() {}
+const CodeLens = function CodeLens() {};
 
 export {
   CodeLens,
@@ -67,4 +71,4 @@ export {
   DiagnosticSeverity,
   debug,
   commands,
-}
+};

package.json

@@ -69,7 +69,8 @@
           "description": "Automatically start Jest for this project",
           "type": "boolean",
           "default": true,
-          "scope": "resource"
+          "scope": "resource",
+          "markdownDeprecationMessage": "**Deprecated**: please use `#jest.autoRun#` instead."
         },
         "jest.jestCommandLine": {
           "description": "The command line to start jest tests. It should be the same command line users run jest tests from a terminal/shell, with ability to append extra arguments (by the extension at runtime)",
@@ -80,13 +81,15 @@
           "description": "(deprecated) The path to the Jest binary, or an npm command to run tests suffixed with `--` e.g. `node_modules/.bin/jest` or `npm test --`",
           "type": "string",
           "default": null,
-          "scope": "resource"
+          "scope": "resource",
+          "markdownDeprecationMessage": "**Deprecated**: please use `#jest.jestCommandLine#` instead."
         },
         "jest.pathToConfig": {
           "description": "(deprecated) The path to your Jest configuration file",
           "type": "string",
           "default": "",
-          "scope": "resource"
+          "scope": "resource",
+          "markdownDeprecationMessage": "**Deprecated**: please use `#jest.jestCommandLine#` instead."
         },
         "jest.rootPath": {
           "description": "The path to your frontend src folder",
@@ -98,7 +101,8 @@
           "description": "Whether errors should be reported inline on a file",
           "type": "boolean",
           "default": false,
-          "scope": "resource"
+          "scope": "resource",
+          "markdownDeprecationMessage": "**Deprecated**: in favor of vscode hovering message"
         },
         "jest.enableSnapshotUpdateMessages": {
           "description": "Whether snapshot update messages should show",
@@ -110,7 +114,8 @@
           "description": "Run all tests before starting Jest in watch mode",
           "type": "boolean",
           "default": true,
-          "scope": "resource"
+          "scope": "resource",
+          "markdownDeprecationMessage": "**Deprecated**: in favor of `#jest.autoRun#`"
         },
         "jest.showCoverageOnLoad": {
           "description": "Show code coverage when extension starts (if collected)",
@@ -129,8 +134,9 @@
           "scope": "resource"
         },
         "jest.coverageColors": {
-          "description": "Coverage indicator color override",
+          "markdownDescription": "Coverage indicator color override. See [Coverage Colors](https://github.com/jest-community/vscode-jest/blob/master/README.md#coverageColors) for details and examples",
           "type": "object",
+          "default": null,
           "scope": "resource"
         },
         "jest.enableCodeLens": {
@@ -166,7 +172,8 @@
           "description": "Restart Jest runner after updating the snapshots",
           "type": "boolean",
           "default": false,
-          "scope": "resource"
+          "scope": "resource",
+          "markdownDeprecationMessage": "**Deprecated**: no need to restart jest after snapshot update"
         },
         "jest.debugMode": {
           "description": "Enable debug mode to diagnose plugin issues. (see developer console)",
@@ -180,29 +187,110 @@
           "items": "string",
           "default": [],
           "scope": "window"
+        },
+        "jest.autoRun": {
+          "markdownDescription": "Control when jest should run (changed) tests. It supports multiple models, such as fully automated, fully manual and onSave... See [AutoRun](https://github.com/jest-community/vscode-jest/blob/master/README.md#how-to-trigger-the-test-run) for details and examples",
+          "type": "object",
+          "default": null,
+          "scope": "resource"
         }
       }
     },
     "commands": [
       {
         "command": "io.orta.jest.start",
-        "title": "Jest: Start Runner"
+        "title": "Jest: Start All Runners"
       },
       {
         "command": "io.orta.jest.stop",
-        "title": "Jest: Stop Runner"
+        "title": "Jest: Stop All Runners"
+      },
+      {
+        "command": "io.orta.jest.toggle-coverage",
+        "title": "Jest: Toggle Coverage"
+      },
+      {
+        "command": "io.orta.jest.workspace.start",
+        "title": "Jest: Start Runner (Select Workspace)"
+      },
+      {
+        "command": "io.orta.jest.workspace.stop",
+        "title": "Jest: Stop Runner (Select Workspace)"
+      },
+      {
+        "command": "io.orta.jest.workspace.toggle-coverage",
+        "title": "Jest: Toggle Coverage (Select Workspace)"
+      },
+      {
+        "command": "io.orta.jest.workspace.run-all-tests",
+        "title": "Jest: Run All Tests (Select Workspace)"
+      },
+      {
+        "command": "io.orta.jest.run-all-tests",
+        "title": "Jest: Run All Tests"
       },
       {
-        "command": "io.orta.jest.restart",
-        "title": "Jest: Restart Runner"
+        "command": "io.orta.jest.editor.workspace.run-all-tests",
+        "title": "Jest: Run All Tests in Current Workspace"
       },
       {
-        "command": "io.orta.jest.show-channel",
-        "title": "Jest: Show Test Output Channel"
+        "command": "io.orta.jest.editor.run-all-tests",
+        "title": "Jest: Run Related Tests"
       },
       {
-        "command": "io.orta.jest.coverage.toggle",
-        "title": "Jest: Toggle Coverage Overlay"
+        "command": "io.orta.jest.editor.workspace.toggle-coverage",
+        "title": "Jest: Toggle Coverage for Current Workspace"
+      }
+    ],
+    "menus": {
+      "commandPalette": [
+        {
+          "command": "io.orta.jest.workspace.start",
+          "when": "workspaceFolderCount > 1"
+        },
+        {
+          "command": "io.orta.jest.workspace.stop",
+          "when": "workspaceFolderCount > 1"
+        },
+        {
+          "command": "io.orta.jest.workspace.toggle-coverage",
+          "when": "workspaceFolderCount > 1"
+        },
+        {
+          "command": "io.orta.jest.editor.workspace.toggle-coverage",
+          "when": "workspaceFolderCount > 1"
+        },
+        {
+          "command": "io.orta.jest.workspace.run-all-tests",
+          "when": "jest:run.interactive && workspaceFolderCount > 1"
+        },
+        {
+          "command": "io.orta.jest.run-all-tests",
+          "when": "jest:run.interactive"
+        },
+        {
+          "command": "io.orta.jest.editor.workspace.run-all-tests",
+          "when": "jest:run.interactive && workspaceFolderCount > 1"
+        },
+        {
+          "command": "io.orta.jest.editor.run-all-tests",
+          "when": "jest:never"
+        }
+      ],
+      "editor/context": [
+        {
+          "when": "jest:run.interactive && editorLangId =~ /(javascript|javascriptreact|typescript|typescriptreact)/ ",
+          "command": "io.orta.jest.editor.run-all-tests",
+          "group": "Jest"
+        }
+      ]
+    },
+    "keybindings": [
+      {
+        "command": "io.orta.jest.editor.run-all-tests",
+        "key": "ctrl+t",
+        "mac": "cmd+t",
+        "when": "jest:run.interactive && editorLangId =~ /(javascript|javascriptreact|typescript|typescriptreact)/ "
       }
     ],
     "debuggers": [
@@ -287,12 +375,13 @@
     "watch": "webpack --mode development --watch --info-verbosity verbose",
     "lint": "eslint \"src/**/*.ts\" \"tests/**/*.ts\" \"*.json\"  \"*.js\" ",
     "test": "jest",
-    "watch-test": "yarn test -- --watch"
+    "watch-test": "yarn test -- --watch",
+    "tsc": "tsc --noEmit"
   },
   "dependencies": {
     "istanbul-lib-coverage": "^3.0.0",
     "istanbul-lib-source-maps": "^4.0.0",
-    "jest-editor-support": "^28.1.0",
+    "jest-editor-support": "^28.2.0",
     "jest-snapshot": "^25.5.0",
     "vscode-codicons": "^0.0.4"
   },
@@ -318,9 +407,9 @@
     "prettier": "^2.2.1",
     "raw-loader": "^4.0.1",
     "rimraf": "^3.0.2",
-    "ts-jest": "^26.4.4",
+    "ts-jest": "^26.5.2",
     "ts-loader": "^7.0.1",
-    "typescript": "^4.1.2",
+    "typescript": "^4.2.2",
     "vscode-test": "^1.3.0",
     "webpack": "^4.43.0",
     "webpack-cli": "^3.3.11"

src/DebugCodeLens/DebugCodeLens.ts

@@ -3,7 +3,6 @@ import { TestIdentifier } from '../TestResults';
 
 export type DebugTestIdentifier = string | TestIdentifier;
 export class DebugCodeLens extends vscode.CodeLens {
-  readonly fileName: string;
   readonly testIds: DebugTestIdentifier[];
   readonly document: vscode.TextDocument;
 
@@ -19,12 +18,10 @@ export class DebugCodeLens extends vscode.CodeLens {
   constructor(
     document: vscode.TextDocument,
     range: vscode.Range,
-    fileName: string,
     ...testIds: DebugTestIdentifier[]
   ) {
     super(range);
     this.document = document;
-    this.fileName = fileName;
     this.testIds = testIds;
   }
 }

src/DebugCodeLens/DebugCodeLensProvider.ts

@@ -1,6 +1,5 @@
 import * as vscode from 'vscode';
 import { extensionName } from '../appGlobals';
-import { basename } from 'path';
 import { DebugCodeLens } from './DebugCodeLens';
 import { TestReconciliationStateType } from '../TestResults';
 import { TestState, TestStateByTestReconciliationState } from './TestState';
@@ -31,6 +30,10 @@ export class DebugCodeLensProvider implements vscode.CodeLensProvider {
   }
 
   provideCodeLenses(document: vscode.TextDocument, _: vscode.CancellationToken): DebugCodeLens[] {
+    if (document.isDirty) {
+      return [];
+    }
+
     const result: DebugCodeLens[] = [];
     const ext = this.getJestExt(document.uri);
     if (!ext || this._showWhenTestStateIn.length === 0 || document.isUntitled) {
@@ -39,7 +42,9 @@ export class DebugCodeLensProvider implements vscode.CodeLensProvider {
 
     const filePath = document.fileName;
     const testResults = ext.testResultProvider.getResults(filePath);
-    const fileName = basename(document.fileName);
+    if (!testResults) {
+      return result;
+    }
 
     for (const test of testResults) {
       const results = test.multiResults ? [test, ...test.multiResults] : [test];
@@ -53,7 +58,7 @@ export class DebugCodeLensProvider implements vscode.CodeLensProvider {
       const end = new vscode.Position(test.end.line, test.start.column + 5);
       const range = new vscode.Range(start, end);
 
-      result.push(new DebugCodeLens(document, range, fileName, ...allIds));
+      result.push(new DebugCodeLens(document, range, ...allIds));
     }
 
     return result;
@@ -70,9 +75,9 @@ export class DebugCodeLensProvider implements vscode.CodeLensProvider {
   ): vscode.ProviderResult<vscode.CodeLens> {
     if (codeLens instanceof DebugCodeLens) {
       codeLens.command = {
-        arguments: [codeLens.document, codeLens.fileName, ...codeLens.testIds],
-        command: `${extensionName}.run-test`,
-        title: codeLens.testIds.length > 1 ? `Debug(${codeLens.testIds.length})` : 'Debug',
+        arguments: [...codeLens.testIds],
+        command: `${extensionName}.editor.debug-tests`,
+        title: codeLens.testIds.length > 1 ? `Debug (${codeLens.testIds.length})` : 'Debug',
       };
     }