|
| 1 | +{ |
| 2 | + "title": "Manifest.json Schema", |
| 3 | + "$schema": "http://json-schema.org/draft-07/schema", |
| 4 | + "$id": "https://raw.githubusercontent.com/qooxdoo/qooxdoo-compiler/master/source/resource/qx/tool/schema/Manifest-1-0-0.json", |
| 5 | + "description": "qooxdoo's Manifest files serve to provide meta information for a library in a structured way. Their syntax is in JSON. They have a more informational part (keyed info), which is more interesting for human readers, a technical part (named provides) that is used in the processing of generator configurations, and a part named externalResources to include CSS and Javascript files.", |
| 6 | + "type": "object", |
| 7 | + "required": [ |
| 8 | + "provides", |
| 9 | + "$schema" |
| 10 | + ], |
| 11 | + "additionalProperties": false, |
| 12 | + "properties": { |
| 13 | + "$schema": { |
| 14 | + "type": "string", |
| 15 | + "description": "the json schema of the version of Manifest.json", |
| 16 | + "enum": [ |
| 17 | + "https://www.qooxdoo.org/schema/Manifest-1-0-0.json", |
| 18 | + "https://raw.githubusercontent.com/qooxdoo/qooxdoo-compiler/master/source/resource/qx/tool/schema/Manifest-1-0-0.json", |
| 19 | + "https://raw.githubusercontent.com/qooxdoo/qooxdoo-compiler/master/resource/schema/v1/Manifest.json" |
| 20 | + ] |
| 21 | + }, |
| 22 | + "info": { |
| 23 | + "type": "object", |
| 24 | + "additionalProperties": false, |
| 25 | + "description": "General Information about the project", |
| 26 | + "properties": { |
| 27 | + "name": { |
| 28 | + "type": "string", |
| 29 | + "description": "Name of the library" |
| 30 | + }, |
| 31 | + "summary": { |
| 32 | + "type": "string", |
| 33 | + "description": "Short summary of its purpose" |
| 34 | + }, |
| 35 | + "description": { |
| 36 | + "type": "string", |
| 37 | + "description": "Descriptive text" |
| 38 | + }, |
| 39 | + "keywords": { |
| 40 | + "type": "array", |
| 41 | + "description": "Lost of keywords, tags.", |
| 42 | + "uniqueItems": true, |
| 43 | + "items": { |
| 44 | + "type": "string" |
| 45 | + } |
| 46 | + }, |
| 47 | + "homepage": { |
| 48 | + "type": "string", |
| 49 | + "description": "Homepage URL of the library." |
| 50 | + }, |
| 51 | + "license": { |
| 52 | + "type": "string", |
| 53 | + "description": "License(s) of the library" |
| 54 | + }, |
| 55 | + "authors": { |
| 56 | + "description": "List of Authors", |
| 57 | + "type": "array", |
| 58 | + "items": { |
| 59 | + "type": "object", |
| 60 | + "required": [ |
| 61 | + "name", "email" |
| 62 | + ], |
| 63 | + "additionalProperties": false, |
| 64 | + "properties": { |
| 65 | + "name": { |
| 66 | + "type": "string", |
| 67 | + "examples": [ |
| 68 | + "First Author" |
| 69 | + ] |
| 70 | + }, |
| 71 | + "email": { |
| 72 | + "type": "string", |
| 73 | + "examples": [ |
| 74 | + |
| 75 | + ] |
| 76 | + }, |
| 77 | + "githubUser": { |
| 78 | + "type": "string", |
| 79 | + "pattern": "[^\\s]+" |
| 80 | + }, |
| 81 | + "gitlabUser": { |
| 82 | + "type": "string", |
| 83 | + "pattern": "[^\\s]+" |
| 84 | + }, |
| 85 | + "facebookUser": { |
| 86 | + "type": "string", |
| 87 | + "pattern": "[^\\s]+" |
| 88 | + }, |
| 89 | + "twitterHandle": { |
| 90 | + "type": "string", |
| 91 | + "pattern": "^@[^\\s]+" |
| 92 | + } |
| 93 | + } |
| 94 | + } |
| 95 | + }, |
| 96 | + "version": { |
| 97 | + "type": "string", |
| 98 | + "description": "a semver compatible version string", |
| 99 | + "//pattern": "^(\\d|[1-9]\\d*)\\.(\\d|[1-9]\\d*)\\.(\\d|[1-9]\\d*)(?:-([-\\dA-Za-z]+(?:\\.[\\dA-Za-z-]+)*))?(?:\\+([-\\dA-Za-z]+(?:\\.[-\\d0-9A-Za-z]+)*))?$" |
| 100 | + }, |
| 101 | + "qooxdoo-versions": { |
| 102 | + "type": "array", |
| 103 | + "description": "(deprecated) An array of qooxdoo versions that this library is compatible with. This property is deprecated and will be removed in version 7." |
| 104 | + }, |
| 105 | + "sourceViewUri": { |
| 106 | + "type": "string", |
| 107 | + "description": "URL to view the library's class code online. This URL will be used in generated API documentation. It has a special syntax and allows for placeholders (e.g. for the class name and the source line number)." |
| 108 | + } |
| 109 | + } |
| 110 | + }, |
| 111 | + "provides": { |
| 112 | + "required": [ |
| 113 | + "namespace", |
| 114 | + "class", |
| 115 | + "resource", |
| 116 | + "translation" |
| 117 | + ], |
| 118 | + "additionalProperties": false, |
| 119 | + "type": "object", |
| 120 | + "properties": { |
| 121 | + "namespace": { |
| 122 | + "type": "string", |
| 123 | + "description": "Library namespace (i.e. the namespace elements all class names in this library are prefixed with, e.g. foo for a main application class with name foo.Application)." |
| 124 | + }, |
| 125 | + "encoding": { |
| 126 | + "type": "string", |
| 127 | + "default": "utf-8", |
| 128 | + "description": "File encoding of source code files" |
| 129 | + }, |
| 130 | + "class": { |
| 131 | + "type": "string", |
| 132 | + "default": "source/class", |
| 133 | + "description": "Path to the library's class code relative to the Manifest.json file, up to but not including the root namespace folder" |
| 134 | + }, |
| 135 | + "resource": { |
| 136 | + "type": "string", |
| 137 | + "default": "source/resource", |
| 138 | + "description": "Path to the library's resources relative to the Manifest.json file, up to but not including the root namespace folder" |
| 139 | + }, |
| 140 | + "translation": { |
| 141 | + "type": "string", |
| 142 | + "default": "source/translation", |
| 143 | + "description": "Path to the library's translation files relative to the Manifest.json file" |
| 144 | + }, |
| 145 | + "webfonts": { |
| 146 | + "type":"array", |
| 147 | + "description": "A list of webfont definitions", |
| 148 | + "items": { |
| 149 | + "type": "object", |
| 150 | + "required": [ |
| 151 | + "name", "resources" |
| 152 | + ], |
| 153 | + "additionalProperties": false, |
| 154 | + "properties": { |
| 155 | + "name": { |
| 156 | + "type": "string", |
| 157 | + "description": "Font name" |
| 158 | + }, |
| 159 | + "defaultSize": { |
| 160 | + "type":"number", |
| 161 | + "description": "Default font size" |
| 162 | + }, |
| 163 | + "mapping": { |
| 164 | + "type": "string", |
| 165 | + "description": "Path to a json font map relative to the resource folder" |
| 166 | + }, |
| 167 | + "comparisonString": { |
| 168 | + "type": "string", |
| 169 | + "description": "String to test of font is loaded." |
| 170 | + }, |
| 171 | + "resources": { |
| 172 | + "type": "array", |
| 173 | + "minItems": 1, |
| 174 | + "items": { |
| 175 | + "type":"string", |
| 176 | + "description": "Path to the webfont file relative to the resource folder" |
| 177 | + } |
| 178 | + } |
| 179 | + } |
| 180 | + } |
| 181 | + }, |
| 182 | + "type": { |
| 183 | + "type": "string", |
| 184 | + "pattern": "^(library|application|add-in|contribution)$", |
| 185 | + "description": "Type of the project" |
| 186 | + }, |
| 187 | + "application": { |
| 188 | + "type":"object" |
| 189 | + } |
| 190 | + } |
| 191 | + }, |
| 192 | + "requires": { |
| 193 | + "description": "a list of of needed libraries and contribs. the keys `qooxdoo-sdk` and `qooxdoo-compiler` are also recognized to descript the respective versions of these components", |
| 194 | + "type": "object", |
| 195 | + "required": ["@qooxdoo/framework","@qooxdoo/compiler"], |
| 196 | + "patternProperties": { |
| 197 | + "^.*$": { |
| 198 | + "description": "semver compatible range pattern", |
| 199 | + "type": "string" |
| 200 | + } |
| 201 | + }, |
| 202 | + "additionalProperties": false |
| 203 | + }, |
| 204 | + "externalResources": { |
| 205 | + "type":"object", |
| 206 | + "description": "Static Javascript and CSS files that shall be always included without further processing by qooxdoo. All paths are relative to the resource folder stated in the 'provides' section.", |
| 207 | + "properties": { |
| 208 | + "css": { |
| 209 | + "type": "array", |
| 210 | + "uniqueItems": true, |
| 211 | + "items": { |
| 212 | + "type": "string", |
| 213 | + "pattern": "[.]s?css$" |
| 214 | + } |
| 215 | + }, |
| 216 | + "script": { |
| 217 | + "type": "array", |
| 218 | + "uniqueItems": true, |
| 219 | + "items": { |
| 220 | + "type": "string", |
| 221 | + "pattern": "[.]js$" |
| 222 | + } |
| 223 | + } |
| 224 | + } |
| 225 | + }, |
| 226 | + "setup": { |
| 227 | + "description": "Setup Section - used in Qooxdoo SDK Manifest.json ... do we need this still?", |
| 228 | + "type": "object" |
| 229 | + } |
| 230 | + } |
| 231 | +} |
0 commit comments