doc-tester
Tests file to keep sample code always work
Last updated 8 months ago by snrai .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install doc-tester 
SYNC missed versions from official npm registry.

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

Current Tags

  • 1.0.1                                ...           latest (8 months ago)

3 Versions

  • 1.0.1                                ...           8 months ago
  • 1.0.0                                ...           8 months ago
  • 0.0.1                                ...           9 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 0
Last Month 5
Dependencies (13)
Dev Dependencies (0)
None
Dependents (1)

Copyright 2014 - 2016 © taobao.org |