power-assert-renderer-base

What is power-assert-renderer-base?

The power-assert-renderer-base package is a base module for creating custom renderers for power-assert. It provides the foundational utilities and structures needed to build custom assertion renderers that can be used with the power-assert library.

What are power-assert-renderer-base's main functionalities?

Base Renderer Class

This feature allows you to create a custom renderer by extending the BaseRenderer class provided by power-assert-renderer-base. The render method can be overridden to implement custom rendering logic for assertion events.

const BaseRenderer = require('power-assert-renderer-base');

class CustomRenderer extends BaseRenderer {
  constructor() {
    super();
  }

  render(event) {
    // Custom rendering logic
    console.log('Custom rendering:', event);
  }
}

module.exports = CustomRenderer;

Event Handling

This feature demonstrates how to handle different types of events within the custom renderer. By checking the event type, you can implement specific logic for assertion and failure events.

const BaseRenderer = require('power-assert-renderer-base');

class EventHandlingRenderer extends BaseRenderer {
  constructor() {
    super();
  }

  render(event) {
    if (event.type === 'assertion') {
      console.log('Assertion event:', event);
    } else if (event.type === 'failure') {
      console.log('Failure event:', event);
    }
  }
}

module.exports = EventHandlingRenderer;

Other packages similar to power-assert-renderer-base

power-assert

The power-assert package is the main library for assertion-based testing with enhanced output. It provides the core functionality for assertions and integrates with various renderers, including custom ones built with power-assert-renderer-base.

assert

The assert package is a simple assertion library provided by Node.js. While it does not offer the enhanced output and custom rendering capabilities of power-assert-renderer-base, it is a lightweight and straightforward option for basic assertions.

chai

Chai is a popular assertion library that provides a variety of assertion styles (BDD, TDD) and plugins. It offers more flexibility and a richer set of features compared to power-assert-renderer-base, but does not focus on custom rendering of assertion outputs.

README

Provides base class of various power-assert-renderers.

API

Override these methods as necessary.

BaseRenderer.prototype.onStart = function (powerAssertContext) {}

Called once when traversal starts. Argument is the powerAssertContext object under traversal.

BaseRenderer.prototype.onData = function (esNode) {}

Called for each Node of AST in powerAssertContext. Argument is a EsNode object.

BaseRenderer.prototype.onEnd = function () {}

Called once when traversal ends.

INSTALL

$ npm install --save-dev power-assert-renderer-base

AUTHOR

• Takuto Wada

LICENSE

Licensed under the MIT license.