- v5.0 (pre-release) (roll-up)
- Main Features
- 1. toggle autoRun and coverage through TestExplorer inline menu
- 2. automate monorepo project setup through "Setup Tool"
- 3. improve test run output with terminal
- 4. deep activation
- 5. enhanced snapshot support
- 6. smarter auto-config for jest command and test debugging
- 7. no more intermittent "command not found" error (auto recovery with login-shell)
- 8. long run monitor
- 9. one-click disable non-jest folder for monorepo project
- 10. autoRun simplification
- 11. supports v8 coverage provider
- 12. supports running unresolved parameterized tests directly
- 13. added auto-completion for jest module methods
- Fixes
- Breaking Changes
- Change log
- Main Features
v5 mainly focuses on addressing performance, stablity and ease of use. The goal is to help new and experienced users fully utilize the extension features to make testing a fun experience.
We have also decided to make TestExplorer a preferred UI outlet instead of our custom UI developed before TestExplorer. For example, we no longer support the inline decorator for test status as TestExplorer provided a much more powerful gutter status/menu.
1 - 4
This allows quick one-click change of autoRun and test-coverage for runtime only. This allow users to change test-run behavior frequently to adapt to different phrases in the development cycle. Hopefully, it also help new users that experiences performance issues to be able to self-help easily.
More details can be found in
Also updated README targeting performance: performance troubleshooting guide and autoRun trade-off consideration.
This expanded setup-tool (renamed from setup wizard) to help convert monorepo projects from single-root to multi-root workspaces and assisting detecting jest.rootPath.
See setup monorepo project guide for more info.
Jest run will be shown in Terminal instead of OUTPUT tab to provide familiar run-in-terminal-like experience. We also fixed a few bugs that prevented the full output to be shown. It should be much easier to investigate when tests fail or not executed.
We will no longer force "reveal" the last run output terminal. The new terminals will only be automatically "revealed" when encountered errors prevented tests to run. Therefore, we are retiring setting "jest.showTerminalOnLaunch"
The extension auto activates (showing "Jest" in status bar and TestExplorer) when it detects jest config files or modules under the project root. For more sophisticated projects that jest root !== project root, they will not be activated automatically even if they set the jest.rootPath. In v5, we will look for jest config files in the whole project tree, except in "node_modules" for performance reason.
For projects do not meet any of the existing activation events, there is now a new activation event for ".vscode-jest" file, an empty marker file, anywhere in the project tree (however, prefer to be in jest root folder).
Snapshot support has moved from codeLens to context menu. Users can update snapshot in any granularity from the context menu:
- in TestExplorer tree view: Update snapshot for the workspace, folder, test file or just a single test.
- in Editor's gutter menu: Update and view snapshot for any given test.
Snapshots are now fully supported for parameterized (test.each) and template-literal named tests.
Snapshot codeLens and related settings are, therefore, retired.
When no customization is found, the extension will do a deep search for test-script/jest-command to auto config jestCommandLine and rootPath.
During debugging, if no custom debug config is found, the extension will generate a default debug config incorporating the jestCommandLine and rootPath.
This should make life easier for projects that used to require customization to work.
(v5.0.3: #953 - @connectdotz) (v5.0.3: #958 - @connectdotz)
On non-windows platforms, vscode sometimes fails to initialize its process env upon starting up, which crashes jest run/debug with "command not found" errors (exit code 127), such as "env: node: No such file or directory" or "/bin/sh: yarn: command not found". This has caused a lot confusion and frustration, therefore, we added the functionality to automatically retry tests with a login shell (instead of the default non-login shell) when detecting the above-mentioned errors.
The extension can auto generate login shell for bash, zsh, and fish. Users can also configure custom login shells by expanding the current "jest.shell" setting, such as: "jest.shell": {"path:": "/bin/bash", "args": ["-l"]}. This will instruct the extension to always use the login shell.
Please note these changes only apply to test runs; you might experience similar issues when debugging tests, as we do not control how the vscode debugger is launched. But fortunately, a similar solution (login shell) will work for debugging as well - by customizing "terminal.integrated.automationProfile.<platform>"; see instruction in intermitten error troubleshooting
(v5.0.0: #874 - @connectdotz) (v5.0.2: #941 - @connectdotz)
In v5 we also added a long-run monitor to be proactive in helping users detect and potential workaround such situation. The threshold setting "jest.monitorLongRun" default is 60 seconds: "jest.monitorLongRun": 60000,
Users can now easily one-click to "disable" the failed folder from the error message window.
- Introducing autoRun short-hand to make setting up autoRun easier
- Change autoRun default to drop running all tests on start-up (this is potentially a breaking change)
The "jest.autoRun" default used to be {"watch": "true", "onStartup": ["all-tests"]}. While this ensure no test would be "missing", it does take a toll for start up performance, especially for projects with many expensive tests. With TestExplorer provided complete test tree view, we believe it should be all right for most users to just starts with {"watch": "true"}, thus the change.
If you already have the "jest.autoRun" in your settings.json file, nothing will change. If you didn't have "jest.autoRun", then you will probably notice a faster start-up, but maybe not all tests are run. Of course users can always run them explicitly or change the setting if desired.
Users with jest coverageProvider v8 should be able to see coverage like with the default babel coverageProvider. Please be mindful that these providers do generate slightly different coverage reports, see facebook/jest#11188 for more details.
For developers prefer running test manually, the initial run usually failed with "no test found" for tests with "dynamic names", such as parameterized tests (test.each) or tests use template-literal string name, until the whole suite or parent block is run.
Now the extension will fallback to the parent block automatically when detecting unresolved dynamic names.
Enhanced IntelliSense to suggest local module path for jest methods, such as jest.mock, jest.unmock, jest.doMock etc.
- add user id/name to output file name to resolve permission conflict in shared computers. (#938)
- support look up debug config from workspace file
.code-workspace. (#937) - address issues that vscode runs occasionally appears to be hanging when the runs already completed. (#926, #927, #932)
- missing runtime error detection and reporting when the run fails to start. (#927)
- Fix quoting test names with special characters (#928)
- fixed incorrect TestExplorer tests passed count (#916)
- fix various dependency alerts
- various document updates
-
Debug and Snapshot-Preview CodeLens are replaced by the gutter context menu The codeLens can sometimes interfering with code formatting during editing and it is not as versatile as the context menu especially for parameterized tests. Therefore, we are removing the codeLens and moving and expanding the functionality into the editor gutter menu instead.
-
The following settings are removed:
"jest.runAllTestsFirst""jest.showTerminalOnLaunch""jest.pathToJest""jest.pathToConfig"- snapshot codeLens
"jest.enableSnapshotUpdateMessages""jest.restartJestOnSnapshotUpdate""jest.enableSnapshotPreviews"
- debug codeLens
"jest.enableCodeLens""jest.debugCodeLens.showWhenTestStateIn"
-
- can not be turned off any more.
- removed the "enable" and "showClassicStatus" attributes. The only valid attribute is "showInlineError".
-
"jest.autoRundefault value has changed. see detail above. -
No auto update (all) snapshots messaging any more, instead users can manually update and view any snapshot tests at any level and any time.