Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/doc-detective/doc-detective

Doc Detective is an open-source documentation testing framework that makes it easy to keep your docs accurate and up-to-date.
https://github.com/doc-detective/doc-detective

docs documentation testing testing-framework

Last synced: 3 months ago
JSON representation

Doc Detective is an open-source documentation testing framework that makes it easy to keep your docs accurate and up-to-date.

Awesome Lists containing this project

README 

        
#  Doc Detective: The Documentation Testing Framework



![Current version](https://img.shields.io/github/package-json/v/doc-detective/doc-detective?color=orange)

[![NPM Shield](https://img.shields.io/npm/v/doc-detective)](https://www.npmjs.com/package/doc-detective)

[![Discord Shield](https://img.shields.io/badge/chat-on%20discord-purple)](https://discord.gg/2M7wXEThfF)

[![Docs Shield](https://img.shields.io/badge/docs-doc--detective.com-blue)](https://doc-detective.com)



Doc Detective is doc content testing framework that makes it easy to keep your docs accurate and up-to-date. You write tests, and Doc Detective runs them directly against your product to make sure your docs match your user experience. Whether it’s a UI-based process or a series of API calls, Doc Detective can help you find doc bugs before your users do.



Doc Detective ingests test specifications and text files, parses them for testable actions, then executes those actions in a browser. The results (PASS/FAIL and context) are output as a JSON object so that other pieces of infrastructure can parse and manipulate them as needed.



This project handles test parsing and web-based UI testing---it doesn't support results reporting or notifications. This framework is a part of testing infrastructures and needs to be complemented by other components.



## Components



Doc Detective has multiple components to integrate with your workflows as you need it to:



- Doc Detective (this repo): A standalone tool that enables testing without a separate Node project.

- [Doc Detective Core](https://github.com/doc-detective/doc-detective-core): An NPM package that provides the testing functionality.

- [Doc Detective Docs](https://github.com/doc-detective/doc-detective.github.io): Source files for [doc-detective.com](https://doc-detective.com).



## Install



1. Install prerequisites:



   - [Node.js](https://nodejs.org/) (tested on v18 and v20)



1. In a terminal, install Doc Detective globally:



    ```bash

    npm i -g doc-detective

    ```



    If you don't install Doc Detective globally, you'll be prompted to install the first time you run an `npx` command.



## (Optional) Get sample files



To test a few samples, clone the repo and navigate to the `samples` directory:



```bash

git clone https://github.com/doc-detective/doc-detective.git

cd doc-detective/samples

```



## Run tests



To run your tests, use the `runTests` command:



```bash

npx doc-detective runTests

```



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:



```bash

npx doc-detective runTests --input doc-content-inline-tests.md

```



To customize your test, file type, and directory options, create a `.doc-detective.json` [config](https://doc-detective.com/reference/schemas/config.html) 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.



```bash

npx doc-detective runTests --config .doc-detective.json

```



**Note**: All paths are relative to the current working directory, regardless where the config file is located.



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:



```bash

npx doc-detective runTests --config .doc-detective.json --input tests.spec.json

```



## Check your test coverage



You can check the test coverage of your documentation source files with the `runCoverage` command, specifying the source file or directory of source files with the `--input` argument. Doc Detective identifies potential areas of test coverage with file-format-specific regex, and supports CommonMark syntax natively. If you want to test coverage of a file with different syntax, update your the `fileTypes` object of your [config](https://doc-detective.com/reference/schemas/config.html) file accordingly.



```bash

npx doc-detective runCoverage --config .doc-detective.json --input doc-content.md

```



## Concepts



- [**Test specification**](https://doc-detective.com/reference/schemas/specification.html): A group of tests to run in one or more contexts. Conceptually parallel to a document.

- [**Test**](https://doc-detective.com/reference/schemas/test.html): A sequence of steps to perform. Conceptually parallel to a procedure.

- **Step**: A portion of a test that includes a single action. Conceptually parallel to a step in a procedure.

- **Action**: The task a performed in a step. Doc Detective supports a variety of actions:

  - [**checkLink**](https://doc-detective.com/reference/schemas/checkLink.html): Check if a URL returns an acceptable status code from a GET request.

  - [**find**](https://doc-detective.com/reference/schemas/find.html): Check if an element exists with the specified selector.

  - [**goTo**](https://doc-detective.com/reference/schemas/goTo.html): Navigate to a specified URL.

  - [**httpRequest**](https://doc-detective.com/reference/schemas/httpRequest.html): Perform a generic HTTP request, for example to an API.

  - [**runShell**](https://doc-detective.com/reference/schemas/runShell.html): Perform a native shell command.

  - [**saveScreenshot**](https://doc-detective.com/reference/schemas/saveScreenshot.html): Take a screenshot in PNG format.

  - [**setVariables**](https://doc-detective.com/reference/schemas/setVariables.html): Load environment variables from a `.env` file.

  - [**startRecording**](https://doc-detective.com/reference/schemas/startRecording.html) and [**stopRecording**](https://doc-detective.com/reference/schemas/stopRecording.html): Capture a video of test execution.

  - [**typeKeys**](https://doc-detective.com/reference/schemas/typeKeys.html): Type keys. To type special keys, begin and end the string with `$` and use the special key’s enum. For example, to type the Escape key, enter `$ESCAPE$`.

  - [**wait**](https://doc-detective.com/reference/schemas/wait.html): Pause before performing the next action.

- [**Context**](https://doc-detective.com/reference/schemas/context.html): An application and platforms that support the tests.



## Roadmap



Future updates may include support for the following items:



- Apps: iOS Safari, Android Chrome, native Windows, native macOS, native Linux

- Platforms: iOS, Android

- Commands: `suggestTests` stable release



## Develop



To develop Doc Detective, clone the repo and install dependencies:



```bash

git clone https://github.com/doc-detective/doc-detective.git

cd doc-detective

npm i

```



To run commands, use the same `npx` commands as above.



Make sure you review the [contributions guide](CONTRIBUTIONS.md) before submitting a pull request.



## Contributions



Looking to help out? See our [contributions guide](CONTRIBUTIONS.md) 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.



## License



This project uses the [MIT license](https://github.com/doc-detective/doc-detective/blob/master/LICENSE).