Repository navigation
Expand file tree
/
Copy pathlibraries.schema.json
More file actions
66 lines (66 loc) · 3.2 KB
/
Copy pathlibraries.schema.json
File metadata and controls
66 lines (66 loc) · 3.2 KB
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
{
"$schema": "http://json-schema.org/draft-06/schema#",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LibraryDefinition"
},
"definitions": {
"LibraryDefinition": {
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"type": "string",
"description": "General description of the library just to know what the library does.",
"examples": ["A React Native library to display fancy animations", "A <Video /> component for React Native"]
},
"installCommand": {
"type": "string",
"description": "Command used to install packages in the test project. It will be prepended with 'yarn add' command. If your library publishes nightlies or betas, please use the '@nightly' and '@beta' suffix, so we’ll test against the latest version. If your library has multiple NPM package that requires testing, please include all of them as space separated string.",
"examples": ["react-native-gesture-handler", "react-native-reanimated@nightly react-native-worklets@nightly"]
},
"android": {
"type": "boolean",
"description": "Boolean toggle if the test on Android should be executed."
},
"ios": {
"type": "boolean",
"description": "Boolean toggle if the test on iOS should be executed."
},
"maintainersUsernames": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of GitHub usernames. We will use it in the future to communicate with library maintainers (e.g. ping for build failures).",
"examples": [["frodo", "bilbo", "pippin", "merry", "sam"]]
},
"notes": {
"type": "string",
"description": "Optional notes about the state of the library or reason why it has been added.",
"examples": [
"Build currently broken due to X reason.",
"One of top most used libraries according to the npm stats."
]
},
"patchFile": {
"type": "string",
"description": "Optional path to a patch file (relative to repo root) to apply after installing the library but before building. Patch should be created using 'git diff --binary' format (e.g., using scripts/make-patch.js).",
"examples": ["patches/react-native-reanimated.patch", "patches/library-name-fix.patch"]
},
"setupScript": {
"type": "string",
"description": "Optional path to a Node.js script (relative to repo root) with arguments, which adds the library to the test project instead of the packages in 'installCommand'. The script runs with the test project as the current directory.",
"examples": ["scripts/create-react-native-library.js --type turbo-module --languages kotlin-objc"]
},
"githubUrl": {
"type": "string",
"description": "Optional URL to the GitHub repository of the library.",
"examples": ["https://github.com/react/react-native"]
}
},
"required": ["description", "installCommand", "maintainersUsernames", "notes"],
"title": "LibraryDefinition"
}
}
}