jasmine-spec-reporter

What is jasmine-spec-reporter?

The jasmine-spec-reporter npm package is a reporter for Jasmine that provides clear and readable output for Jasmine test results. It can be used to enhance the visual output of Jasmine test suites in the console, making it easier to understand test results at a glance.

What are jasmine-spec-reporter's main functionalities?

Spec reporting

This feature allows for real-time reporting of spec results. It can be configured to display various details such as pending specs, stack traces, and durations of specs.

const { SpecReporter } = require('jasmine-spec-reporter');

jasmine.getEnv().clearReporters();
jasmine.getEnv().addReporter(new SpecReporter({
  spec: {
    displayPending: true
  }
}));

Summary reporting

This feature provides a summary of the test results after all specs have been run, including the number of successful, failed, and pending tests. It can be customized to include or exclude the duration of the test run.

const { SpecReporter } = require('jasmine-spec-reporter');

jasmine.getEnv().clearReporters();
jasmine.getEnv().addReporter(new SpecReporter({
  summary: {
    displayDuration: false
  }
}));

Customization

The reporter can be extensively customized to fit the user's needs. Options include toggling the display of stack traces, successful tests, failed tests, and more.

const { SpecReporter } = require('jasmine-spec-reporter');

jasmine.getEnv().clearReporters();
jasmine.getEnv().addReporter(new SpecReporter({
  spec: {
    displayStacktrace: true
  },
  summary: {
    displaySuccessful: false
  }
}));

Other packages similar to jasmine-spec-reporter

mocha

Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple. It offers reporters similar to jasmine-spec-reporter but has its own BDD/TDD interface and is generally more flexible with third-party assertion libraries.

jest

Jest is a delightful JavaScript Testing Framework with a focus on simplicity. It works out of the box for any React project but can be used more broadly. It includes its own set of reporters and has a watch mode that jasmine-spec-reporter does not provide.

karma-jasmine-html-reporter

This reporter is specifically designed to work with the Karma test runner and provides an HTML report of the test results. It's different from jasmine-spec-reporter as it focuses on HTML output rather than console output.

README

jasmine-spec-reporter

Real time console spec reporter for jasmine testing framework.

Usage

Installation

Install jasmine-spec-reporter via npm:

npm install jasmine-spec-reporter --save-dev

Examples

• Jasmine node tests
• Protractor tests
• TypeScript support

Configuration

See full configuration and features: configuration.ts

Custom output

You can customize the output of the reporter yourself: see how.

Development

Requirements

• npm >= 5

Commands

• install dependencies: npm install
• launch unit tests: npm test
• launch integration tests: npm run test:integration

Debugging

Unit tests hijack console.log to verify output; use console.warn to debug.