DocTester

This library is used to run code samples in markdown documents as acceptance tests, using simple comment-based assertions. By testing code snippets in documentation, you can have greater confidence that code in your documentation works as advertised.

Installation

npm install doc-tester

If you are using yarn

yarn add doc-tester

Usage

From commandline

node_modules/.bin/doc-tester

options

1. -f (--file)

Path of file to be tested (default: ./README.md).

2. -c (--cleanup)

Setting this to false will not remove the test file generated by parsing the documentation file (default :true).

3. --inspect (--inspect-brk)

Runs tests w/ the node --inspect option, allowing a debugger to be attached (default: false).

4. -o (--output)

Path where generated test file will be written. (default: ./test.js)

From code

import { runTest } from 'doc-tester';
await runTest({
  codeArray: ['add(3,4) // equals: 7;'],
  importsArray: [`import { add } from './add'`]
} /* , options */) // equals: true;

Options

1. testName

Name for the test block. Defaulted to Doc Test.

1. cleanup
2. inspect
3. output