This repository has been archived by the owner on Sep 17, 2019. It is now read-only.
/
brsconfig.schema.json
122 lines (122 loc) · 4.98 KB
/
brsconfig.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
{
"title": "JSON schema for brsconfig.json configuration files",
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"dependencies": {
"deploy": [
"host",
"password"
]
},
"properties": {
"extends": {
"description": "Relative or absolute path to another brsconfig.json file that this file should use as a base, and then override",
"type": "string"
},
"cwd": {
"description": "A path that will be used to override the current working directory",
"type": "string"
},
"rootDir": {
"description": "The root directory of your Roku project. Defaults to the current working directory (or cwd property)",
"type": "string"
},
"files": {
"description": "The list of files that should be used in this project. Supports globs. Optionally, you can specify an object with `src` and `dest` properties to move files from one location into a different destination location",
"default": [
"manifest",
"source/**/*.*",
"components/**/*.*",
"images/**/*.*"
],
"items": {
"anyOf": [
{
"type": "string",
"description": "A file path or file glob"
},
{
"type": "object",
"properties": {
"src": {
"anyOf": [
{
"type": "string",
"description": "A file path or glob pattern of source file(s)"
},
{
"type": "array",
"description": "An array of file path or globs",
"items": {
"type": "string",
"description": "A file path or glob pattern of source file(s)"
}
}
]
},
"dest": {
"type": "string",
"description": "The destination for the file(s) found in 'src'. If this path is a directory, you must end it in a trailing slash"
}
},
"required": [
"src",
"dest"
]
}
]
}
},
"outFile": {
"description": "The path where the output zip or package should be placed. This includes the filename. Defaults to \"./out/package\"",
"type": "string"
},
"skipPackage": {
"description": " Prevents the zip file from being created. This has no effect if deploy is true",
"type": "boolean"
},
"watch": {
"description": "If true, the server will keep running and will watch and recompile on every file change",
"type": "boolean",
"default": false
},
"deploy": {
"description": "If true, after a successful buld, the project will be deployed to the roku specified in host",
"type": "boolean"
},
"host": {
"description": "The host of the Roku that the package will be deploy to",
"type": "string"
},
"username": {
"description": "The username to use when deploying to a Roku device",
"type": "string"
},
"password": {
"description": " The password to use when deploying to a Roku device",
"type": "string"
},
"retainStagingFolder": {
"type": "boolean",
"description": "Prevent the staging folder from being deleted after the deployment package is created. This is helpful for troubleshooting why your package isn't being created the way you expected.",
"default": false
},
"ignoreErrorCodes": {
"description": "A list of error codes the compiler should NOT emit, even if encountered.",
"type": "array",
"items": {
"anyOf": [
{
"type": "number",
"description": "a brightscript error code that will be ignored during compile"
}
]
}
},
"emitFullPaths": {
"description": " Emit full paths to files when printing diagnostics to the console.",
"type": "boolean",
"default": false
}
}
}