You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
"description": "Configuration file for the OpenComponents CLI tool. Used to configure registries and development mocks.",
4
6
"properties": {
5
7
"$schema": {
6
8
"description": "A field for the [JSON schema](https://json-schema.org/) specification",
@@ -10,27 +12,54 @@
10
12
]
11
13
},
12
14
"registries": {
15
+
"description": "List of registry URLs where components will be published. These are the target registries for component deployment.",
13
16
"type": "array",
14
17
"items": {
15
-
"type": "string"
16
-
}
18
+
"type": "string",
19
+
"description": "URL of an OpenComponents registry (e.g., 'https://my-registry.com')"
20
+
},
21
+
"minItems": 1,
22
+
"example": [
23
+
"https://my-registry.com",
24
+
"https://staging-registry.com"
25
+
]
26
+
},
27
+
"client": {
28
+
"description": "Custom URL for the oc-client-browser.js file to use during development. If specified, this URL will be used instead of the default bundled client library.",
"description": "Development configuration for mocking plugins that would normally be provided by production registries. Useful for local development and testing.",
19
35
"type": "object",
20
36
"properties": {
21
37
"plugins": {
38
+
"description": "Plugin mocking configuration. Plugins are shared functions that components can use, provided by registries in production.",
22
39
"type": "object",
23
40
"properties": {
24
41
"dynamic": {
42
+
"description": "Dynamic plugin mocks. Values are file paths to JavaScript modules that export 'register' and 'execute' functions. Use this when you need custom mock behavior.",
25
43
"type": "object",
26
44
"additionalProperties": {
27
-
"type": "string"
45
+
"type": "string",
46
+
"description": "Path to a JavaScript file that exports register and execute functions"
47
+
},
48
+
"example": {
49
+
"hash": "./mocks/hash-plugin.js",
50
+
"auth": "./mocks/auth-plugin.js"
28
51
}
29
52
},
30
53
"static": {
54
+
"description": "Static plugin mocks. Values are static strings that will always be returned by the plugin. Use this for simple value mocking.",
31
55
"type": "object",
32
56
"additionalProperties": {
33
-
"type": "string"
57
+
"type": "string",
58
+
"description": "Static value that the plugin should always return"
0 commit comments