Explore sample tests
Use the sample test files provided to experiment with Doc Detective’s capabilities and see how it handles different scenarios.
Get sample files
To get a few samples, view the samples on GitHub or clone the repo and navigate to the samples directory:
git clone https://github.com/doc-detective/doc-detective.git
cd doc-detective/samples
npm i
Run tests
npx doc-detective
By default, Doc Detective scans the current directory for valid tests, but you can specify your test file with the --input argument. For example, to run tests in a file named doc-content-inline-tests.md, run the following command:
npx doc-detective --input doc-content-inline-tests.md
To customize your test, file type, and directory options, create a .doc-detective.json config file. If a .doc-detective.json file exists in the directory when you run the comment, Doc Detective loads the config. Otherwise, you can specify a config path with the --config argument.
npx doc-detective --config .doc-detective.json
Note: All paths are relative to the current working directory, regardless of the config file's location.
You can override config options with command-line arguments. For example, to run tests in a file named tests.spec.json, even if that isn't included in your config, run the following command:
npx doc-detective --config .doc-detective.json --input tests.spec.json