-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
project-schema.json
240 lines (240 loc) · 7.22 KB
/
project-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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://nx.dev/reference/project-configuration",
"title": "JSON schema for Nx projects",
"type": "object",
"properties": {
"namedInputs": {
"type": "object",
"description": "Named inputs used by inputs defined in targets",
"additionalProperties": {
"$ref": "#/definitions/inputs"
}
},
"targets": {
"type": "object",
"description": "Configures all the targets which define what tasks you can run against the project",
"additionalProperties": {
"type": "object",
"properties": {
"executor": {
"description": "The function that Nx will invoke when you run this target",
"type": "string"
},
"options": {
"type": "object"
},
"outputs": {
"type": "array",
"items": {
"type": "string"
}
},
"defaultConfiguration": {
"type": "string",
"description": "The name of a configuration to use as the default if a configuration is not provided"
},
"configurations": {
"type": "object",
"description": "provides extra sets of values that will be merged into the options map",
"additionalProperties": {
"type": "object"
}
},
"inputs": {
"$ref": "#/definitions/inputs"
},
"dependsOn": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"projects": {
"oneOf": [
{
"type": "string",
"description": "A project name"
},
{
"type": "array",
"description": "An array of project names",
"items": {
"type": "string"
}
}
]
},
"dependencies": {
"type": "boolean"
},
"target": {
"type": "string",
"description": "The name of the target."
},
"params": {
"type": "string",
"description": "Configuration for params handling.",
"enum": ["ignore", "forward"],
"default": "ignore"
}
},
"oneOf": [
{
"required": ["projects", "target"]
},
{
"required": ["dependencies", "target"]
},
{
"required": ["target"],
"not": {
"anyOf": [
{ "required": ["projects"] },
{ "required": ["dependencies"] }
]
}
}
],
"additionalProperties": false
}
]
}
},
"command": {
"type": "string",
"description": "A shorthand for using the nx:run-commands executor"
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"implicitDependencies": {
"type": "array",
"items": {
"type": "string"
}
}
},
"definitions": {
"inputs": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"fileset": {
"type": "string",
"description": "A glob used to determine a fileset."
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"projects": {
"oneOf": [
{
"type": "string",
"description": "The project that the targets belong to."
},
{
"type": "array",
"description": "The projects that the targets belong to.",
"items": { "type": "string" }
}
]
},
"dependencies": {
"type": "boolean",
"description": "Include files belonging to the input for all the project dependencies of this target."
},
"input": {
"type": "string",
"description": "The name of the input."
}
},
"oneOf": [
{
"required": ["projects", "input"]
},
{
"required": ["dependencies", "input"]
},
{
"required": ["input"],
"not": {
"anyOf": [
{ "required": ["projects"] },
{ "required": ["dependencies"] }
]
}
}
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"runtime": {
"type": "string",
"description": "The command that will be executed and included into the hash."
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"env": {
"type": "string",
"description": "The env var that will be included into the hash."
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"externalDependencies": {
"type": "array",
"items": { "type": "string" },
"description": "The list of external dependencies that our target depends on for `nx:run-commands` and community plugins."
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"dependentTasksOutputFiles": {
"type": "string",
"description": "The glob list of output files that project depends on."
},
"transitive": {
"type": "boolean",
"description": "Whether the check for outputs should be recursive or stop at the first level of dependencies."
}
},
"required": ["dependentTasksOutputFiles"],
"additionalProperties": false
}
]
}
}
}
}