doc-detective-common 4.0.0-beta.0-dev.4 → 4.0.0-beta.0-dev.5

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.
Files changed (200) hide show
  1. package/package.json +1 -1
  2. package/.c8rc.json +0 -8
  3. package/.mocharc.yml +0 -1
  4. package/icon.png +0 -0
  5. package/scripts/check-coverage-ratchet.cjs +0 -123
  6. package/scripts/createCjsWrapper.js +0 -25
  7. package/scripts/generateTypes.cjs +0 -54
  8. package/src/detectTests.ts +0 -660
  9. package/src/index.ts +0 -3
  10. package/src/schemas/build/checkLink_v2.schema.json +0 -81
  11. package/src/schemas/build/checkLink_v3.schema.json +0 -92
  12. package/src/schemas/build/click_v3.schema.json +0 -145
  13. package/src/schemas/build/config_v2.schema.json +0 -1079
  14. package/src/schemas/build/config_v3.schema.json +0 -696
  15. package/src/schemas/build/context_v2.schema.json +0 -135
  16. package/src/schemas/build/context_v3.schema.json +0 -229
  17. package/src/schemas/build/dragAndDrop_v3.schema.json +0 -189
  18. package/src/schemas/build/find_v2.schema.json +0 -168
  19. package/src/schemas/build/find_v3.schema.json +0 -214
  20. package/src/schemas/build/goTo_v2.schema.json +0 -63
  21. package/src/schemas/build/goTo_v3.schema.json +0 -257
  22. package/src/schemas/build/httpRequest_v2.schema.json +0 -321
  23. package/src/schemas/build/httpRequest_v3.schema.json +0 -439
  24. package/src/schemas/build/loadCookie_v3.schema.json +0 -138
  25. package/src/schemas/build/loadVariables_v3.schema.json +0 -10
  26. package/src/schemas/build/moveTo_v2.schema.json +0 -99
  27. package/src/schemas/build/openApi_v2.schema.json +0 -76
  28. package/src/schemas/build/openApi_v3.schema.json +0 -161
  29. package/src/schemas/build/record_v3.schema.json +0 -70
  30. package/src/schemas/build/report_v3.schema.json +0 -53
  31. package/src/schemas/build/resolvedTests_v3.schema.json +0 -238
  32. package/src/schemas/build/runCode_v2.schema.json +0 -201
  33. package/src/schemas/build/runCode_v3.schema.json +0 -138
  34. package/src/schemas/build/runShell_v2.schema.json +0 -189
  35. package/src/schemas/build/runShell_v3.schema.json +0 -156
  36. package/src/schemas/build/saveCookie_v3.schema.json +0 -149
  37. package/src/schemas/build/saveScreenshot_v2.schema.json +0 -150
  38. package/src/schemas/build/screenshot_v3.schema.json +0 -250
  39. package/src/schemas/build/setVariables_v2.schema.json +0 -39
  40. package/src/schemas/build/sourceIntegration_v3.schema.json +0 -51
  41. package/src/schemas/build/spec_v2.schema.json +0 -199
  42. package/src/schemas/build/spec_v3.schema.json +0 -213
  43. package/src/schemas/build/startRecording_v2.schema.json +0 -57
  44. package/src/schemas/build/step_v3.schema.json +0 -669
  45. package/src/schemas/build/stopRecord_v3.schema.json +0 -13
  46. package/src/schemas/build/stopRecording_v2.schema.json +0 -33
  47. package/src/schemas/build/test_v2.schema.json +0 -244
  48. package/src/schemas/build/test_v3.schema.json +0 -292
  49. package/src/schemas/build/typeKeys_v2.schema.json +0 -72
  50. package/src/schemas/build/type_v3.schema.json +0 -131
  51. package/src/schemas/build/wait_v2.schema.json +0 -42
  52. package/src/schemas/build/wait_v3.schema.json +0 -37
  53. package/src/schemas/dereferenceSchemas.cjs +0 -208
  54. package/src/schemas/index.ts +0 -6
  55. package/src/schemas/output_schemas/analytics_v1.schema.json +0 -585
  56. package/src/schemas/output_schemas/checkLink_v1.schema.json +0 -42
  57. package/src/schemas/output_schemas/checkLink_v2.schema.json +0 -80
  58. package/src/schemas/output_schemas/checkLink_v3.schema.json +0 -145
  59. package/src/schemas/output_schemas/click_v1.schema.json +0 -60
  60. package/src/schemas/output_schemas/click_v3.schema.json +0 -252
  61. package/src/schemas/output_schemas/config_v2.schema.json +0 -2628
  62. package/src/schemas/output_schemas/config_v3.schema.json +0 -16470
  63. package/src/schemas/output_schemas/context_v2.schema.json +0 -134
  64. package/src/schemas/output_schemas/context_v3.schema.json +0 -374
  65. package/src/schemas/output_schemas/dragAndDrop_v3.schema.json +0 -496
  66. package/src/schemas/output_schemas/endRecord_v3.schema.json +0 -12
  67. package/src/schemas/output_schemas/find_v1.schema.json +0 -171
  68. package/src/schemas/output_schemas/find_v2.schema.json +0 -184
  69. package/src/schemas/output_schemas/find_v3.schema.json +0 -1349
  70. package/src/schemas/output_schemas/goTo_v1.schema.json +0 -30
  71. package/src/schemas/output_schemas/goTo_v2.schema.json +0 -62
  72. package/src/schemas/output_schemas/goTo_v3.schema.json +0 -419
  73. package/src/schemas/output_schemas/httpRequest_v1.schema.json +0 -115
  74. package/src/schemas/output_schemas/httpRequest_v2.schema.json +0 -392
  75. package/src/schemas/output_schemas/httpRequest_v3.schema.json +0 -994
  76. package/src/schemas/output_schemas/loadCookie_v3.schema.json +0 -228
  77. package/src/schemas/output_schemas/loadVariables_v3.schema.json +0 -9
  78. package/src/schemas/output_schemas/matchText_v1.schema.json +0 -32
  79. package/src/schemas/output_schemas/moveMouse_v1.schema.json +0 -60
  80. package/src/schemas/output_schemas/moveTo_v2.schema.json +0 -98
  81. package/src/schemas/output_schemas/openApi_v2.schema.json +0 -75
  82. package/src/schemas/output_schemas/openApi_v3.schema.json +0 -162
  83. package/src/schemas/output_schemas/record_v3.schema.json +0 -101
  84. package/src/schemas/output_schemas/report_v3.schema.json +0 -16826
  85. package/src/schemas/output_schemas/resolvedTests_v3.schema.json +0 -33331
  86. package/src/schemas/output_schemas/runCode_v2.schema.json +0 -200
  87. package/src/schemas/output_schemas/runCode_v3.schema.json +0 -222
  88. package/src/schemas/output_schemas/runShell_v1.schema.json +0 -35
  89. package/src/schemas/output_schemas/runShell_v2.schema.json +0 -188
  90. package/src/schemas/output_schemas/runShell_v3.schema.json +0 -236
  91. package/src/schemas/output_schemas/saveCookie_v3.schema.json +0 -245
  92. package/src/schemas/output_schemas/saveScreenshot_v2.schema.json +0 -149
  93. package/src/schemas/output_schemas/screenshot_v1.schema.json +0 -48
  94. package/src/schemas/output_schemas/screenshot_v3.schema.json +0 -681
  95. package/src/schemas/output_schemas/scroll_v1.schema.json +0 -50
  96. package/src/schemas/output_schemas/setVariables_v2.schema.json +0 -38
  97. package/src/schemas/output_schemas/sourceIntegration_v3.schema.json +0 -50
  98. package/src/schemas/output_schemas/spec_v2.schema.json +0 -2301
  99. package/src/schemas/output_schemas/spec_v3.schema.json +0 -16630
  100. package/src/schemas/output_schemas/startRecording_v1.schema.json +0 -55
  101. package/src/schemas/output_schemas/startRecording_v2.schema.json +0 -56
  102. package/src/schemas/output_schemas/step_v3.schema.json +0 -7317
  103. package/src/schemas/output_schemas/stopRecord_v3.schema.json +0 -12
  104. package/src/schemas/output_schemas/stopRecording_v1.schema.json +0 -20
  105. package/src/schemas/output_schemas/stopRecording_v2.schema.json +0 -32
  106. package/src/schemas/output_schemas/test_v2.schema.json +0 -1903
  107. package/src/schemas/output_schemas/test_v3.schema.json +0 -15863
  108. package/src/schemas/output_schemas/typeKeys_v2.schema.json +0 -71
  109. package/src/schemas/output_schemas/type_v1.schema.json +0 -62
  110. package/src/schemas/output_schemas/type_v3.schema.json +0 -244
  111. package/src/schemas/output_schemas/wait_v1.schema.json +0 -42
  112. package/src/schemas/output_schemas/wait_v2.schema.json +0 -41
  113. package/src/schemas/output_schemas/wait_v3.schema.json +0 -41
  114. package/src/schemas/schemas.json +0 -121331
  115. package/src/schemas/src_schemas/analytics_v1.schema.json +0 -585
  116. package/src/schemas/src_schemas/checkLink_v1.schema.json +0 -42
  117. package/src/schemas/src_schemas/checkLink_v2.schema.json +0 -65
  118. package/src/schemas/src_schemas/checkLink_v3.schema.json +0 -91
  119. package/src/schemas/src_schemas/click_v1.schema.json +0 -60
  120. package/src/schemas/src_schemas/click_v3.schema.json +0 -144
  121. package/src/schemas/src_schemas/config_v2.schema.json +0 -929
  122. package/src/schemas/src_schemas/config_v3.schema.json +0 -633
  123. package/src/schemas/src_schemas/context_v2.schema.json +0 -108
  124. package/src/schemas/src_schemas/context_v3.schema.json +0 -202
  125. package/src/schemas/src_schemas/dragAndDrop_v3.schema.json +0 -185
  126. package/src/schemas/src_schemas/find_v1.schema.json +0 -137
  127. package/src/schemas/src_schemas/find_v2.schema.json +0 -155
  128. package/src/schemas/src_schemas/find_v3.schema.json +0 -210
  129. package/src/schemas/src_schemas/goTo_v1.schema.json +0 -30
  130. package/src/schemas/src_schemas/goTo_v2.schema.json +0 -58
  131. package/src/schemas/src_schemas/goTo_v3.schema.json +0 -232
  132. package/src/schemas/src_schemas/httpRequest_v1.schema.json +0 -115
  133. package/src/schemas/src_schemas/httpRequest_v2.schema.json +0 -284
  134. package/src/schemas/src_schemas/httpRequest_v3.schema.json +0 -402
  135. package/src/schemas/src_schemas/loadCookie_v3.schema.json +0 -113
  136. package/src/schemas/src_schemas/loadVariables_v3.schema.json +0 -9
  137. package/src/schemas/src_schemas/matchText_v1.schema.json +0 -32
  138. package/src/schemas/src_schemas/moveMouse_v1.schema.json +0 -60
  139. package/src/schemas/src_schemas/moveTo_v2.schema.json +0 -89
  140. package/src/schemas/src_schemas/openApi_v2.schema.json +0 -64
  141. package/src/schemas/src_schemas/openApi_v3.schema.json +0 -161
  142. package/src/schemas/src_schemas/record_v3.schema.json +0 -69
  143. package/src/schemas/src_schemas/report_v3.schema.json +0 -52
  144. package/src/schemas/src_schemas/resolvedTests_v3.schema.json +0 -237
  145. package/src/schemas/src_schemas/runCode_v2.schema.json +0 -181
  146. package/src/schemas/src_schemas/runCode_v3.schema.json +0 -137
  147. package/src/schemas/src_schemas/runShell_v1.schema.json +0 -35
  148. package/src/schemas/src_schemas/runShell_v2.schema.json +0 -166
  149. package/src/schemas/src_schemas/runShell_v3.schema.json +0 -155
  150. package/src/schemas/src_schemas/saveCookie_v3.schema.json +0 -124
  151. package/src/schemas/src_schemas/saveScreenshot_v2.schema.json +0 -129
  152. package/src/schemas/src_schemas/screenshot_v1.schema.json +0 -48
  153. package/src/schemas/src_schemas/screenshot_v3.schema.json +0 -249
  154. package/src/schemas/src_schemas/scroll_v1.schema.json +0 -50
  155. package/src/schemas/src_schemas/setVariables_v2.schema.json +0 -38
  156. package/src/schemas/src_schemas/sourceIntegration_v3.schema.json +0 -45
  157. package/src/schemas/src_schemas/spec_v2.schema.json +0 -175
  158. package/src/schemas/src_schemas/spec_v3.schema.json +0 -212
  159. package/src/schemas/src_schemas/startRecording_v1.schema.json +0 -55
  160. package/src/schemas/src_schemas/startRecording_v2.schema.json +0 -54
  161. package/src/schemas/src_schemas/step_v3.schema.json +0 -632
  162. package/src/schemas/src_schemas/stopRecord_v3.schema.json +0 -9
  163. package/src/schemas/src_schemas/stopRecording_v1.schema.json +0 -20
  164. package/src/schemas/src_schemas/stopRecording_v2.schema.json +0 -32
  165. package/src/schemas/src_schemas/test_v2.schema.json +0 -200
  166. package/src/schemas/src_schemas/test_v3.schema.json +0 -268
  167. package/src/schemas/src_schemas/typeKeys_v2.schema.json +0 -63
  168. package/src/schemas/src_schemas/type_v1.schema.json +0 -62
  169. package/src/schemas/src_schemas/type_v3.schema.json +0 -118
  170. package/src/schemas/src_schemas/wait_v1.schema.json +0 -42
  171. package/src/schemas/src_schemas/wait_v2.schema.json +0 -41
  172. package/src/schemas/src_schemas/wait_v3.schema.json +0 -36
  173. package/src/types/generated/checkLink_v3.ts +0 -29
  174. package/src/types/generated/click_v3.ts +0 -17
  175. package/src/types/generated/config_v3.ts +0 -405
  176. package/src/types/generated/context_v3.ts +0 -112
  177. package/src/types/generated/dragAndDrop_v3.ts +0 -39
  178. package/src/types/generated/endRecord_v3.ts +0 -10
  179. package/src/types/generated/find_v3.ts +0 -17
  180. package/src/types/generated/goTo_v3.ts +0 -48
  181. package/src/types/generated/httpRequest_v3.ts +0 -17
  182. package/src/types/generated/loadCookie_v3.ts +0 -17
  183. package/src/types/generated/loadVariables_v3.ts +0 -10
  184. package/src/types/generated/openApi_v3.ts +0 -64
  185. package/src/types/generated/record_v3.ts +0 -34
  186. package/src/types/generated/report_v3.ts +0 -183
  187. package/src/types/generated/resolvedTests_v3.ts +0 -585
  188. package/src/types/generated/runCode_v3.ts +0 -59
  189. package/src/types/generated/runShell_v3.ts +0 -58
  190. package/src/types/generated/saveCookie_v3.ts +0 -17
  191. package/src/types/generated/screenshot_v3.ts +0 -76
  192. package/src/types/generated/sourceIntegration_v3.ts +0 -31
  193. package/src/types/generated/spec_v3.ts +0 -166
  194. package/src/types/generated/step_v3.ts +0 -1288
  195. package/src/types/generated/stopRecord_v3.ts +0 -10
  196. package/src/types/generated/test_v3.ts +0 -3048
  197. package/src/types/generated/type_v3.ts +0 -56
  198. package/src/types/generated/wait_v3.ts +0 -13
  199. package/src/validate.ts +0 -627
  200. package/tsconfig.json +0 -22
@@ -1,1079 +0,0 @@
1
- {
2
- "title": "config",
3
- "description": "Configuration options for Doc Detective operations.",
4
- "type": "object",
5
- "additionalProperties": false,
6
- "properties": {
7
- "defaultCommand": {
8
- "description": "Default command to run when no command is specified.",
9
- "type": "string",
10
- "enum": [
11
- "runTests",
12
- "runCoverage"
13
- ]
14
- },
15
- "input": {
16
- "default": ".",
17
- "$ref": "#/definitions/input"
18
- },
19
- "output": {
20
- "default": ".",
21
- "$ref": "#/definitions/output"
22
- },
23
- "recursive": {
24
- "default": true,
25
- "$ref": "#/definitions/recursive"
26
- },
27
- "relativePathBase": {
28
- "description": "Whether paths should be interpreted as relative to the current working directory (`cwd`) or to the file in which they're specified (`file`).",
29
- "type": "string",
30
- "enum": [
31
- "cwd",
32
- "file"
33
- ],
34
- "default": "cwd"
35
- },
36
- "envVariables": {
37
- "description": "Path to a `.env` file to load before performing a Doc Detective operation.",
38
- "type": "string"
39
- },
40
- "runTests": {
41
- "type": "object",
42
- "additionalProperties": false,
43
- "description": "Options for running tests. When running tests, values set here override general configuration options.",
44
- "properties": {
45
- "input": {
46
- "$ref": "#/definitions/input"
47
- },
48
- "output": {
49
- "$ref": "#/definitions/output"
50
- },
51
- "setup": {
52
- "description": "Path(s) to test specifications to perform before those specified by `input`. Useful for setting up testing environments.",
53
- "anyOf": [
54
- {
55
- "type": "string"
56
- },
57
- {
58
- "type": "array",
59
- "items": {
60
- "anyOf": [
61
- {
62
- "type": "string"
63
- }
64
- ]
65
- }
66
- }
67
- ]
68
- },
69
- "cleanup": {
70
- "description": "Path(s) to test specifications to perform after those specified by `input`. Useful for cleaning up testing environments.",
71
- "anyOf": [
72
- {
73
- "type": "string"
74
- },
75
- {
76
- "type": "array",
77
- "items": {
78
- "anyOf": [
79
- {
80
- "type": "string"
81
- }
82
- ]
83
- }
84
- }
85
- ]
86
- },
87
- "recursive": {
88
- "$ref": "#/definitions/recursive"
89
- },
90
- "detectSteps": {
91
- "type": "boolean",
92
- "description": "Whether or not to detect steps in input files based on markup regex.",
93
- "default": false
94
- },
95
- "mediaDirectory": {
96
- "description": "DEPRECATED.",
97
- "type": "string",
98
- "default": "."
99
- },
100
- "downloadDirectory": {
101
- "description": "Path of the directory in which to store downloaded files.",
102
- "type": "string",
103
- "default": "."
104
- },
105
- "contexts": {
106
- "type": "array",
107
- "description": "Application/platform sets to run tests in. If no contexts are specified but a context is required by one or more tests, Doc Detective attempts to identify a supported context in the current environment and run tests against it.",
108
- "items": {
109
- "oneOf": [
110
- {
111
- "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/context_v2.schema.json#"
112
- }
113
- ]
114
- },
115
- "default": [
116
- {
117
- "app": {
118
- "name": "firefox",
119
- "options": {
120
- "width": 1200,
121
- "height": 800,
122
- "headless": true
123
- }
124
- },
125
- "platforms": [
126
- "linux",
127
- "mac",
128
- "windows"
129
- ]
130
- }
131
- ]
132
- }
133
- }
134
- },
135
- "runCoverage": {
136
- "description": "Options for performing test coverage analysis on documentation source files. When performing coveration analysis, values set here override general configuration options.",
137
- "type": "object",
138
- "additionalProperties": false,
139
- "properties": {
140
- "input": {
141
- "$ref": "#/definitions/input"
142
- },
143
- "output": {
144
- "$ref": "#/definitions/output"
145
- },
146
- "recursive": {
147
- "$ref": "#/definitions/recursive"
148
- },
149
- "markup": {
150
- "$ref": "#/definitions/markupToInclude",
151
- "default": [
152
- "onscreenText",
153
- "emphasis",
154
- "image",
155
- "hyperlink",
156
- "codeInline",
157
- "codeBlock",
158
- "interaction"
159
- ]
160
- }
161
- }
162
- },
163
- "suggestTests": {
164
- "description": "Options for suggesting tests based on documentation source files. When suggesting tests, values set here override general condiguration options.",
165
- "type": "object",
166
- "additionalProperties": false,
167
- "properties": {
168
- "input": {
169
- "$ref": "#/definitions/input"
170
- },
171
- "output": {
172
- "$ref": "#/definitions/output"
173
- },
174
- "recursive": {
175
- "$ref": "#/definitions/recursive"
176
- },
177
- "markup": {
178
- "$ref": "#/definitions/markupToInclude",
179
- "default": [
180
- "onscreenText",
181
- "emphasis",
182
- "image",
183
- "hyperlink",
184
- "codeInline",
185
- "codeBlock",
186
- "interaction"
187
- ]
188
- }
189
- }
190
- },
191
- "fileTypes": {
192
- "description": "Information on supported file types and how to parse the markup within them.",
193
- "type": "array",
194
- "items": {
195
- "oneOf": [
196
- {
197
- "type": "object",
198
- "additionalProperties": false,
199
- "properties": {
200
- "name": {
201
- "description": "Name of the file type.",
202
- "type": "string"
203
- },
204
- "extensions": {
205
- "description": "File extensions to support with this configuration.",
206
- "type": "array",
207
- "items": {
208
- "oneOf": [
209
- {
210
- "type": "string"
211
- }
212
- ]
213
- }
214
- },
215
- "testStartStatementOpen": {
216
- "description": "Opening of an in-document test start statement.",
217
- "type": "string"
218
- },
219
- "testStartStatementClose": {
220
- "description": "Close of an in-document test start statement.",
221
- "type": "string"
222
- },
223
- "testIgnoreStatement": {
224
- "description": "Text for an in-document test ignore statement.",
225
- "type": "string"
226
- },
227
- "testEndStatement": {
228
- "description": "Text for an in-document test end statement.",
229
- "type": "string"
230
- },
231
- "stepStatementOpen": {
232
- "description": "Opening of an in-document step statement.",
233
- "type": "string"
234
- },
235
- "stepStatementClose": {
236
- "description": "Close of an in-document step statement.",
237
- "type": "string"
238
- },
239
- "markup": {
240
- "description": "Markup types and associated regex patterns to find in documentation source files.",
241
- "type": "array",
242
- "items": {
243
- "oneOf": [
244
- {
245
- "type": "object",
246
- "additionalProperties": false,
247
- "properties": {
248
- "name": {
249
- "description": "Name of the markup type.",
250
- "type": "string"
251
- },
252
- "regex": {
253
- "description": "Regex patterns to find the markup type in documentation source files.",
254
- "type": "array",
255
- "minItems": 1,
256
- "items": {
257
- "oneOf": [
258
- {
259
- "type": "string"
260
- }
261
- ]
262
- }
263
- },
264
- "actions": {
265
- "description": "Actions that apply to the markup type.",
266
- "type": "array",
267
- "items": {
268
- "oneOf": [
269
- {
270
- "type": "string",
271
- "enum": [
272
- "checkLink",
273
- "find",
274
- "goTo",
275
- "httpRequest",
276
- "runShell",
277
- "saveScreenshot",
278
- "setVariables",
279
- "startRecording",
280
- "stopRecording",
281
- "typeKeys",
282
- "wait"
283
- ]
284
- },
285
- {
286
- "type": "object",
287
- "additionalProperties": false,
288
- "properties": {
289
- "name": {
290
- "description": "Name of the action.",
291
- "type": "string",
292
- "enum": [
293
- "checkLink",
294
- "find",
295
- "goTo",
296
- "httpRequest",
297
- "runShell",
298
- "saveScreenshot",
299
- "setVariables",
300
- "startRecording",
301
- "stopRecording",
302
- "typeKeys",
303
- "wait"
304
- ]
305
- },
306
- "params": {
307
- "description": "Parameters for the action.",
308
- "type": "object",
309
- "additionalProperties": true
310
- }
311
- },
312
- "required": [
313
- "name"
314
- ]
315
- },
316
- {
317
- "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/checkLink_v2.schema.json#"
318
- },
319
- {
320
- "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/find_v2.schema.json#"
321
- },
322
- {
323
- "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/goTo_v2.schema.json#"
324
- },
325
- {
326
- "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/httpRequest_v2.schema.json#"
327
- },
328
- {
329
- "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/runShell_v2.schema.json#"
330
- },
331
- {
332
- "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/saveScreenshot_v2.schema.json#"
333
- },
334
- {
335
- "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/setVariables_v2.schema.json#"
336
- },
337
- {
338
- "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/startRecording_v2.schema.json#"
339
- },
340
- {
341
- "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/stopRecording_v2.schema.json#"
342
- },
343
- {
344
- "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/typeKeys_v2.schema.json#"
345
- },
346
- {
347
- "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/wait_v2.schema.json#"
348
- }
349
- ]
350
- }
351
- }
352
- },
353
- "required": [
354
- "name",
355
- "regex"
356
- ]
357
- }
358
- ]
359
- }
360
- }
361
- },
362
- "required": [
363
- "extensions",
364
- "testStartStatementOpen",
365
- "testStartStatementClose",
366
- "testIgnoreStatement",
367
- "testEndStatement",
368
- "stepStatementOpen",
369
- "stepStatementClose",
370
- "markup"
371
- ]
372
- }
373
- ]
374
- },
375
- "default": [
376
- {
377
- "name": "Markdown",
378
- "extensions": [
379
- ".md",
380
- ".markdown",
381
- ".mdx"
382
- ],
383
- "testStartStatementOpen": "[comment]: # (test start",
384
- "testStartStatementClose": ")",
385
- "testIgnoreStatement": "[comment]: # (test ignore)",
386
- "testEndStatement": "[comment]: # (test end)",
387
- "stepStatementOpen": "[comment]: # (step",
388
- "stepStatementClose": ")",
389
- "markup": [
390
- {
391
- "name": "onscreenText",
392
- "regex": [
393
- "\\*\\*.+?\\*\\*"
394
- ],
395
- "actions": [
396
- "find"
397
- ]
398
- },
399
- {
400
- "name": "emphasis",
401
- "regex": [
402
- "(?<!\\*)\\*(?!\\*).+?(?<!\\*)\\*(?!\\*)"
403
- ]
404
- },
405
- {
406
- "name": "image",
407
- "regex": [
408
- "!\\[.+?\\]\\(.+?\\)"
409
- ],
410
- "actions": [
411
- "checkLink"
412
- ]
413
- },
414
- {
415
- "name": "hyperlink",
416
- "regex": [
417
- "(?<!!)\\[.+?\\]\\(.+?\\)"
418
- ],
419
- "actions": [
420
- "checkLink"
421
- ]
422
- },
423
- {
424
- "name": "navigationLink",
425
- "regex": [
426
- "(?:[Cc]hose|[Oo]pen|[Cc]lick|[Nn]avigate to|[Gg]o to)(?<!!)\\[.+?\\]\\(.+?\\)"
427
- ],
428
- "actions": [
429
- "goTo"
430
- ]
431
- },
432
- {
433
- "name": "orderedList",
434
- "regex": [
435
- "(?<=\n) *?[0-9][0-9]?[0-9]?.\\s*.*"
436
- ]
437
- },
438
- {
439
- "name": "unorderedList",
440
- "regex": [
441
- "(?<=\n) *?\\*.\\s*.*",
442
- "(?<=\n) *?-.\\s*.*"
443
- ]
444
- },
445
- {
446
- "name": "codeInline",
447
- "regex": [
448
- "(?<!`)`(?!`).+?(?<!`)`(?!`)"
449
- ]
450
- },
451
- {
452
- "name": "interaction",
453
- "regex": [
454
- "[cC]lick",
455
- "[tT]ap",
456
- "[tT]ouch",
457
- "[sS]elect",
458
- "[cC]hoose",
459
- "[tT]oggle",
460
- "[eE]nable",
461
- "[dD]isable",
462
- "[tT]urn [oO][ff|n]",
463
- "[tT]ype",
464
- "[eE]nter",
465
- "[sS]end",
466
- "[aA]dd",
467
- "[rR]emove",
468
- "[dD]elete",
469
- "[uU]pload",
470
- "[dD]ownload",
471
- "[sS]croll",
472
- "[sS]earch",
473
- "[fF]ilter",
474
- "[sS]ort",
475
- "[cC]opy",
476
- "[pP]aste",
477
- "[cC]ut",
478
- "[rR]eplace",
479
- "[cC]lear",
480
- "[rR]efresh",
481
- "[rR]evert",
482
- "[rR]estore",
483
- "[rR]eset",
484
- "[lL]ogin",
485
- "[lL]ogout",
486
- "[sS]ign [iI]n",
487
- "[sS]ign [oO]ut",
488
- "[sS]ubmit",
489
- "[cC]ancel",
490
- "[cC]lose",
491
- "[aA]ccept",
492
- "[dD]ecline",
493
- "[dD]eny",
494
- "[rR]eject",
495
- "[rR]etry",
496
- "[rR]estart",
497
- "[rR]esume"
498
- ]
499
- }
500
- ]
501
- },
502
- {
503
- "name": "AsciiDoc",
504
- "extensions": [
505
- ".adoc",
506
- ".asciidoc, .asc"
507
- ],
508
- "testStartStatementOpen": "// (test start",
509
- "testStartStatementClose": ")",
510
- "testIgnoreStatement": "// (test ignore)",
511
- "testEndStatement": "// (test end)",
512
- "stepStatementOpen": "// (step",
513
- "stepStatementClose": ")",
514
- "markup": []
515
- },
516
- {
517
- "name": "HTML/XML",
518
- "extensions": [
519
- ".html",
520
- ".htm",
521
- ".xml",
522
- ".xhtml"
523
- ],
524
- "testStartStatementOpen": "<!-- test start",
525
- "testStartStatementClose": "-->",
526
- "testIgnoreStatement": "<!-- test ignore -->",
527
- "testEndStatement": "<!-- test end -->",
528
- "stepStatementOpen": "<!-- step",
529
- "stepStatementClose": "-->",
530
- "markup": []
531
- }
532
- ]
533
- },
534
- "integrations": {
535
- "description": "Options for connecting to external services.",
536
- "type": "object",
537
- "additionalProperties": false,
538
- "properties": {
539
- "openApi": {
540
- "type": "array",
541
- "items": {
542
- "allOf": [
543
- {
544
- "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/openApi_v2.schema.json#"
545
- },
546
- {
547
- "type": "object",
548
- "properties": {
549
- "operationId": {
550
- "type": "null",
551
- "$commment": "Only allow operationId at the step level."
552
- }
553
- },
554
- "required": [
555
- "name",
556
- "descriptionPath"
557
- ]
558
- }
559
- ]
560
- }
561
- }
562
- }
563
- },
564
- "telemetry": {
565
- "description": "Options around sending telemetry for Doc Detective usage.",
566
- "type": "object",
567
- "additionalProperties": false,
568
- "properties": {
569
- "send": {
570
- "description": "If `true`, sends Doc Detective telemetry.",
571
- "type": "boolean",
572
- "default": true
573
- },
574
- "userId": {
575
- "description": "Identifier for the organization, group, or individual running Doc Detective.",
576
- "type": "string"
577
- }
578
- },
579
- "required": [
580
- "send"
581
- ],
582
- "default": {
583
- "send": true
584
- }
585
- },
586
- "logLevel": {
587
- "description": "Amount of detail to output when performing an operation.",
588
- "type": "string",
589
- "enum": [
590
- "silent",
591
- "error",
592
- "warning",
593
- "info",
594
- "debug"
595
- ],
596
- "default": "info"
597
- }
598
- },
599
- "definitions": {
600
- "input": {
601
- "description": "Path(s) to test specifications and documentation source files. May be paths to specific files or to directories to scan for files.",
602
- "anyOf": [
603
- {
604
- "type": "string"
605
- },
606
- {
607
- "type": "array",
608
- "items": {
609
- "anyOf": [
610
- {
611
- "type": "string"
612
- }
613
- ]
614
- }
615
- }
616
- ]
617
- },
618
- "recursive": {
619
- "description": "If `true` searches `input`, `setup`, and `cleanup` paths recursively for test specificaions and source files.",
620
- "type": "boolean"
621
- },
622
- "output": {
623
- "description": "Path of the of the file or directory in which to store the output of Doc Detective commands. If a file path is specified, the output is written to that file. If a file of that name already exists, Doc Detective creates appends an integer to the result file name. If a directory path is specified, the output file name is dependent on the command being run.",
624
- "type": "string",
625
- "default": "."
626
- },
627
- "markupToInclude": {
628
- "description": "Markup types to include when performing this operation. If no markup types are specified, the operation includes all markup types as defined in `fileTypes`.",
629
- "type": "array",
630
- "items": {
631
- "oneOf": [
632
- {
633
- "type": "string"
634
- }
635
- ]
636
- }
637
- }
638
- },
639
- "examples": [
640
- {},
641
- {
642
- "input": ".",
643
- "output": "."
644
- },
645
- {
646
- "defaultCommand": "runTests",
647
- "envVariables": "",
648
- "input": ".",
649
- "output": ".",
650
- "recursive": true,
651
- "logLevel": "info",
652
- "runTests": {
653
- "input": ".",
654
- "output": ".",
655
- "setup": "",
656
- "cleanup": "",
657
- "recursive": true,
658
- "downloadDirectory": ".",
659
- "contexts": [
660
- {
661
- "app": {
662
- "name": "firefox",
663
- "path": ""
664
- },
665
- "platforms": [
666
- "linux",
667
- "mac",
668
- "windows"
669
- ]
670
- }
671
- ]
672
- }
673
- },
674
- {
675
- "integrations": {
676
- "openApi": [
677
- {
678
- "name": "Acme",
679
- "descriptionPath": "https://www.acme.com/openapi.json",
680
- "server": "https://api.acme.com",
681
- "mockResponse": true
682
- }
683
- ]
684
- }
685
- },
686
- {
687
- "envVariables": "",
688
- "input": ".",
689
- "output": ".",
690
- "recursive": true,
691
- "logLevel": "info",
692
- "runTests": {
693
- "input": ".",
694
- "output": ".",
695
- "setup": "",
696
- "cleanup": "",
697
- "recursive": true,
698
- "downloadDirectory": ".",
699
- "contexts": [
700
- {
701
- "app": {
702
- "name": "firefox",
703
- "path": ""
704
- },
705
- "platforms": [
706
- "linux",
707
- "mac",
708
- "windows"
709
- ]
710
- }
711
- ]
712
- },
713
- "runCoverage": {
714
- "recursive": true,
715
- "input": ".",
716
- "output": ".",
717
- "markup": []
718
- },
719
- "fileTypes": [
720
- {
721
- "name": "Markdown",
722
- "extensions": [
723
- ".md",
724
- ".markdown",
725
- ".mdx"
726
- ],
727
- "testStartStatementOpen": "[comment]: # (test start",
728
- "testStartStatementClose": ")",
729
- "testIgnoreStatement": "[comment]: # (test ignore)",
730
- "testEndStatement": "[comment]: # (test end)",
731
- "stepStatementOpen": "[comment]: # (step",
732
- "stepStatementClose": ")",
733
- "markup": [
734
- {
735
- "name": "onscreenText",
736
- "regex": [
737
- "\\*\\*.+?\\*\\*"
738
- ],
739
- "actions": [
740
- "find"
741
- ]
742
- },
743
- {
744
- "name": "emphasis",
745
- "regex": [
746
- "(?<!\\*)\\*(?!\\*).+?(?<!\\*)\\*(?!\\*)"
747
- ]
748
- },
749
- {
750
- "name": "image",
751
- "regex": [
752
- "!\\[.+?\\]\\(.+?\\)"
753
- ],
754
- "actions": [
755
- "checkLink"
756
- ]
757
- },
758
- {
759
- "name": "hyperlink",
760
- "regex": [
761
- "(?<!!)\\[.+?\\]\\(.+?\\)"
762
- ],
763
- "actions": [
764
- "checkLink"
765
- ]
766
- },
767
- {
768
- "name": "navigationLink",
769
- "regex": [
770
- "(?:[Cc]hose|[Oo]pen|[Cc]lick|[Nn]avigate to|[Gg]o to)(?<!!)\\[.+?\\]\\(.+?\\)"
771
- ],
772
- "actions": [
773
- "goTo"
774
- ]
775
- },
776
- {
777
- "name": "orderedList",
778
- "regex": [
779
- "(?<=\n) *?[0-9][0-9]?[0-9]?.\\s*.*"
780
- ]
781
- },
782
- {
783
- "name": "unorderedList",
784
- "regex": [
785
- "(?<=\n) *?\\*.\\s*.*",
786
- "(?<=\n) *?-.\\s*.*"
787
- ]
788
- },
789
- {
790
- "name": "codeInline",
791
- "regex": [
792
- "(?<!`)`(?!`).+?(?<!`)`(?!`)"
793
- ]
794
- },
795
- {
796
- "name": "codeBlock",
797
- "regex": [
798
- "(?=(```))(\\w|\\W)*(?<=```)"
799
- ]
800
- },
801
- {
802
- "name": "interaction",
803
- "regex": [
804
- "[cC]lick",
805
- "[tT]ap",
806
- "[tT]ouch",
807
- "[sS]elect",
808
- "[cC]hoose",
809
- "[tT]oggle",
810
- "[eE]nable",
811
- "[dD]isable",
812
- "[tT]urn [oO][ff|n]",
813
- "[tT]ype",
814
- "[eE]nter",
815
- "[sS]end",
816
- "[aA]dd",
817
- "[rR]emove",
818
- "[dD]elete",
819
- "[uU]pload",
820
- "[dD]ownload",
821
- "[sS]croll",
822
- "[sS]earch",
823
- "[fF]ilter",
824
- "[sS]ort",
825
- "[cC]opy",
826
- "[pP]aste",
827
- "[cC]ut",
828
- "[rR]eplace",
829
- "[cC]lear",
830
- "[rR]efresh",
831
- "[rR]evert",
832
- "[rR]estore",
833
- "[rR]eset",
834
- "[lL]ogin",
835
- "[lL]ogout",
836
- "[sS]ign [iI]n",
837
- "[sS]ign [oO]ut",
838
- "[sS]ubmit",
839
- "[cC]ancel",
840
- "[cC]lose",
841
- "[aA]ccept",
842
- "[dD]ecline",
843
- "[dD]eny",
844
- "[rR]eject",
845
- "[rR]etry",
846
- "[rR]estart",
847
- "[rR]esume"
848
- ]
849
- }
850
- ]
851
- }
852
- ],
853
- "integrations": {},
854
- "telemetry": {
855
- "send": true,
856
- "userId": "Doc Detective"
857
- }
858
- },
859
- {
860
- "envVariables": "",
861
- "input": [
862
- "."
863
- ],
864
- "output": ".",
865
- "recursive": true,
866
- "relativePathBase": "cwd",
867
- "logLevel": "info",
868
- "runTests": {
869
- "input": [
870
- "."
871
- ],
872
- "output": ".",
873
- "setup": [
874
- "."
875
- ],
876
- "cleanup": [
877
- "."
878
- ],
879
- "recursive": true,
880
- "downloadDirectory": ".",
881
- "contexts": [
882
- {
883
- "app": {
884
- "name": "firefox",
885
- "options": {
886
- "width": 1200,
887
- "height": 800,
888
- "headless": true
889
- }
890
- },
891
- "platforms": [
892
- "linux",
893
- "mac",
894
- "windows"
895
- ]
896
- }
897
- ]
898
- },
899
- "runCoverage": {
900
- "recursive": true,
901
- "input": [
902
- "."
903
- ],
904
- "output": ".",
905
- "markup": []
906
- },
907
- "fileTypes": [
908
- {
909
- "name": "Markdown",
910
- "extensions": [
911
- ".md",
912
- ".markdown",
913
- ".mdx"
914
- ],
915
- "testStartStatementOpen": "[comment]: # (test start",
916
- "testStartStatementClose": ")",
917
- "testIgnoreStatement": "[comment]: # (test ignore)",
918
- "testEndStatement": "[comment]: # (test end)",
919
- "stepStatementOpen": "[comment]: # (step",
920
- "stepStatementClose": ")",
921
- "markup": [
922
- {
923
- "name": "onscreenText",
924
- "regex": [
925
- "\\*\\*.+?\\*\\*"
926
- ],
927
- "actions": [
928
- "find"
929
- ]
930
- },
931
- {
932
- "name": "emphasis",
933
- "regex": [
934
- "(?<!\\*)\\*(?!\\*).+?(?<!\\*)\\*(?!\\*)"
935
- ]
936
- },
937
- {
938
- "name": "image",
939
- "regex": [
940
- "!\\[.+?\\]\\(.+?\\)"
941
- ],
942
- "actions": [
943
- "checkLink"
944
- ]
945
- },
946
- {
947
- "name": "hyperlink",
948
- "regex": [
949
- "(?<!!)\\[.+?\\]\\(.+?\\)"
950
- ],
951
- "actions": [
952
- "checkLink"
953
- ]
954
- },
955
- {
956
- "name": "navigationLink",
957
- "regex": [
958
- "(?:[Cc]hose|[Oo]pen|[Cc]lick|[Nn]avigate to|[Gg]o to)(?<!!)\\[.+?\\]\\(.+?\\)"
959
- ],
960
- "actions": [
961
- "goTo"
962
- ]
963
- },
964
- {
965
- "name": "orderedList",
966
- "regex": [
967
- "(?<=\n) *?[0-9][0-9]?[0-9]?.\\s*.*"
968
- ]
969
- },
970
- {
971
- "name": "unorderedList",
972
- "regex": [
973
- "(?<=\n) *?\\*.\\s*.*",
974
- "(?<=\n) *?-.\\s*.*"
975
- ]
976
- },
977
- {
978
- "name": "codeInline",
979
- "regex": [
980
- "(?<!`)`(?!`).+?(?<!`)`(?!`)"
981
- ]
982
- },
983
- {
984
- "name": "codeBlock",
985
- "regex": [
986
- "(?=(```))(\\w|\\W)*(?<=```)"
987
- ]
988
- },
989
- {
990
- "name": "interaction",
991
- "regex": [
992
- "[cC]lick",
993
- "[tT]ap",
994
- "[tT]ouch",
995
- "[sS]elect",
996
- "[cC]hoose",
997
- "[tT]oggle",
998
- "[eE]nable",
999
- "[dD]isable",
1000
- "[tT]urn [oO][ff|n]",
1001
- "[tT]ype",
1002
- "[eE]nter",
1003
- "[sS]end",
1004
- "[aA]dd",
1005
- "[rR]emove",
1006
- "[dD]elete",
1007
- "[uU]pload",
1008
- "[dD]ownload",
1009
- "[sS]croll",
1010
- "[sS]earch",
1011
- "[fF]ilter",
1012
- "[sS]ort",
1013
- "[cC]opy",
1014
- "[pP]aste",
1015
- "[cC]ut",
1016
- "[rR]eplace",
1017
- "[cC]lear",
1018
- "[rR]efresh",
1019
- "[rR]evert",
1020
- "[rR]estore",
1021
- "[rR]eset",
1022
- "[lL]ogin",
1023
- "[lL]ogout",
1024
- "[sS]ign [iI]n",
1025
- "[sS]ign [oO]ut",
1026
- "[sS]ubmit",
1027
- "[cC]ancel",
1028
- "[cC]lose",
1029
- "[aA]ccept",
1030
- "[dD]ecline",
1031
- "[dD]eny",
1032
- "[rR]eject",
1033
- "[rR]etry",
1034
- "[rR]estart",
1035
- "[rR]esume"
1036
- ]
1037
- }
1038
- ]
1039
- },
1040
- {
1041
- "name": "AsciiDoc",
1042
- "extensions": [
1043
- ".adoc",
1044
- ".asciidoc, .asc"
1045
- ],
1046
- "testStartStatementOpen": "// (test start",
1047
- "testStartStatementClose": ")",
1048
- "testIgnoreStatement": "// (test ignore)",
1049
- "testEndStatement": "// (test end)",
1050
- "stepStatementOpen": "// (step",
1051
- "stepStatementClose": ")",
1052
- "markup": []
1053
- },
1054
- {
1055
- "name": "HTML/XML",
1056
- "extensions": [
1057
- ".html",
1058
- ".htm",
1059
- ".xml",
1060
- ".xhtml"
1061
- ],
1062
- "testStartStatementOpen": "<!-- test start",
1063
- "testStartStatementClose": "-->",
1064
- "testIgnoreStatement": "<!-- test ignore -->",
1065
- "testEndStatement": "<!-- test end -->",
1066
- "stepStatementOpen": "<!-- step",
1067
- "stepStatementClose": "-->",
1068
- "markup": []
1069
- }
1070
- ],
1071
- "integrations": {},
1072
- "telemetry": {
1073
- "send": true,
1074
- "userId": "Doc Detective"
1075
- }
1076
- }
1077
- ],
1078
- "$id": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/src_schemas/config_v2.schema.json"
1079
- }