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

@netflix/x-test

v1.0.1

Published

a simple, tap-compliant test runner for the browser

Downloads

58

Readme

x-test

a simple, tap-compliant test runner for the browser

Spec

  • importable as type="module"
  • is interoperable with TAP Version 14
  • nested sub-tests run in an iframe
  • has a recognizable testing interface (it, describe, assert)
  • can be used for automated testing
  • can be used to assert coverage goals

Interface

Testing

The following are exposed in the testing interface:

  • test: Creates a sub-test in an iframe based on given src html page.
  • it: The smallest testing unit — can be asynchronous.
  • it.skip: An it whose callback is not run and which will pass.
  • it.only: Skip all other it tests.
  • it.todo: An it whose callback is run and is expected to fail.
  • describe: Simple grouping functionality.
  • describe.skip: Skip all it tests in this group.
  • describe.only: Skip all other describe groups and it tests.
  • describe.todo: Mark all it tests within this group as todo.
  • waitFor: Ensures test registration remains open until given promise settles.
  • assert: Simple assertion call that throws if the boolean input is false-y.
  • coverage: Sets a coverage goal for the given href.

Events

  • x-test-client-ping: root responds (x-test-root-pong, { status: 'started'|'ended' waiting: true|false })
  • x-test-root-pong: response to x-test-client-ping
  • x-test-root-coverage-request: client should respond (x-test-coverage-result)
  • x-test-client-coverage-result: response to x-test-root-coverage-request
  • x-test-root-end: all tests have completed or we bailed out
  • (internal) x-test-root-run: all tests have completed or we bailed out
  • (internal) x-test-suite-coverage: signal to test for coverage on a particular file
  • (internal) x-test-suite-register: registers a new test / describe / it
  • (internal) x-test-suite-ready: signal that test suite is done with registration
  • (internal) x-test-suite-result: marks end of "it" test
  • (internal) x-test-suite-bail: signal to quit test early

Parameters

The following parameters can be passed in via query params on the url:

  • x-test-no-reporter: turns off custom reporting tool ui
  • x-test-run-coverage: turns on coverage reporting**

**See test.js for an example of how to capture coverage information in puppeteer and send it to your test to allow your automated test to fail due to unmet coverage goals.

Execution

Both test and it calls will execute in order**. test calls will boot the given html page in an iframe. Such iframes are run one-at-a-time. All invoked it calls await the completion of previously-invoked it calls.

**This is not the case if you nest it--but that's an anti-pattern anyhow.

Usage with puppeteer

See test.js for an example of how you can use puppeteer to run your app's tests and log the resulting TAP output to the console.

Parsing TAP

There are many TAP formatters. Importantly, as long as you can pipe the TAP output to another program, the output should be interoperable.