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:
Run tests
NPX
Docker
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
Docker
If you have test files in multiple directories or want to specify multiple files, enter them separated with commas:
NPX
Docker
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 command, Doc Detective loads the config. Otherwise, you can specify a config path with the --config argument.
NPX
Docker
Note: By default, paths inside a config file resolve relative to the config file’s location, not the current working directory. This is controlled by relativePathBase, which defaults to file; set it to cwd to resolve config paths relative to the current working directory instead. Paths passed on the command line with --input, --output, or --config always resolve relative to the current working directory.
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
Docker
Remotely hosted tests
You can run tests hosted remotely by specifying the URL of the test file with the --input argument. For example, to run tests from a file hosted at https://doc-detective.com/sample.spec.json, run the following command:
NPX
Docker
These tests run the same way as local tests. Doc Detective fetches the test file from the specified URL and stores it in a temporary directory. The URL must be accessible to the machine running the tests.