ares-ide/assets/schema/project.schema.json

A browser-based code editor and UI designer for Enyo 2 projects

{
	"description":"JSON Schema of Ares Project File (project.json)",
	"type": "object",
	"properties": {
		"format": {
			"type":"number", 
			"description": "Ares project file format version (internal)",
			"required":true
		},
		"id": {
			"type": "string",
			"description":"Application ID in reverse domain-name format: com.example.apps.myapp",
			"format": "regex",
			"pattern": "([a-z0-9]+\.)+[a-z0-9]+",
			"required":true,
			"default": "com.examples.apps.myapp"
		},
		"name": {
			"type": "string",
			"description": "One-word blank-less name of the application, used for package name.  Often the last term of the application {id}",
			"format": "regex",
			"pattern": "([a-z0-9]+)",
			"required":true
		},
		"title": {
			"type": "string",
			"description": "One-line description of the application",
			"format": "regex",
			"pattern": "([a-z0-9]+)",
			"required":t rue,
			"default": "Example: My Application"
		},
		"version": {
			"type": "string",
			"description":"Application version string: usually (M)ajor.(m)inor.(p)atchlevel" ,
			"format": "regex",
			"pattern": "([0-9]+\.)+[0-9]+",
			"required":true,
			"default": "0.0.1"
		},
		"author": {
			"type": "object",
			"required": true,
			"properties": {
				"href": {
					"type": "string",
					"description": "mailto: or http: reference to the author",
					"default": "http://www.example.com"
				},
				"name": {
					"type": "string",
					"description": "Vendor / Committer Name",
					"required": true,
					"default": "An Example Company"
				}
			}
		}, 
		"build": {
			"type": "object",
			"description": "List of builders",
			"required":false,
			"properties": {
				"phonegap":{
					"type": "object",
					"description": "build.phonegap.com parameters",
					"required":false,
					"properties": {
						"enabled":{
							"type":"boolean",
							"description":"Whether PhoneGap build is enabled for this project",
							"required":true
						},
						"appId":{
							"type": "string",
							"description": "unique identifier, assigned by build.phonegap.com",
							"required":false
						},
						"icon": {
							"type":"object",
							"required":false,
							"properties": {
								"src":{
									"type": "string",
									"description": "Relative location of the application icon.  Replaced by Enyo icon is absent.",
									"format": "url",
									"required": false,
									"default": "icon.png"
								},
								"role":{
									"type":"string",
									"required":false,
									"default": "default"
								}
							},
						},
						"features":{
							"type":"array",
							"items":{
								"type":"object",
								"properties":{
									"name":{
										"description":"PhoneGap build properties names are defined by URL",
										"type":"string",
										"format":"url"
									} 
								}
							}
						},
						"preferences":{
							"type":"object",
							"properties":{
								"phonegap-version":{
									"description":"Preferred PhoneGap version (default is the latest)",
									"type": "string",
									"format": "regex",
									"pattern": "([0-9]+\.)+[0-9]+",
									"default": "2.0.0"
								}
							}
						},
						"targets":{
							"type":"object",
							"description":"Selected build targets",
							"required":false,
							"properties":{
								"android":{
									"type":"object",
									"description":"android-specific build properties",
									"required":false,
									"properties":{
										"keyId": {
											"type": "integer",
											"description": "PhoneGap Build Key ID, as give by /api/v1/keys/android"
										},
										"minVersion":{
											"type":"string",
											"description":"minimum Android version required by this application.",
											"required":false
										}
									}
								},
								"ios":{
									"type":"object",
									"description":"ios-specific build properties",
									"required":false,
									"properties":{
										"keyId": {
											"type": "integer",
											"description": "PhoneGap Build Key ID, as give by /api/v1/keys/ios"
										}
									}
								},
								"winphone":{
									"type":"object",
									"description":"winphone-specific build properties",
									"required":false,
									"properties":{
									}
								},
								"blackberry":{
									"type":"object",
									"description":"blackberry-specific build properties",
									"required":false,
									"properties":{
										"keyId": {
											"type": "integer",
											"description": "PhoneGap Build Key ID, as give by /api/v1/keys/blackberry"
										}
									}
								},
								"webos":{
									"type":"object",
									"description":"webos-specific build properties",
									"required":false,
									"properties":{
									}
								}
							}
						}
					}
				}
			}
		},
		preview: {
			"type":"object",
			"description":"preview properties",
			"required":false,
			"properties": {
				"top_file": {
					"type":"object",
					"description":"index.html like",
					"required":false,
				}
			}
		}
	}
}