@socketsupply/tapzero

Zero dependency test framework

Source code

The implementation is <250 loc, (<500 with comments) ( https://github.com/Raynos/tapzero/blob/master/index.js ) and very readable.

Migrating from tape

const tape = require('tape')
// Tapzero exports an object with a test function property.
const tapzero = require('@socketsupply/tapzero').test

tape('my test', (t) => {
  t.equal(2, 2, 'ok')
  t.end()
})

// Auto ending behavior on function completion
tapzero('my test', (t) => {
  t.equal(2, 2, 'ok')
  // t.end() does not exist.
})

End automatically

Return a promise. The test will end when the promise resolves.

// tapzero "auto" ends async tests when the async function completes
tapzero('my cb test', async (t) => {
  await new Promise((resolve) => {
    t.equal(2, 2, 'ok')
    setTimeout(() => {
      // instead of calling t.end(), resolve a promise
      resolve()
    }, 10)
  })
})

Plan the number of assertions

tapzero('planning example', t => {
  // this test will fail if we execute more or fewer
  //   than planned assertions
  t.plan(2)
  t.ok('hello')
  t.equal(2, 2, 'two is two')
})

API

No aliases, smaller API surface area

tape('my test', (t) => {
  t.equals(2, 2)
  t.is(2, 2)
  t.isEqual(2, 2)
})

tapzero('my test', (t) => {
  // tapzero does not implement any aliases, very small surface area.
  t.equal(2, 2)
  t.equal(2, 2)
  t.equal(2, 2)
})

Motivation

Small library, zero dependencies

$ package-size ./build/src/index.js zora baretest,assert qunit tape jasmine mocha

  package                      size       minified   gzipped
  ./build/src/index.js         8.97 KB    3.92 KB    1.53 KB
  [email protected]                   32.44 KB   11.65 KB   4.08 KB
  [email protected],[email protected]  51.61 KB   16.48 KB   5.82 KB
  [email protected]                  195.83 KB  62.04 KB   20.38 KB
  [email protected]                  304.71 KB  101.46 KB  28.8 KB
  [email protected]                413.61 KB  145.2 KB   41.07 KB
  [email protected]                  811.55 KB  273.07 KB  91.61 KB

Small library, small install size.

	@socketsupply/tapzero	baretest	zora	pta	tape
pkg size
Min.js size
dep count

	Mocha	Ava	Jest	tap
pkg size
Min.js size
dep count

Docs

const test = require('@socketsupply/tapzero').test

test(name, [fn])

Run a single named test case. The fn will be called with the t test object.

Tests run one at a time and complete when the fn completes, the fn can be async.

test.only(name, fn)

Like test(name, fn) except if you use .only this is the only test case that will run for the entire process, all other test cases using tape will be ignored.

test.skip(name, [fn])

Creates a test case that will be skipped

Harness docs

const testHarness = require('@socketsupply/tapzero/harness')

See HARNESS.md