Users in watch mode can now run any test/folder/workspace interactively just like with non-watch mode.

This release introduced debug config v2, which changed how we inject jest runtime information, such as test file and name, to the debug config. Replacing the "behind-the-scene-injection" with a "variable-substitution" model, so no more hidden operations and surprises, the extension will only substitute the jest specific variables present in the config.

A default jest debug config in v2 will look like this:

{
  "type": "node",
  "name": "vscode-jest-tests.v2",
  "request": "launch",
  "program": "${workspaceFolder}/node_modules/.bin/jest",
  "args": [
    "--runInBand",
    "--watchAll=false",
    "--testNamePattern",
    "${jest.testNamePattern}",
    "--runTestsByPath",
    "${jest.testFile}"
  ],
  "cwd": "${workspaceFolder}",
  "console": "integratedTerminal",
  "internalConsoleOptions": "neverOpen",
  "disableOptimisticBPs": true,
  "windows": {
    "program": "${workspaceFolder}/node_modules/jest/bin/jest"
  }
}

Jest like vscode variables, the "${jest.testNamePattern}" and "${jest.testFile}" are jest specific variables and, if present, will be substituted by the extension upon debugging. Note the config name change: "vscode-jest-tests.v2", which signal the extension to use the substitution mode.

This change is backward compatible. All existing config (with "vscode-jest-tests") will continue to function as before.

More info see Debug Config v2

Other features:

• supports vue file testing
• enhanced test output discovery by automatically opening TestExplorer terminal upon launch.
• enhance run/debug tests with quotes in the name.
• update documentations and a few bug fixes.

More details see v4.3.1 release

Test explorer is one of the highly requested feature for this extension. Last year vscode announced the plan for the official test explorer and we have been trying out the new proposed API since. Now the vscode test explorer is live (2021 July release - v1.59), we are excited to release v4.1 and our users can finally tap into this great new UI experience 🎉

Please note, the test explorer is new and some of the features might be missing or imperfect (see How to use test explorer for more details), nevertheless, we will continue to improve it. Please do not hesitate to ask questions or file issues, thanks and have fun!

After longer than expected development, v4 is finally released! 😄

This is a big release packed with changes to address many nagging issues you have been asking for, such as inconsistent test status indicators, high CPU usage, more granular control of the test runner, missing coverage, supporting parameterized tests, mysterious start up failure etc.

Knowing the scope of the changes is significant, while we tried to test it as much as we can, there are probably still some rough edges we have not discovered. If it interrupted your work, our apology! You can either look up on the document below to see if you can find a workaround; or revert to the earlier version. Please do not hesitate to file issues or ask questions in discussions, we will be monitoring them closely and address issues as best we can.

Feel free to read more about the features and migration or come chat with us in the release discussion for general comments or questions about this release.

P.S. We find the new version did made the development of this extension a bit easier (yes, we do eat our own dog food :dog:), hopefully, it will do the same for your project. Happy coding!

No need to manually trigger any test run, all changes will be monitored and related tests will be run accordingly. It is basically running jest with --watch or --watchAll. This is the default mode prior to v4. Example:

• "jest.autoRun": {"watch": true} => will start the jest with the watch flag and leave all tests at "unknown" state until changes are detected.
• "jest.autoRun": {"watch": true, "onStartup": ["all-tests"]} => will start running all tests upon project launch to update overall project test stats, followed by the jest watch for changes.

Allow users to control test run completely either through commands/menu/TestExplorer manually or use vscode's onSave event to automate related test runs:

• fully manual
  • there will be no automatic test run, users will trigger test run by either command or context-menu.
  • Example: "jest.autoRun": "off"
• automatically run tests when test file changed
  • the extension will trigger test run for the given test file upon save.
  • Example: "jest.autoRun": {"watch": false, "onSave": "test-file"}
• automatically run tests when either test or source file changed:
  • the extension will trigger test run for the given test or source file upon save.
  • Example: "jest.autoRun": {"watch": false, "onSave": "test-src-file"}

For parameterized tests, you might see debug codeLens like Debug (2), which indicated there are 2 test candidates can be debugged. In such case, you will be prompted to choose when clicking the debug codeLens. All failed test results will appear in both the hovering message panel and the PROBLEMS area.

By default debug codeLens will appear for failed and unknown tests, to change that and others, please see customization for more details.

In addition to the coverage summary that is shown on the top of the file, each line will be marked by its coverage status according to the coverage formatter configured. There are 3 types of coverage you might see in your source code, distinguished by colors:

• "covered": if the code is covered. Marked as "green" by default.
• "not-covered": if the code is not covered. Marked as "red" by default.
• "partially-covered": Usually this mean the branch (such as if, switch statements) only partially tested. Marked as "yellow" by default.
  • Please note, istanbuljs (the library jest used to generate coverage info) reports switch branch coverage with the first "case" statement instead of the "switch" statement.

You can customize coverage start up behavior, style and colors, see customization for more details.

shows the active workspace has onSave for test file only, and that the workspace stats is out of sync with the code, such as when the source file is changed but the related tests are not run yet.

shows the autoRun will be triggered by either test or source file changes.

for example:

"jest.coverageColors": {
  "uncovered": "rgba(255,99,71, 0.2)",
  "partially-covered": "rgba(255,215,0, 0.2)",
}

the default color scheme below, note the opacity might differ per formatter:

"jest.coverageColors": {
  "covered": "rgba(9, 156, 65, 0.4)",
  "uncovered": "rgba(121, 31, 10, 0.4)",
  "partially-covered": "rgba(235, 198, 52, 0.4)",
}

• Turn off auto run, users need to trigger tests run manually via run commands and menus:

  "jest.autoRun": "off"
  

• Run all the tests in the workspace upon extension startup, followed by jest watch run for subsequent test/src file changes.

  "jest.autoRun": {
    "watch": true,
    "onStartup": ["all-tests"]
  }
  

• Only run tests in the test file when the test file itself changes. It will neither run all tests for the workspace upon startup nor trigger any test run when the source file changes.

  "jest.autoRun": {
     "watch": false,
     "onSave": "test-file"
  }
  

• Like the one above but does run all tests upon extension start up

  "jest.autoRun": {
    "watch": false,
    "onSave": "test-file",
    "onStartup": ["all-tests"]
  }
  

• migration rule from settings prior to v4:

  • if "jest.autoEnabled" = false => manual mode: "jest.autoRun": "off"
  • if "jest.runAllTestsFirst" = false => "jest.autoRun": {"watch": true }
  • if no customization of the 2 settings and no "jest.autoRun" found =>

    "jest.autoRun": {
       "watch": true,
       "onStartup": ["all-tests"]
    }
    

• Plain jest debug config:

  {
    "type": "node",
    "name": "vscode-jest-tests.v2",
    "request": "launch",
    "program": "${workspaceFolder}/node_modules/.bin/jest",
    "args": [
      "--runInBand",
      "--watchAll=false",
      "--testNamePattern",
      "${jest.testNamePattern}",
      "--runTestsByPath",
      "${jest.testFile}"
    ],
    "cwd": "${workspaceFolder}",
    "console": "integratedTerminal",
    "internalConsoleOptions": "neverOpen",
    "disableOptimisticBPs": true,
    "windows": {
      "program": "${workspaceFolder}/node_modules/jest/bin/jest"
    }
  }
  

• Angular users using yarn:

  {
    "type": "node",
    "name": "vscode-jest-tests.v2",
    "request": "launch",
    "runtimeExecutable": "yarn",
    "args": [
      "test",
      "--run-in-band",
      "--watch-all=false",
      "--test-name-pattern",
      "${jest.testNamePattern}",
      "--test-path-pattern",
      "${jest.testFilePattern}"
    ],
    "cwd": "${workspaceFolder}",
    "console": "integratedTerminal",
    "internalConsoleOptions": "neverOpen",
    "disableOptimisticBPs": true
  }
  

This usually means the extension is not able to start jest process for you. First check the TestExplorer Output, Jest OUTPUT channel or developer console to see what is the actual error (see self-diagnosis).

If it is related to the run time environment, such as

env: node: No such file or directory

Most likely the child_process environment is not correctly initialized. There are many possible causes, sometimes restarting vscode will fix it, otherwise feel free to check out a more in-depth explanation/suggestion here.

If you see error about not able to find jest or some other jest related runtime error: if you can run jest from terminal then you can use the "Run Setup Wizard" button in the error panel to help resolving the configuration issue, see Setup Wizard. If jest doesn't even run from the terminal, then please reference jest to set up your jest test environment.

There could be other causes, such as jest test root path is different from the project's, which can be fixed by setting jest.rootPath. Feel free to check out the customization section to manually adjust the extension if needed.

By default the extension will run all tests when it is launched followed by a jest watch process. If you have many resource extensive tests or source files that can trigger many tests when changed, this could be the reason. Check out jest.autoRun to see how you can change and control when and what tests should be run.

If your test file happen to have parameterized tests, i.e. test.each variations, please make sure you have jest version >= 26.5.

If the above did not resolve your issue, please see the self-diagnosis below that could show more insight of why the test and result could not be matched.

If you can execute jest tests on command line but vscode-jest was not running as expected, here is what you can do to find out more information:

• Try configuring the jest.jestCommandLine with yarn test or npm run test --. The extension can auto-config common configurations like create react apps but not custom scripts like CRACO.

• You can see jest process output with either one of the methods:

  • If you uses TestExplorer, you can see color coded jest output from the TestExplorer's Output terminal (the square arrow icon on the top of the Explorer View)
  • Otherwise you can see the output in "OUTPUT" channel, which is usually named after the workspace folder, such as Jest (your-workspace-name). Or you can click on Jest label on status bar to show Jest Output window. This will show you the jest run output and the errors.

• See additional logging from the developer console (via Help > Toggle Developer Tools menu), for example to examine the environment variables passed to jest runner: examine-env.git

• Turn on the debug mode to see more internal debugging message in the developer console:

  • set "jest.debugMode": true in .vscode/settings.json

Hopefully most issues would be pretty obvious after seeing these extra output, and you can probably fix most yourself by customizing the jest.jestCommandLine and others.