Doc Detective Core

Low-code documentation testing embedded in your project via NPM.

For pre-built implementations, see Doc Detective.

Install

npm i doc-detective-core

Init

const { runTests, runCoverage } = require("doc-detective-core");

Functions

runTests(config)

Run test specifications. Returns a test report object. Takes config as input. Parses paths in the config.input or config.runTests.input for test specifications to perform.

runCoverage(config)

Analyze test coverage in documentation source files. Returns a coverage report object. Takes config as input. Parses paths in the config.input or config.runCoverage.input for documentation source files to analyze. Parses markup based on file's type and the markup definitions specified in config.fileTypes.markup.

suggestTests(config) (Experimental)

Note: This is experimental and subject to change.

Dynamically built tests to address uncovered markup in documentation source files. Returns a suggested test specification. Takes config as input.

Contributions

Looking to help out? See our contributions guide for more info. If you can't contribute code, you can still help by reporting issues, suggesting new features, improving the documentation, or sponsoring the project.