Karma Minimal Reporter

0.1.0 · maintenance · verified Sun Apr 19

The `karma-min-reporter` package offers a minimalist test reporting experience for the Karma test runner, emulating the concise output style found in Mocha's `min` reporter. Currently at version 0.1.0, this plugin is designed for developers who prefer a clean console output during continuous integration or development workflows. Its primary feature is clearing the console before each test run, which is most effective when Karma is configured for `autoWatch: true` and `singleRun: false`. The package differentiates itself by prioritizing visual brevity over verbose logging, aiming to reduce screen clutter and improve focus during active development. Given its low version number and the nature of Karma plugins, it suggests a mature but infrequently updated project, likely in a maintenance state, providing a stable, specific reporting utility without a rapid release cadence.

Common errors

```
Error: Unknown reporter 'min' (did you install it and register it?)
```
cause The `karma-min-reporter` package is either not installed in the project's `node_modules` or Karma cannot locate it.

fix Run `npm install karma-min-reporter --save-dev` (or `yarn add karma-min-reporter --dev`) to install the package. Ensure it's listed in your project's `devDependencies`.
```
My console output is still very cluttered even with 'min' reporter enabled.
```
cause While `karma-min-reporter` cleans test results, Karma's own logging (e.g., browser activity, debug messages) might still be verbose if `logLevel` is not configured correctly.

fix In `karma.conf.js`, explicitly set `logLevel: config.LOG_WARN` or `config.LOG_ERROR` to reduce general Karma output and focus on the reporter's minimalist display.

Warnings

breaking Due to its early version (0.1.0) and potential age, `karma-min-reporter` may have untested or unaddressed compatibility issues with newer major versions of Karma (e.g., Karma 2.x, 3.x, 4.x+). Karma's internal reporter APIs might have undergone changes.
Fix: Consult Karma's official migration guides for breaking changes related to reporter APIs. If issues arise, consider pinning the `karma` dependency to an older version known to be compatible or exploring more actively maintained minimal reporters.
gotcha The primary benefit of `karma-min-reporter`—clearing the console before each test run—is diminished or lost when Karma is run in `singleRun: true` mode. In this mode, tests execute once, and the clear-on-rerun functionality is not observed.
Fix: For the intended 'minimal' experience, configure Karma with `singleRun: false` and `autoWatch: true` in your `karma.conf.js`, or use the command-line flags `--no-single-run --auto-watch`.
gotcha Verbose logging from Karma itself (e.g., browser connection messages, debug output) can override the minimalist output of `karma-min-reporter`. The default `logLevel` might be set too low for a clean display.
Fix: Set `logLevel: config.LOG_WARN` or `logLevel: config.LOG_ERROR` in your `karma.conf.js` to suppress non-essential messages from the Karma test runner.

Install

npm install karma-min-reporter npm
yarn add karma-min-reporter yarn
pnpm add karma-min-reporter pnpm

Imports

N/A (Configuration String)
wrong:
```
import { min } from 'karma-min-reporter';
```
correct:
```
reporters: ['min']
```
Karma reporters are registered and referenced by string name within the `reporters` array in `karma.conf.js`. The package does not export any JavaScript symbols for direct `import` or `require` in application or test code.

Quickstart

Configures `karma.conf.js` to use `karma-min-reporter` and illustrates command-line execution with recommended settings for continuous testing.

module.exports = function(config) {
  config.set({
    frameworks: ['jasmine'], // Example framework, adjust as needed
    files: [
      'src/**/*.js',
      'test/**/*.spec.js'
    ],
    
    // Enable the minimal reporter
    reporters: ['min'],

    // Recommended settings for 'min' reporter's console-clearing feature
    logLevel: config.LOG_WARN,   // Suppress verbose Karma logging (e.g., browser connection)
    autoWatch: true,             // Watch files for changes and re-run tests
    singleRun: false             // Keep Karma running for continuous testing sessions
  });
};

// To install dependencies:
// npm install --save-dev karma karma-min-reporter jasmine-core karma-jasmine

// To run Karma with these settings from the command line:
// karma start --reporters=min --auto-watch --no-single-run

view raw JSON →