doc-detective-common 1.2.4 → 1.2.6
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 +2 -1
- package/src/schemas/checkLink_v2.schema.json +1 -0
- package/src/schemas/config_v2.schema.json +16 -23
- package/src/schemas/find_v2.schema.json +1 -1
- package/src/schemas/httpRequest_v2.schema.json +4 -5
- package/src/schemas/runShell_v2.schema.json +2 -1
- package/src/schemas/spec_v2.schema.json +5 -0
- package/src/schemas/test_v2.schema.json +5 -0
package/package.json
CHANGED
|
@@ -5,23 +5,26 @@
|
|
|
5
5
|
"additionalProperties": false,
|
|
6
6
|
"properties": {
|
|
7
7
|
"input": {
|
|
8
|
+
"default": ".",
|
|
8
9
|
"$ref": "config_v2.schema.json#/definitions/input"
|
|
9
10
|
},
|
|
10
11
|
"output": {
|
|
12
|
+
"default": ".",
|
|
11
13
|
"$ref": "config_v2.schema.json#/definitions/output"
|
|
12
14
|
},
|
|
13
15
|
"recursive": {
|
|
16
|
+
"default": true,
|
|
14
17
|
"$ref": "config_v2.schema.json#/definitions/recursive"
|
|
15
18
|
},
|
|
16
19
|
"envVariables": {
|
|
17
20
|
"description": "Path to a `.env` file to load before performing a Doc Detective operation.",
|
|
18
|
-
"type": "string"
|
|
19
|
-
"default": ""
|
|
21
|
+
"type": "string"
|
|
20
22
|
},
|
|
21
23
|
"runTests": {
|
|
22
24
|
"type": "object",
|
|
23
25
|
"additionalProperties": false,
|
|
24
26
|
"description": "Options for running tests. When running tests, values set here override general configuration options.",
|
|
27
|
+
"default": {},
|
|
25
28
|
"properties": {
|
|
26
29
|
"input": {
|
|
27
30
|
"$ref": "config_v2.schema.json#/definitions/input"
|
|
@@ -45,8 +48,7 @@
|
|
|
45
48
|
]
|
|
46
49
|
}
|
|
47
50
|
}
|
|
48
|
-
]
|
|
49
|
-
"default": ""
|
|
51
|
+
]
|
|
50
52
|
},
|
|
51
53
|
"cleanup": {
|
|
52
54
|
"description": "Path(s) to test specifications to perform after those specified by `input`. Useful for cleaning up testing environments.",
|
|
@@ -64,8 +66,7 @@
|
|
|
64
66
|
]
|
|
65
67
|
}
|
|
66
68
|
}
|
|
67
|
-
]
|
|
68
|
-
"default": ""
|
|
69
|
+
]
|
|
69
70
|
},
|
|
70
71
|
"recursive": {
|
|
71
72
|
"$ref": "config_v2.schema.json#/definitions/recursive"
|
|
@@ -89,13 +90,12 @@
|
|
|
89
90
|
"$ref": "context_v2.schema.json#"
|
|
90
91
|
}
|
|
91
92
|
]
|
|
92
|
-
}
|
|
93
|
-
"default": [{}]
|
|
93
|
+
}
|
|
94
94
|
}
|
|
95
95
|
}
|
|
96
96
|
},
|
|
97
97
|
"runCoverage": {
|
|
98
|
-
"description": "Options for performing test coverage analysis on documentation source files. When performing coveration analysis, values set here override general
|
|
98
|
+
"description": "Options for performing test coverage analysis on documentation source files. When performing coveration analysis, values set here override general configuration options.",
|
|
99
99
|
"type": "object",
|
|
100
100
|
"additionalProperties": false,
|
|
101
101
|
"properties": {
|
|
@@ -154,33 +154,27 @@
|
|
|
154
154
|
},
|
|
155
155
|
"testStartStatementOpen": {
|
|
156
156
|
"description": "Opening of an in-document test start statement.",
|
|
157
|
-
"type": "string"
|
|
158
|
-
"default": ""
|
|
157
|
+
"type": "string"
|
|
159
158
|
},
|
|
160
159
|
"testStartStatementClose": {
|
|
161
160
|
"description": "Close of an in-document test start statement.",
|
|
162
|
-
"type": "string"
|
|
163
|
-
"default": ""
|
|
161
|
+
"type": "string"
|
|
164
162
|
},
|
|
165
163
|
"testIgnoreStatement": {
|
|
166
164
|
"description": "Text for an in-document test ignore statement.",
|
|
167
|
-
"type": "string"
|
|
168
|
-
"default": ""
|
|
165
|
+
"type": "string"
|
|
169
166
|
},
|
|
170
167
|
"testEndStatement": {
|
|
171
168
|
"description": "Text for an in-document test end statement.",
|
|
172
|
-
"type": "string"
|
|
173
|
-
"default": ""
|
|
169
|
+
"type": "string"
|
|
174
170
|
},
|
|
175
171
|
"stepStatementOpen": {
|
|
176
172
|
"description": "Opening of an in-document step statement.",
|
|
177
|
-
"type": "string"
|
|
178
|
-
"default": ""
|
|
173
|
+
"type": "string"
|
|
179
174
|
},
|
|
180
175
|
"stepStatementClose": {
|
|
181
176
|
"description": "Close of an in-document step statement.",
|
|
182
|
-
"type": "string"
|
|
183
|
-
"default": ""
|
|
177
|
+
"type": "string"
|
|
184
178
|
},
|
|
185
179
|
"markup": {
|
|
186
180
|
"description": "Markup types and associated regex patterns to find in documentation source files.",
|
|
@@ -233,8 +227,7 @@
|
|
|
233
227
|
"description": "Options for connecting to external services.",
|
|
234
228
|
"type": "object",
|
|
235
229
|
"additionalProperties": false,
|
|
236
|
-
"properties": {}
|
|
237
|
-
"default": {}
|
|
230
|
+
"properties": {}
|
|
238
231
|
},
|
|
239
232
|
"telemetry": {
|
|
240
233
|
"description": "Options around sending telemetry for Doc Detective usage.",
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"description": "Click the element."
|
|
39
39
|
},
|
|
40
40
|
"typeKeys": {
|
|
41
|
-
"description": "Type keys after finding the element.
|
|
41
|
+
"description": "Type keys after finding the element. Either a string or an object with a `keys` field as defined in [`typeKeys`](/reference/schemas/typeKeys).<br><br>To type in the element, make the element active with the `click` parameter.",
|
|
42
42
|
"oneOf": [
|
|
43
43
|
{
|
|
44
44
|
"type": "string"
|
|
@@ -24,6 +24,7 @@
|
|
|
24
24
|
"transform": ["trim"]
|
|
25
25
|
},
|
|
26
26
|
"statusCodes": {
|
|
27
|
+
"description": "Accepted status codes. If the specified URL returns a code other than what is specified here, the action fails.",
|
|
27
28
|
"type": "array",
|
|
28
29
|
"items": {
|
|
29
30
|
"oneOf": [
|
|
@@ -101,7 +102,8 @@
|
|
|
101
102
|
"description": "jq filter to apply to the response data. If the filter doesn't return a value, the environment variable isn't set.",
|
|
102
103
|
"type": "string"
|
|
103
104
|
}
|
|
104
|
-
}
|
|
105
|
+
},
|
|
106
|
+
"required": ["name", "jqFilter"]
|
|
105
107
|
}
|
|
106
108
|
]
|
|
107
109
|
}
|
|
@@ -138,10 +140,7 @@
|
|
|
138
140
|
"name": "morpheus",
|
|
139
141
|
"job": "leader"
|
|
140
142
|
},
|
|
141
|
-
"statusCodes": [
|
|
142
|
-
200,
|
|
143
|
-
201
|
|
144
|
-
]
|
|
143
|
+
"statusCodes": [200, 201]
|
|
145
144
|
},
|
|
146
145
|
{
|
|
147
146
|
"action": "httpRequest",
|
|
@@ -10,6 +10,10 @@
|
|
|
10
10
|
"type": "string",
|
|
11
11
|
"description": "Description of the test specification."
|
|
12
12
|
},
|
|
13
|
+
"file": {
|
|
14
|
+
"type": "string",
|
|
15
|
+
"description": "Path to the file that the specification is associated with."
|
|
16
|
+
},
|
|
13
17
|
"contexts": {
|
|
14
18
|
"type": "array",
|
|
15
19
|
"description": "Application/platform sets to run tests in. Overrides `contexts` defined at the config-level.",
|
|
@@ -22,6 +26,7 @@
|
|
|
22
26
|
}
|
|
23
27
|
},
|
|
24
28
|
"tests": {
|
|
29
|
+
"description": "[Tests](/reference/schemas/test) to perform.",
|
|
25
30
|
"type": "array",
|
|
26
31
|
"minItems": 1,
|
|
27
32
|
"items": {
|
|
@@ -11,6 +11,10 @@
|
|
|
11
11
|
"type": "string",
|
|
12
12
|
"description": "Description of the test."
|
|
13
13
|
},
|
|
14
|
+
"file": {
|
|
15
|
+
"type": "string",
|
|
16
|
+
"description": "Path to the file that the test is associated with."
|
|
17
|
+
},
|
|
14
18
|
"contexts": {
|
|
15
19
|
"type": "array",
|
|
16
20
|
"description": "Application/platform sets to run the test in. Overrides `contexts` defined at the config-level and spec-level.",
|
|
@@ -23,6 +27,7 @@
|
|
|
23
27
|
}
|
|
24
28
|
},
|
|
25
29
|
"steps": {
|
|
30
|
+
"description": "Actions to perform as part of the test. Performed in the sequence defined. If one or more actions fail, the test fails.",
|
|
26
31
|
"type": "array",
|
|
27
32
|
"minItems": 1,
|
|
28
33
|
"items": {
|