npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

zora-reporters

v2.0.0

Published

a set of reporter for zora testing library

Downloads

558

Readme

zora-reporters

A set of reporters to programmatically (or via a CLI) consume a stream made of the zora testing protocol.

installation

npm i zora-reporters

zora testing protocol messages

A zora test harness is actually a stream of messages defined by the following interfaces

interface IMessage<T> {
  type: string;
  data: T;
}

interface INewTestMessage extends IMessage<INewTestMessageInput> {
  type: 'TEST_START';
}

interface IAssertionMessage extends IMessage<IAssertionResult<unknown>> {
  type: 'ASSERTION';
}

interface ITestEndMessage extends IMessage<ITestEndMessageInput> {
  type: 'TEST_END';
}

usage

programmatically

create the reporter with a factory which you can then pass to the report function of any test harness (or to the report function of the default test harness)

import {hold, report, test} from 'zora';
import {createDiffReporter} from 'zora-reporters';

hold(); // prevent the default test harness to start its reporting

test(`some test`, (t) => {
    t.ok(true)
});

// create your custom reporter
const reporter = createDiffReporter();

// start reporting
report({reporter});

CLI

Zora testing program will output by default a TAP report, but you can configure it to output the zora testing protocol instead (thanks to the ZORA_REPORTER=json en variable for example).

You can then pipe this output into the zora reporter command line interface:

ZORA_REPORTER=json node path/to/testing/program.js | zr

Options

Synopsis
    Transforms a zora testing protocol message stream into a specific reporting format

Usage
    zr

  Options
    --reporter, -R          One of "tap", "diff"(default).

  Examples
    zr -R tap < some/file.txt
    ZORA_REPORTER=json node zora/program.js | zr -R diff

reporters

TAP (Test Anything Protocol)

tap output example

Diff

The default reporter

default output example