Skip to content

Releases: jest-community/vscode-jest

v4.2.0 (Oct 9, 2021)

10 Oct 16:47
c5285d9
Compare
Choose a tag to compare
v4.2.0 (Oct 9, 2021) Pre-release
Pre-release

This release mainly enhances TestExplore support and added new settings to help customize shell and node env for jest runner process.

Overview

  • Not-yet-executed tests will have a "runnable" status icon so the test menu is always accessible regardless of autoRun mode. (#773)

  • image

    • This means users can debug tests without using DebugCodeLens, which sometimes could interfere with the editing process. To disable DebugCodeLens, use "jest.debugCodeLens.showWhenTestStateIn": [].
    • The "Run Test" menu will only be shown for interactive mode, i.e. not available for watch mode since the tests are monitored by the external watcher.
  • Two new settings are added to customize jest runner process: (#777)

    • jest.nodeEnv: append additional env to the jest runner process.env
    • jest.shell: allow users to choose which shell to use for jest run instead of the default shell.
  • fixed inline popup started to appear in vscode 1.61 even when showInlineError is false (#773)

  • Added language support for snapshot files (#779)

  • updated README and fixed typo (#768, #769)

  • upgrade internal dependency (#775)

change log: v4.1.2 -> v4.2.0

Contributors 🙏

@Olejec @roottool @Yash-Singh1 @connectdotz

v4.1.2 (Sep 3, 2021)

03 Sep 23:30
a7573b0
Compare
Choose a tag to compare

Another minor release to remove the release messaging. (#763)

v4.1.1 (Aug 24, 2021)

24 Aug 16:18
deac4f4
Compare
Choose a tag to compare

minor release to fix release messaging issue #755

Contributors 🙏

@connectdotz

v4.1.0 (Aug 21, 2021)

21 Aug 18:00
4b88a2d
Compare
Choose a tag to compare

This release is mainly to support the newly available official TestExplore via a new set of vscode.tests api in 1.59 build. This provided a nice test-centric view and a more published UI experience that worked pretty well with the existing engine:

  • all executed tests are visible in test explorer and can be debug from test explorer, in addition to the debug codeLens.
  • In interactive mode, test(s) can be triggered via test explorer as well.
  • users can see native/color-coded jest output via test explorer's terminal output.
  • replaced the custom inlineMessage with testExplorer's , which can be enabled through jest.testExplorer.

settings

This release is backward compatible, all existing settings (other than deprecation of the jest.enableInlineErrorMessages) would work as before, with an additional setting jest.testExplorer to fine-tune the test explorer behavior.

More info see v4.1 with Test Explorer

see CHANGELOG for more details.

Contributors 🙏

@tommy @connectdotz

v4.0.3 (June 13, 2021)

14 Jun 01:57
cb41e37
Compare
Choose a tag to compare

patch release:

  • test result matching will try a few more fallback mechanisms when test output has incorrect information, such as missing ancestor titles (#715) or incorrect locations (windows parameterized tests, #697, #694). The fallback mechanism might still not be able to correctly identify parameterized or non-literal-named tests, in those cases, you can try to wrap the test in a 1-1 describe block with the literal name. Hopefully, the external systems will address the root cause soon.
  • typescript test file .ts with "<>" casting no longer cause parse error. (#706)
  • project with large test files should now able to report the correct test list without warning. (#699)
  • a few other stability improvements.

See CHANGELOG for more details.

Contributors 🙏

@connectdotz

v4.0.2 (May 21, 2021)

21 May 14:31
a802de0
Compare
Choose a tag to compare

patch 4.0.0 for the following issues:

  • windows users not able to debug with codeLens (#694)
  • change context menu "Jest: Run Related Tests" keyboard shortcut to avoid conflict: new keybinding: Ctrl-Alt-t or Ctrl-Option-t (Mac)

Known Issues

  • parameterized tests on Windows, especially for CRA, might not be working at this point due to a known jest issue (jestjs/jest#10413 (comment)). While the fix (jestjs/jest#10871) is scheduled for jest@27, we are working on a workaround to reduce the pain for windows users.

Contributors 🙏

@Agalin @connectdotz @stephtr

v4.0.1 (May 12, 2021)

13 May 01:16
d5a24b8
Compare
Choose a tag to compare

patch 4.0.0 for the following issues:

  • test files lost status and debug decorators for windows users (#694)
  • should not show warning message for projects without any test file (#689)

Contributors 🙏

@connectdotz (special thanks to @dgoemans @obvioussean @macabeus @stephtr who helped diagnose and test the fix)

v4.0.0 (May 9, 2021)

09 May 23:38
90bf0b0
Compare
Choose a tag to compare

This is the official v4 release (finally! 😄)

There are a lot of changes in this release. We will list the major features/changes below, more detail can be found in CHANGELOG

Release Summary

  • move the test status indicators to the gutter so they won't interfere with source code formatting.
  • migrating to the position-based test block <-> test result matching algorithm so we can better support dynamic test names, such as parameterized tests and template literal strings names.
  • fully support parameterized tests, including all syntax variants, and allowing select the specific parameter for debugging. (Please note this requires minimal jest version >= 26.5.0)
  • addressed a few code coverage issues and added color customization "jest.CoverageColor"
  • introduce a "setup wizard" to help people unable to get their test running through this extension.
    • a new command Jest: Setup Extension is added.
  • introduce an "interactive mode", in addition to the default "watch" mode, to control what and when tests should be executed and enable "on-demand" file-based test runs. This should help people with many or resource-intensive tests to avoid the dreaded high CPU due to watcher running the related tests upon changes.
    • A new setting "jest.autoRun" is introduced to control the runner mode. This will supercede "jest.autoEnable" and "jest. runAllTestsFirst". If you have these settings, please consider migrate.
    • New commands and editor context menu are added to facilitate the "on-demand" test run.
    • Enhanced status bar display to show the whole workspace test state. In addition to the "success" and "failure" status, it also shows "unknown" indicating the number of tests that haven't been run yet, especially useful for the interactive mode.
  • introduced the new setting "jest.jestCommandLine" that supercedes jest.pathToJest + jest.pathToConfig, which will be deprecated in the future versions.
  • Removed "Jest: Restart Runner" command. The "Jest: Start Runner" will restart the runner if one is already running.
  • Updated README so the community can better self-help.
  • the internal process management model is rewritten to support the interactive mode and the upcoming vscode test framework.
    • Updating snapshot no longer requires restarting the jest runner, i.e. no need for "jest.restartJestOnSnapshotUpdate"
  • many internal code-base cleanup, refactoring, and modernization to hopefully make future development of this extension easier and more fun 😄

Migration Guide

Required

  • Please ensure your project has jest version >= 26.5.0 if you have, or plan to use, parameterized tests. See "Location for test.each results is always 42,9" (jestjs/jest#10412), which was fixed in [email protected].

Recommanded

  • Migrate to "jest.jestCommandLine" if you have jest.pathToJest or jest.pathToConfig customized.
  • Migrate to "jest.autoRun" if you have customized "jest.autoEnable" or "jest. runAllTestsFirst"

Contributors 🙏

@stephtr, @lordofthelake, @connectdotz, @glentakahashi, @Tymek, @johnnyreilly

v4.0.0-alpha.5 (Apr 4, 2021)

05 Apr 21:05
05d0b56
Compare
Choose a tag to compare
Pre-release

Summary

This release packed a lot of changes that should complete the main v4 (#576) features we aim to deliver :

  • introduced an "interactive-mode" to allow more granular control in when and what tests should be run, in addition to the current default "watch-mode" that relies on the watchman, a.k.a jest --watch. (see how to trigger the test run)
  • introduced a "Setup Wizard" to help people configure the essential settings for this extension if needed. (Setup Wizard)
  • new commands are added for wizard and interactive-mode. (Commands)
  • a new context menu is added for the non-watch mode to trigger the test run on-demand. (Menu)
  • new status bar to show more detailed stats (Status Bar)
  • introduced new settings autoRun to support the new runner model, which should eventually replace many other settings marked "deprecated" (Settings)

Detail see CHANGELOG

Migration Guide (rollup)

  • migrating to new setting jest.autoRun: while the settings are completely backward compatible, it is recommended to migrate to the new setting and stop using the deprecated ones sooner than later.
  • migrating to jest.jestCommandLine, which replaces jest.pathToJest, jest.pathToConfig (v4.0.0-alpha.3)
  • (required) upgrade jest >= 26.5.0 for parametized tests (v4.0.0-alpha.3)

Contributors 🙏

@connectdotz

How to test

you can manually install the plugin by downloading the vscode-jest-4.0.0-alpha.5.vsix below, then follow the vscode instruction: install from vsix. You can always revert to the official version if needed: install-previous-versions.

Due to the scope of the changes, we would really love to have as many people testing it as possible. Please do not hesitate to ask questions or raise issues, we can fast-track them much easier in the alpha stage. You have probably also noticed that we have made significant changes in README, please let us know if you have any suggestion to make it more useful for the community.

v4.0.0-alpha.4 (Feb 13, 2021)

14 Feb 02:18
c175f0d
Compare
Choose a tag to compare
Pre-release

Summary

5th alpha release of v4 (#576). This release mainly contains the following changes:

  • Addressing alpha.3 issues #657 #658
  • Readme update for potential coverage reporting issue.
  • Turn on typescript compiler strict mode for src - prevent future typing related crash.

Detail see CHANGELOG

Contributors 🙏

@connectdotz

How to test

you can manually install the plugin by downloading the vscode-jest-4.0.0-alpha.4.vsix below, then follow the vscode instruction: install from vsix. You can always revert to the official version if needed: install-previous-versions.

There is a lot of new stuff, so we added quite a few debugging messaging to help diagnose problems. if anything didn't do what you expected, please turn on the debug mode and file issues.