lucono / karma-test-explorer

Visual Studio Code extension for Karma and Angular testing with the Jasmine or Mocha framework

DEPRECATION  NOTICE

With the deprecation of Karma runner, Karma Test Explorer is now also deprecated. It will no longer be releasing any new features or bug fixes.

If you continue to use Karma and this extension, you are encouraged to seek support for any new issues by posting in the Discussions area to possibly get help from other users.

---

Karma Test Explorer (for Angular, Jasmine, and Mocha)

This extension adds a rich and fully integrated testing experience to Visual Studio Code for Angular, TypeScript, and JavaScript projects that use Karma for testing.

It shows your Karma tests in a visual explorer in VS Code, adds code lenses and gutter decorations to your test files, and shows test failure details inline within your code at the point of each failure.

The side bar shows rich information about your tests, including focused ⚡ and disabled 💤 tests (left image), and details summarizing passed, failed and skipped tests after each test execution (right image).

---

Please take a minute to rate this extension in the marketplace and star it on GitHub. For issues, questions, or feature requests, see Reporting Issues.

---

Why this Extension

Karma Test Explorer is a complete rewrite of the deprecated Angular/Karma Test Explorer, and adds various significant enhancements and new features to provide robust support for:

• Cloud and remote development sceanarios with Dev Containers
• Good performance with large projects having many thousands of tests
• Zero-configuration user experience that "just works" for most setups
• Flexibility to support a wide range of testing scenarios and workflows
• Reliability, usability, and productivity

Features

• Rich visual test browsing, execution, and debugging
• Angular, Karma, Jasmine, and Mocha support
• Multi-project / monorepo / multi-root workspace support
• Live test validation of changing product code
• Auto-detection and fix recommendations for various testing issues
• Much more

Quick Start

In many cases, testing should work out of the box:

• Ensure Chrome browser and the project dependencies are installed
• Install the Karma Test Explorer extension and wait a moment while it initializes
• When done, your tests should be displayed in the Testing side bar
• Use the many extension settings to customize it to any other needs of your project
• If you run into any issues, see extension setup for more detailed setup instructions

Documentation

For a more detailed guide on setting up, customizing, and fully leveraging all the available features to work for your project, please see the Karma Test Explorer Documentation.

Acknowledgement

Special thanks to the authors of the deprecated Angular/Karma Test Explorer on which Karma Test Explorer was originally based.

See Also

Documentation  |  Contributing  |  Changelog  |  Report an issue