doc-detective 2.16.4 → 2.16.7
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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "doc-detective",
|
|
3
|
-
"version": "2.16.
|
|
3
|
+
"version": "2.16.7",
|
|
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,13 +32,13 @@
|
|
|
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.19.
|
|
36
|
-
"doc-detective-core": "^2.16.
|
|
35
|
+
"doc-detective-common": "^1.19.3",
|
|
36
|
+
"doc-detective-core": "^2.16.7",
|
|
37
37
|
"prompt-sync": "^4.2.0",
|
|
38
38
|
"yargs": "^17.7.2"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"chai": "^5.1.1",
|
|
42
|
-
"mocha": "^10.7.
|
|
42
|
+
"mocha": "^10.7.3"
|
|
43
43
|
}
|
|
44
44
|
}
|
|
@@ -16,13 +16,14 @@
|
|
|
16
16
|
"downloadDirectory": ".",
|
|
17
17
|
"contexts": [
|
|
18
18
|
{
|
|
19
|
-
"app": { "name": "
|
|
20
|
-
"platforms": ["
|
|
19
|
+
"app": { "name": "chrome", "options": { "headless": false } },
|
|
20
|
+
"platforms": ["mac", "linux"]
|
|
21
21
|
},
|
|
22
22
|
{
|
|
23
23
|
"app": { "name": "chrome", "options": { "headless": true } },
|
|
24
|
-
"platforms": ["windows"
|
|
24
|
+
"platforms": ["windows"]
|
|
25
25
|
}
|
|
26
|
+
|
|
26
27
|
]
|
|
27
28
|
},
|
|
28
29
|
"runCoverage": {
|
|
@@ -3,15 +3,13 @@
|
|
|
3
3
|
[comment]: # (test start {"id":"search-kittens"})
|
|
4
4
|
|
|
5
5
|
[Doc Detective documentation](http://doc-detective.com) is split into a few key sections:
|
|
6
|
-
[comment]: # (step {"action":"goTo", "url":"
|
|
6
|
+
[comment]: # (step {"action":"goTo", "url":"https://doc-detective.com"})
|
|
7
7
|
|
|
8
8
|
- The landing page discusses what Doc Detective is, what it does, and who might find it useful.
|
|
9
|
-
- [Get started](https://doc-detective.com/get-started.html) covers how to quickly get up and running with Doc Detective.
|
|
10
|
-
[comment]: # (step {"action":"goTo", "url":"https://doc-detective.com/get-started.html"})
|
|
11
|
-
- The [references](https://doc-detective.com/
|
|
12
|
-
[comment]: # (step {"action":"goTo", "url":"https://doc-detective.com/
|
|
13
|
-
[comment]: # (step {"action":"goTo", "url":"https://doc-detective.com/reference/schemas/config.html"})
|
|
14
|
-
[comment]: # (step {"action":"find", "selector":"h2#description", "matchText":"Description"})
|
|
9
|
+
- [Get started](https://doc-detective.com/docs/get-started.html) covers how to quickly get up and running with Doc Detective.
|
|
10
|
+
[comment]: # (step {"action":"goTo", "url":"https://doc-detective.com/docs/get-started.html"})
|
|
11
|
+
- The [references](https://doc-detective.com/docs/references/schemas/typeKeys) detail the various JSON objects that Doc Detective expects for configs, test specifications, tests, actions, and more. Each object schema includes an object description, field definitions, and examples.
|
|
12
|
+
[comment]: # (step {"action":"goTo", "url":"https://doc-detective.com/docs/references/schemas/typeKeys"})
|
|
15
13
|
[comment]: # (step {"action":"find", "selector":"h2#fields", "matchText":"Fields"})
|
|
16
14
|
[comment]: # (step {"action":"find", "selector":"h2#examples", "matchText":"Examples"})
|
|
17
15
|
|
package/test/runCoverage.test.js
CHANGED
|
@@ -14,7 +14,7 @@ describe("Perform coverage analysis successfully", function () {
|
|
|
14
14
|
);
|
|
15
15
|
const result = require(outputFile);
|
|
16
16
|
fs.unlinkSync(outputFile);
|
|
17
|
-
assert.equal(result.summary.covered,
|
|
17
|
+
assert.equal(result.summary.covered, 7);
|
|
18
18
|
assert.equal(result.summary.uncovered, 0);
|
|
19
19
|
});
|
|
20
20
|
});
|
package/test/runTests.test.js
CHANGED
|
@@ -12,7 +12,10 @@ describe("Run tests sucessfully", function () {
|
|
|
12
12
|
await spawnCommand(
|
|
13
13
|
`node ./src/index.js runTests -c ${artifactPath}/config.json -i ${artifactPath} -o ${outputFile}`
|
|
14
14
|
);
|
|
15
|
+
// Wait until the file is written
|
|
16
|
+
while (!fs.existsSync(outputFile)) {}
|
|
15
17
|
const result = require(outputFile);
|
|
18
|
+
console.log(JSON.stringify(result, null, 2));
|
|
16
19
|
fs.unlinkSync(outputFile);
|
|
17
20
|
assert.equal(result.summary.specs.fail, 0);
|
|
18
21
|
});
|