Skip to content

pakastin/teston

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Teston

Test runner similar to tape, but with ES6 module support, simpler subtest syntax and nice indentation.

Oh, and Teston is blazing fast, of course! πŸš€

npm PRs Welcome

Installation

You can install the production version via npm.

npm i teston

Or you can install the development version from git, providing it is installed.

git clone https://github.com/testonjs/teston.git

Usage

Teston has an easy to use api, which you should be familiar with if you have ever worked with Mocha.

import t from 'teston';

t('Testing things', (t) => {
  t('Test A', (t) => {
    t.plan(1);
    t.pass('Works!');
  });

  t('Test B', (t) => {
     t.plan(1);
     t.pass('Works!');
  });
});

The output of the above code when passed to Teston would be:

node --experimental-modules test.mjs

 Testing things

  Test A
  βœ”οΈŽ Works!

  Test B
  βœ”οΈŽ Works!

β™₯︎ All tests passed! β™₯︎

API

t

t(description: String, test: Function)

The main function for creating a test. You may also call this function when inside a test, which is called a subtest.

t.plan

t.plan(count: Number)

Define how many tests there will be.

t.pass

t.pass(message: String)

Pass the current test with an optional message which will be logged to the console.

t.fail

t.fail(message: String)

Fail the test, passing a message that will be logged to the console.

t.ok

t.ok(value : Boolean, message : String)

Pass if value is truthy, fail if not.

t.notOk

t.notOk(value : Boolean, message : String)

Pass if value is not truthy, fail if is.

t.equals

alias: t.equal t.equals(a: *, b: *, message: String)

Assert that a and b are equal.

t.deepEqual

alias: t.deepEquals t.deepEquals(a: *, b: *, message: String)

Assert that a and b are deeply equal.

Test

License

MIT