/
schema.json
143 lines (143 loc) · 4.53 KB
/
schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
{
"version": 2,
"title": "Cypress Target",
"description": "Run Cypress for e2e, integration and component testing.",
"type": "object",
"outputCapture": "pipe",
"cli": "nx",
"presets": [
{
"name": "Starting Dev Server",
"keys": ["cypressConfig", "devServerTarget"]
},
{
"name": "Custom Base Url",
"keys": ["cypressConfig", "baseUrl"]
},
{
"name": "Component Testing",
"keys": ["cypressConfig", "devServerTarget", "testingType", "skipServe"]
}
],
"properties": {
"cypressConfig": {
"type": "string",
"description": "The path of the Cypress configuration json file.",
"x-completion-type": "file",
"x-completion-glob": "cypress?(*)@(.js|.ts|.json)"
},
"watch": {
"type": "boolean",
"description": "Recompile and run tests when files change.",
"default": false
},
"tsConfig": {
"type": "string",
"description": "The path of the Cypress tsconfig configuration json file.",
"x-completion-type": "file",
"x-completion-glob": "tsconfig.*.json"
},
"devServerTarget": {
"type": "string",
"description": "Dev server target to run tests against."
},
"headed": {
"type": "boolean",
"description": "Displays the browser instead of running headlessly. Set this to `true` if your run depends on a Chrome extension being loaded.",
"default": false
},
"headless": {
"type": "boolean",
"description": "Hide the browser instead of running headed (default for cypress run).",
"default": false,
"x-deprecated": true
},
"exit": {
"type": "boolean",
"description": "Whether or not the Cypress Test Runner will stay open after running tests in a spec file.",
"default": true
},
"key": {
"type": "string",
"description": "The key cypress should use to run tests in parallel/record the run (CI only)."
},
"record": {
"type": "boolean",
"description": "Whether or not Cypress should record the results of the tests.",
"default": false
},
"parallel": {
"type": "boolean",
"description": "Whether or not Cypress should run its tests in parallel (CI only).",
"default": false
},
"baseUrl": {
"type": "string",
"description": "The address (with the port) which your application is running on."
},
"browser": {
"type": "string",
"description": "The browser to run tests in."
},
"env": {
"type": "object",
"description": "A key-value Pair of environment variables to pass to Cypress runner."
},
"spec": {
"type": "string",
"description": "A comma delimited glob string that is provided to the Cypress runner to specify which spec files to run. i.e. `**examples/**,**actions.spec**`."
},
"copyFiles": {
"type": "string",
"description": "A regex string that is used to choose what additional integration files to copy to the dist folder.",
"x-deprecated": true
},
"ciBuildId": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "A unique identifier for a run to enable grouping or parallelization."
},
"group": {
"type": "string",
"description": "A named group for recorded runs in the Cypress dashboard."
},
"ignoreTestFiles": {
"aliases": ["excludeSpecPattern"],
"type": "string",
"description": "A String or Array of glob patterns used to ignore test files that would otherwise be shown in your list of tests. Cypress uses minimatch with the options: `{dot: true, matchBase: true}`. We suggest using https://globster.xyz to test what files would match."
},
"reporter": {
"type": "string",
"description": "The reporter used during cypress run."
},
"reporterOptions": {
"type": "string",
"description": "The reporter options used. Supported options depend on the reporter."
},
"skipServe": {
"type": "boolean",
"description": "Skip dev-server build.",
"default": false
},
"testingType": {
"type": "string",
"description": "Specify the type of tests to execute.",
"enum": ["component", "e2e"],
"default": "e2e"
},
"tag": {
"type": "string",
"description": "A comma delimited list to identify a run with.",
"aliases": ["t"]
}
},
"additionalProperties": true,
"required": ["cypressConfig"],
"examplesFile": "../../../docs/cypress-examples.md"
}