-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathesySchema.json
214 lines (214 loc) · 7.23 KB
/
esySchema.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
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "JSON schema for ESY or NPM package.json files",
"definitions": {
"cmdsDef": {
"oneOf": [{
"type": "array",
"items": {
"oneOf": [{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
]
},
"minItems": 1
},
{
"type": "string"
}
]
},
"sandboxConfig": {
"type": "object",
"properties": {
"build": {
"description": "List of commands that describe how your package's default targets should be built when package is being used as a dependency",
"default": ["dune build -p #{self.name}"],
"allOf": [{
"$ref": "#/definitions/cmdsDef"
}]
},
"buildDev": {
"description": "List of commands that describe how your package's default targets should be built when package is being developed",
"default": ["dune build -p #{self.name}"],
"allOf": [{
"$ref": "#/definitions/cmdsDef"
}]
},
"install": {
"description": "Allows to specify a list of commands which should move built artifacts to #{self.install} location.",
"allOf": [{
"$ref": "#/definitions/cmdsDef"
}]
},
"buildsInSource": {
"description": "Allows to modify the building mode. Dune / OcamlBuild users should use \"_build\"",
"enum": ["_build", true, false],
"default": false
},
"exportedEnv": {
"description": "Exports new environment variables to the esy build environment, used when package is built as a dependency",
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"val": {
"type": "string",
"description": "New value of the environment variable. It can use esy's variable substitution syntax"
},
"scope": {
"enum": ["global", "local"],
"description": "Defines the scope of the environment variable (either global or local)"
}
},
"required": ["val", "scope"]
},
"minProperties": 1
},
"buildEnv": {
"description": "Exports new environment variables to the build environment of the current package",
"type": "object",
"additionalProperties": {
"type": "string"
},
"minProperties": 1
}
}
},
"esyDef": {
"properties": {
"esy": {
"allOf": [{
"$ref": "#/definitions/sandboxConfig"
}],
"description": "Additional information needed by esy to build, install or release the project",
"required": [
"build"
],
"properties": {
"release": {
"description": "Additional information needed for esy-release, including the binaries that should be added to the PATH",
"type": "object",
"anyOf": [{
"required": ["bin"],
"properties": {
"bin": {
"description": "List of all executable names which must be made available on $PATH when release is installed on user machine",
"oneOf": [{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
}
}
},
{
"required": ["releasedBinaries"],
"properties": {
"releasedBinaries": {
"description": "[DEPRECATED] Use `bin` instead !",
"oneOf": [{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
}
}
}
],
"properties": {
"includePackages": {
"type": "array",
"items": {
"type": "string"
},
"description": "Project dependencies that must be bundled as part of the project's release",
"minItems": 1
},
"rewritePrefix": {
"type": "boolean",
"default": false,
"description": "Activate path rewriting in artifcats during release installation"
}
}
}
}
}
}
},
"overrideDef": {
"properties": {
"source": {
"type": "string",
"description": "Defines the origin configuration which is being overriden. To use only with \"override\"",
"default": "./package.json"
},
"override": {
"allOf": [{
"$ref": "#/definitions/sandboxConfig"
}],
"description": "Used to specify sandbox configuration overrides, based on the configuration given with the \"source\" keyword",
"properties": {
"buildEnvOverride": {
"description": "Overrides buildEnv by adding or deleting environment variables",
"type": "object",
"additionalProperties": {
"type": ["string", "null"]
},
"minProperties": 1
},
"exportedEnvOverride": {
"description": "Overrides exportedEnv by adding or deleting environment variables. Set an environment variable to null to remove it from preexisting exported environment",
"type": "object",
"minProperties": 1,
"additionalProperties": {
"oneOf": [{
"type": "null"
},
{
"type": "object",
"properties": {
"val": {
"type": "string",
"description": "New value of the environment variable. It can use esy's variable substitution syntax"
},
"scope": {
"enum": ["global", "local"],
"description": "Defines the scope of the environment variable (either global or local)"
}
},
"required": ["val", "scope"]
}
]
}
}
}
}
}
}
},
"allOf": [{
"$ref": "http://json.schemastore.org/package#"
}, {
"$ref": "#/definitions/esyDef"
}, {
"$ref": "#/definitions/overrideDef"
}]
}