doc-detective 2.18.0-openapi.9 → 2.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -56,7 +56,7 @@ By default, Doc Detective scans the current directory for valid tests, but you c
|
|
|
56
56
|
npx doc-detective runTests --input doc-content-inline-tests.md
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
-
To customize your test, file type, and directory options, create a `.doc-detective.json` [config](https://doc-detective.com/
|
|
59
|
+
To customize your test, file type, and directory options, create a `.doc-detective.json` [config](https://doc-detective.com/docs/references/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.
|
|
60
60
|
|
|
61
61
|
```bash
|
|
62
62
|
npx doc-detective runTests --config .doc-detective.json
|
|
@@ -72,7 +72,7 @@ npx doc-detective runTests --config .doc-detective.json --input tests.spec.json
|
|
|
72
72
|
|
|
73
73
|
## Check your test coverage
|
|
74
74
|
|
|
75
|
-
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
|
|
75
|
+
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 the `fileTypes` object of your [config](https://doc-detective.com/docs/references/schemas/config.html) file accordingly.
|
|
76
76
|
|
|
77
77
|
```bash
|
|
78
78
|
npx doc-detective runCoverage --config .doc-detective.json --input doc-content.md
|
|
@@ -80,21 +80,21 @@ npx doc-detective runCoverage --config .doc-detective.json --input doc-content.m
|
|
|
80
80
|
|
|
81
81
|
## Concepts
|
|
82
82
|
|
|
83
|
-
- [**Test specification**](https://doc-detective.com/
|
|
84
|
-
- [**Test**](https://doc-detective.com/
|
|
83
|
+
- [**Test specification**](https://doc-detective.com/docs/references/schemas/specification.html): A group of tests to run in one or more contexts. Conceptually parallel to a document.
|
|
84
|
+
- [**Test**](https://doc-detective.com/docs/references/schemas/test.html): A sequence of steps to perform. Conceptually parallel to a procedure.
|
|
85
85
|
- **Step**: A portion of a test that includes a single action. Conceptually parallel to a step in a procedure.
|
|
86
86
|
- **Action**: The task a performed in a step. Doc Detective supports a variety of actions:
|
|
87
|
-
- [**checkLink**](https://doc-detective.com/
|
|
88
|
-
- [**find**](https://doc-detective.com/
|
|
89
|
-
- [**goTo**](https://doc-detective.com/
|
|
90
|
-
- [**httpRequest**](https://doc-detective.com/
|
|
91
|
-
- [**runShell**](https://doc-detective.com/
|
|
92
|
-
- [**saveScreenshot**](https://doc-detective.com/
|
|
93
|
-
- [**setVariables**](https://doc-detective.com/
|
|
94
|
-
- [**startRecording**](https://doc-detective.com/
|
|
95
|
-
- [**typeKeys**](https://doc-detective.com/
|
|
96
|
-
- [**wait**](https://doc-detective.com/
|
|
97
|
-
- [**Context**](https://doc-detective.com/
|
|
87
|
+
- [**checkLink**](https://doc-detective.com/docs/references/schemas/checkLink.html): Check if a URL returns an acceptable status code from a GET request.
|
|
88
|
+
- [**find**](https://doc-detective.com/docs/references/schemas/find.html): Check if an element exists with the specified selector.
|
|
89
|
+
- [**goTo**](https://doc-detective.com/docs/references/schemas/goTo.html): Navigate to a specified URL.
|
|
90
|
+
- [**httpRequest**](https://doc-detective.com/docs/references/schemas/httpRequest.html): Perform a generic HTTP request, for example to an API.
|
|
91
|
+
- [**runShell**](https://doc-detective.com/docs/references/schemas/runShell.html): Perform a native shell command.
|
|
92
|
+
- [**saveScreenshot**](https://doc-detective.com/docs/references/schemas/saveScreenshot.html): Take a screenshot in PNG format.
|
|
93
|
+
- [**setVariables**](https://doc-detective.com/docs/references/schemas/setVariables.html): Load environment variables from a `.env` file.
|
|
94
|
+
- [**startRecording**](https://doc-detective.com/docs/references/schemas/startRecording.html) and [**stopRecording**](https://doc-detective.com/docs/references/schemas/stopRecording.html): Capture a video of test execution.
|
|
95
|
+
- [**typeKeys**](https://doc-detective.com/docs/references/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$`.
|
|
96
|
+
- [**wait**](https://doc-detective.com/docs/references/schemas/wait.html): Pause before performing the next action.
|
|
97
|
+
- [**Context**](https://doc-detective.com/docs/references/schemas/context.html): An application and platforms that support the tests.
|
|
98
98
|
|
|
99
99
|
## Roadmap
|
|
100
100
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "doc-detective",
|
|
3
|
-
"version": "2.18.0
|
|
3
|
+
"version": "2.18.0",
|
|
4
4
|
"description": "Treat doc content as testable assertions to validate doc accuracy and product UX.",
|
|
5
5
|
"bin": {
|
|
6
6
|
"doc-detective": "src/index.js"
|
|
@@ -32,8 +32,8 @@
|
|
|
32
32
|
"homepage": "https://github.com/doc-detective/doc-detective#readme",
|
|
33
33
|
"dependencies": {
|
|
34
34
|
"@ffmpeg-installer/ffmpeg": "^1.1.0",
|
|
35
|
-
"doc-detective-common": "^1.21.0
|
|
36
|
-
"doc-detective-core": "^2.18.0
|
|
35
|
+
"doc-detective-common": "^1.21.0",
|
|
36
|
+
"doc-detective-core": "^2.18.0",
|
|
37
37
|
"prompt-sync": "^4.2.0",
|
|
38
38
|
"yargs": "^17.7.2"
|
|
39
39
|
},
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
- The landing page discusses what Doc Detective is, what it does, and who might find it useful.
|
|
6
6
|
|
|
7
|
-
- [Get started](https://doc-detective.com/get-started.html) covers how to quickly get up and running with Doc Detective.
|
|
7
|
+
- [Get started](https://doc-detective.com/docs/get-started.html) covers how to quickly get up and running with Doc Detective.
|
|
8
8
|
|
|
9
|
-
- The [references](https://doc-detective.com/
|
|
9
|
+
- The [references](https://doc-detective.com/docs/category/schemas) detail the various JSON objects that Doc Detective expects for [configs](https://doc-detective.com/docs/references/schemas/config.html), [test specifications](https://doc-detective.com/docs/references/schemas/specification.html), [tests](https://doc-detective.com/docs/references/schemas/test), actions, and more. Open [typeKeys](https://doc-detective.com/docs/references/schemas/typeKeys.html)--or any other schema--and you'll find two sections: **Fields** and **Examples**.
|
|
10
10
|
|
|
11
11
|
|
|
@@ -8,18 +8,17 @@
|
|
|
8
8
|
|
|
9
9
|
- The landing page discusses what Doc Detective is, what it does, and who might find it useful.
|
|
10
10
|
|
|
11
|
-
- [Get started](https://doc-detective.com/get-started.html) covers how to quickly get up and running with Doc Detective.
|
|
11
|
+
- [Get started](https://doc-detective.com/docs/get-started.html) covers how to quickly get up and running with Doc Detective.
|
|
12
12
|
|
|
13
|
-
[comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/get-started.html"})
|
|
13
|
+
[comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/docs/get-started.html"})
|
|
14
14
|
|
|
15
|
-
- The [references](https://doc-detective.com/
|
|
15
|
+
- The [references](https://doc-detective.com/docs/category/schemas) detail the various JSON objects that Doc Detective expects for [configs](https://doc-detective.com/docs/references/schemas/config.html), [test specifications](https://doc-detective.com/docs/references/schemas/specification.html), [tests](https://doc-detective.com/docs/references/schemas/test), actions, and more. Open [typeKeys](https://doc-detective.com/docs/references/schemas/typeKeys.html)--or any other schema--and you'll find two sections: **Fields** and **Examples**.
|
|
16
16
|
|
|
17
|
-
[comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/
|
|
18
|
-
[comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/
|
|
19
|
-
[comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/
|
|
20
|
-
[comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/
|
|
21
|
-
[comment]: # (step {"action":"goTo", "url":"https://doc-detective.com/
|
|
22
|
-
[comment]: # (step {"action":"find", "selector":"h2#description", "matchText":"Description"})
|
|
17
|
+
[comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/docs/category/schemas"})
|
|
18
|
+
[comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/docs/references/schemas/config.html"})
|
|
19
|
+
[comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/docs/references/schemas/specification.html"})
|
|
20
|
+
[comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/docs/references/schemas/test.html"})
|
|
21
|
+
[comment]: # (step {"action":"goTo", "url":"https://doc-detective.com/docs/references/schemas/typeKeys.html"})
|
|
23
22
|
[comment]: # (step {"action":"find", "selector":"h2#fields", "matchText":"Fields"})
|
|
24
23
|
[comment]: # (step {"action":"find", "selector":"h2#examples", "matchText":"Examples"})
|
|
25
24
|
|