Testit

Extremely basic and minimal unit testing. Finds and runs unit tests as exported functions from files. Includes a simple assert library for simple testing.

npm install @snarechops/testit

By default, specify your tests in files ending with .test.js or .test.ts. Tests are simply exported functions that have a name that starts with test. Tests can be async. A test fails if an error is thrown, otherwise it passes

// some.test.js
import assert from '@snarechops/testit'

function add(a, b){
  return a + b
}

export testAddition() {
  assert.equal(3, add(1,2))
}

export function testSimpleFail() {
  assert.false(true)
}

Run your tests with the following command, or equivalent. Set this to your npm test script for easier execution.

node_modules/.bin/testit

Features

• Tests are simple functions
• Tests fail on thrown error. Use the included assert library, throw errors manually, or use any other preferred assertion library that throws errors
• Tests can be in separate files, folders, or even included in your main source code.
  • Do not put tests in a file that has auto-executing code triggered by importing the file. May result in unexpected behaviour.
• Minimally configurable through package.json
• Will support typescript natively if running with a node environment that loads typescript directly.

Currently NOT supported in the browser. Does not include line numbers in error messages. Does not provide test coverage.

Configuration

Configuration is read from your package.json file but is not required.

  "testit": {
    "pattern": ".*\\.test\\.(?:ts|js)$",
    "exclude": ["node_modules"],
    "prefix": "^test.*"
  }

| Property | Default | Description | |----------|--------------------------|-----------------------------------------------------------------------| | pattern | ".\.test\.(?:ts|js)$" | A regular expression to find your test files | | exclude | ["node_modules"] | An array of regular expressions to be excluded when looking for tests | | prefix | "^test." | The prefix for function names that are considered tests |