All files / src/services configuration.ts

92.86% Statements 13/14
75% Branches 3/4
100% Functions 0/0
92.86% Lines 13/14

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534              1x 1x   1x                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       1x                                                                                                 1x 3x 3x 78x 78x 2x   78x 78x 78x          
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
 
import { ISchemaContributions } from './jsonSchemaService';
 
import * as nls from 'vscode-nls';
const localize = nls.loadMessageBundle();
 
export const schemaContributions: ISchemaContributions = {
	schemaAssociations: [],
	schemas: {
		// refer to the latest schema
		'http://json-schema.org/schema#': {
			$ref: 'http://json-schema.org/draft-07/schema#'
		},
		// bundle the schema-schema to include (localized) descriptions
		'http://json-schema.org/draft-04/schema#': {
			'title': localize('schema.json', 'Describes a JSON file using a schema. See json-schema.org for more info.'),
			'$schema': 'http://json-schema.org/draft-04/schema#',
			'definitions': {
				'schemaArray': {
					'type': 'array',
					'minItems': 1,
					'items': {
						'$ref': '#'
					}
				},
				'positiveInteger': {
					'type': 'integer',
					'minimum': 0
				},
				'positiveIntegerDefault0': {
					'allOf': [
						{
							'$ref': '#/definitions/positiveInteger'
						},
						{
							'default': 0
						}
					]
				},
				'simpleTypes': {
					'type': 'string',
					'enum': [
						'array',
						'boolean',
						'integer',
						'null',
						'number',
						'object',
						'string'
					]
				},
				'stringArray': {
					'type': 'array',
					'items': {
						'type': 'string'
					},
					'minItems': 1,
					'uniqueItems': true
				}
			},
			'type': 'object',
			'properties': {
				'id': {
					'type': 'string',
					'format': 'uri'
				},
				'$schema': {
					'type': 'string',
					'format': 'uri'
				},
				'title': {
					'type': 'string'
				},
				'description': {
					'type': 'string'
				},
				'default': {},
				'multipleOf': {
					'type': 'number',
					'minimum': 0,
					'exclusiveMinimum': true
				},
				'maximum': {
					'type': 'number'
				},
				'exclusiveMaximum': {
					'type': 'boolean',
					'default': false
				},
				'minimum': {
					'type': 'number'
				},
				'exclusiveMinimum': {
					'type': 'boolean',
					'default': false
				},
				'maxLength': {
					'allOf': [
						{
							'$ref': '#/definitions/positiveInteger'
						}
					]
				},
				'minLength': {
					'allOf': [
						{
							'$ref': '#/definitions/positiveIntegerDefault0'
						}
					]
				},
				'pattern': {
					'type': 'string',
					'format': 'regex'
				},
				'additionalItems': {
					'anyOf': [
						{
							'type': 'boolean'
						},
						{
							'$ref': '#'
						}
					],
					'default': {}
				},
				'items': {
					'anyOf': [
						{
							'$ref': '#'
						},
						{
							'$ref': '#/definitions/schemaArray'
						}
					],
					'default': {}
				},
				'maxItems': {
					'allOf': [
						{
							'$ref': '#/definitions/positiveInteger'
						}
					]
				},
				'minItems': {
					'allOf': [
						{
							'$ref': '#/definitions/positiveIntegerDefault0'
						}
					]
				},
				'uniqueItems': {
					'type': 'boolean',
					'default': false
				},
				'maxProperties': {
					'allOf': [
						{
							'$ref': '#/definitions/positiveInteger'
						}
					]
				},
				'minProperties': {
					'allOf': [
						{
							'$ref': '#/definitions/positiveIntegerDefault0'
						}
					]
				},
				'required': {
					'allOf': [
						{
							'$ref': '#/definitions/stringArray'
						}
					]
				},
				'additionalProperties': {
					'anyOf': [
						{
							'type': 'boolean'
						},
						{
							'$ref': '#'
						}
					],
					'default': {}
				},
				'definitions': {
					'type': 'object',
					'additionalProperties': {
						'$ref': '#'
					},
					'default': {}
				},
				'properties': {
					'type': 'object',
					'additionalProperties': {
						'$ref': '#'
					},
					'default': {}
				},
				'patternProperties': {
					'type': 'object',
					'additionalProperties': {
						'$ref': '#'
					},
					'default': {}
				},
				'dependencies': {
					'type': 'object',
					'additionalProperties': {
						'anyOf': [
							{
								'$ref': '#'
							},
							{
								'$ref': '#/definitions/stringArray'
							}
						]
					}
				},
				'enum': {
					'type': 'array',
					'minItems': 1,
					'uniqueItems': true
				},
				'type': {
					'anyOf': [
						{
							'$ref': '#/definitions/simpleTypes'
						},
						{
							'type': 'array',
							'items': {
								'$ref': '#/definitions/simpleTypes'
							},
							'minItems': 1,
							'uniqueItems': true
						}
					]
				},
				'format': {
					'anyOf': [
						{
							'type': 'string',
							'enum': [
								'date-time',
								'uri',
								'email',
								'hostname',
								'ipv4',
								'ipv6',
								'regex'
							]
						},
						{
							'type': 'string'
						}
					]
				},
				'allOf': {
					'allOf': [
						{
							'$ref': '#/definitions/schemaArray'
						}
					]
				},
				'anyOf': {
					'allOf': [
						{
							'$ref': '#/definitions/schemaArray'
						}
					]
				},
				'oneOf': {
					'allOf': [
						{
							'$ref': '#/definitions/schemaArray'
						}
					]
				},
				'not': {
					'allOf': [
						{
							'$ref': '#'
						}
					]
				}
			},
			'dependencies': {
				'exclusiveMaximum': [
					'maximum'
				],
				'exclusiveMinimum': [
					'minimum'
				]
			},
			'default': {}
		},
		'http://json-schema.org/draft-07/schema#': {
			'title': localize('schema.json', 'Describes a JSON file using a schema. See json-schema.org for more info.'),
			'definitions': {
				'schemaArray': {
					'type': 'array',
					'minItems': 1,
					'items': { '$ref': '#' }
				},
				'nonNegativeInteger': {
					'type': 'integer',
					'minimum': 0
				},
				'nonNegativeIntegerDefault0': {
					'allOf': [
						{ '$ref': '#/definitions/nonNegativeInteger' },
						{ 'default': 0 }
					]
				},
				'simpleTypes': {
					'enum': [
						'array',
						'boolean',
						'integer',
						'null',
						'number',
						'object',
						'string'
					]
				},
				'stringArray': {
					'type': 'array',
					'items': { 'type': 'string' },
					'uniqueItems': true,
					'default': []
				}
			},
			'type': ['object', 'boolean'],
			'properties': {
				'$id': {
					'type': 'string',
					'format': 'uri-reference'
				},
				'$schema': {
					'type': 'string',
					'format': 'uri'
				},
				'$ref': {
					'type': 'string',
					'format': 'uri-reference'
				},
				'$comment': {
					'type': 'string'
				},
				'title': {
					'type': 'string'
				},
				'description': {
					'type': 'string'
				},
				'default': true,
				'readOnly': {
					'type': 'boolean',
					'default': false
				},
				'examples': {
					'type': 'array',
					'items': true
				},
				'multipleOf': {
					'type': 'number',
					'exclusiveMinimum': 0
				},
				'maximum': {
					'type': 'number'
				},
				'exclusiveMaximum': {
					'type': 'number'
				},
				'minimum': {
					'type': 'number'
				},
				'exclusiveMinimum': {
					'type': 'number'
				},
				'maxLength': { '$ref': '#/definitions/nonNegativeInteger' },
				'minLength': { '$ref': '#/definitions/nonNegativeIntegerDefault0' },
				'pattern': {
					'type': 'string',
					'format': 'regex'
				},
				'additionalItems': { '$ref': '#' },
				'items': {
					'anyOf': [
						{ '$ref': '#' },
						{ '$ref': '#/definitions/schemaArray' }
					],
					'default': true
				},
				'maxItems': { '$ref': '#/definitions/nonNegativeInteger' },
				'minItems': { '$ref': '#/definitions/nonNegativeIntegerDefault0' },
				'uniqueItems': {
					'type': 'boolean',
					'default': false
				},
				'contains': { '$ref': '#' },
				'maxProperties': { '$ref': '#/definitions/nonNegativeInteger' },
				'minProperties': { '$ref': '#/definitions/nonNegativeIntegerDefault0' },
				'required': { '$ref': '#/definitions/stringArray' },
				'additionalProperties': { '$ref': '#' },
				'definitions': {
					'type': 'object',
					'additionalProperties': { '$ref': '#' },
					'default': {}
				},
				'properties': {
					'type': 'object',
					'additionalProperties': { '$ref': '#' },
					'default': {}
				},
				'patternProperties': {
					'type': 'object',
					'additionalProperties': { '$ref': '#' },
					'propertyNames': { 'format': 'regex' },
					'default': {}
				},
				'dependencies': {
					'type': 'object',
					'additionalProperties': {
						'anyOf': [
							{ '$ref': '#' },
							{ '$ref': '#/definitions/stringArray' }
						]
					}
				},
				'propertyNames': { '$ref': '#' },
				'const': true,
				'enum': {
					'type': 'array',
					'items': true,
					'minItems': 1,
					'uniqueItems': true
				},
				'type': {
					'anyOf': [
						{ '$ref': '#/definitions/simpleTypes' },
						{
							'type': 'array',
							'items': { '$ref': '#/definitions/simpleTypes' },
							'minItems': 1,
							'uniqueItems': true
						}
					]
				},
				'format': { 'type': 'string' },
				'contentMediaType': { 'type': 'string' },
				'contentEncoding': { 'type': 'string' },
				'if': { '$ref': '#' },
				'then': { '$ref': '#' },
				'else': { '$ref': '#' },
				'allOf': { '$ref': '#/definitions/schemaArray' },
				'anyOf': { '$ref': '#/definitions/schemaArray' },
				'oneOf': { '$ref': '#/definitions/schemaArray' },
				'not': { '$ref': '#' }
			},
			'default': true
		}
	}
};
const descriptions: { [prop: string]: string } = {
	id: localize('schema.json.id', "A unique identifier for the schema."),
	$schema: localize('schema.json.$schema', "The schema to verify this document against."),
	title: localize('schema.json.title', "A descriptive title of the element."),
	description: localize('schema.json.description', "A long description of the element. Used in hover menus and suggestions."),
	default: localize('schema.json.default', "A default value. Used by suggestions."),
	multipleOf: localize('schema.json.multipleOf', "A number that should cleanly divide the current value (i.e. have no remainder)."),
	maximum: localize('schema.json.maximum', "The maximum numerical value, inclusive by default."),
	exclusiveMaximum: localize('schema.json.exclusiveMaximum', "Makes the maximum property exclusive."),
	minimum: localize('schema.json.minimum', "The minimum numerical value, inclusive by default."),
	exclusiveMinimum: localize('schema.json.exclusiveMininum', "Makes the minimum property exclusive."),
	maxLength: localize('schema.json.maxLength', "The maximum length of a string."),
	minLength: localize('schema.json.minLength', "The minimum length of a string."),
	pattern: localize('schema.json.pattern', "A regular expression to match the string against. It is not implicitly anchored."),
	additionalItems: localize('schema.json.additionalItems', "For arrays, only when items is set as an array. If it is a schema, then this schema validates items after the ones specified by the items array. If it is false, then additional items will cause validation to fail."),
	items: localize('schema.json.items', "For arrays. Can either be a schema to validate every element against or an array of schemas to validate each item against in order (the first schema will validate the first element, the second schema will validate the second element, and so on."),
	maxItems: localize('schema.json.maxItems', "The maximum number of items that can be inside an array. Inclusive."),
	minItems: localize('schema.json.minItems', "The minimum number of items that can be inside an array. Inclusive."),
	uniqueItems: localize('schema.json.uniqueItems', "If all of the items in the array must be unique. Defaults to false."),
	maxProperties: localize('schema.json.maxProperties', "The maximum number of properties an object can have. Inclusive."),
	minProperties: localize('schema.json.minProperties', "The minimum number of properties an object can have. Inclusive."),
	required: localize('schema.json.required', "An array of strings that lists the names of all properties required on this object."),
	additionalProperties: localize('schema.json.additionalProperties', "Either a schema or a boolean. If a schema, then used to validate all properties not matched by 'properties' or 'patternProperties'. If false, then any properties not matched by either will cause this schema to fail."),
	definitions: localize('schema.json.definitions', "Not used for validation. Place subschemas here that you wish to reference inline with $ref."),
	properties: localize('schema.json.properties', "A map of property names to schemas for each property."),
	patternProperties: localize('schema.json.patternProperties', "A map of regular expressions on property names to schemas for matching properties."),
	dependencies: localize('schema.json.dependencies', "A map of property names to either an array of property names or a schema. An array of property names means the property named in the key depends on the properties in the array being present in the object in order to be valid. If the value is a schema, then the schema is only applied to the object if the property in the key exists on the object."),
	enum: localize('schema.json.enum', "The set of literal values that are valid."),
	type: localize('schema.json.type', "Either a string of one of the basic schema types (number, integer, null, array, object, boolean, string) or an array of strings specifying a subset of those types."),
	format: localize('schema.json.format', "Describes the format expected for the value."),
	allOf: localize('schema.json.allOf', "An array of schemas, all of which must match."),
	anyOf: localize('schema.json.anyOf', "An array of schemas, where at least one must match."),
	oneOf: localize('schema.json.oneOf', "An array of schemas, exactly one of which must match."),
	not: localize('schema.json.not', "A schema which must not match."),
	$id: localize('schema.json.$id', "A unique identifier for the schema."),
	$ref: localize('schema.json.$ref', "Reference a definition hosted on any location."),
	$comment: localize('schema.json.$comment', "Comments from schema authors to readers or maintainers of the schema."),
	readOnly: localize('schema.json.readOnly', "Indicates that the value of the instance is managed exclusively by the owning authority."),
	examples: localize('schema.json.examples', "Sample JSON values associated with a particular schema, for the purpose of illustrating usage."),
	contains: localize('schema.json.contains', "An array instance is valid against \"contains\" if at least one of its elements is valid against the given schema."),
	propertyNames: localize('schema.json.propertyNames', "If the instance is an object, this keyword validates if every property name in the instance validates against the provided schema."),
	const: localize('schema.json.const', "An instance validates successfully against this keyword if its value is equal to the value of the keyword."),
	contentMediaType: localize('schema.json.contentMediaType', "Describes the media type of a string property."),
	contentEncoding: localize('schema.json.contentEncoding', "Describes the content encoding of a string property."),
	if: localize('schema.json.if', "The validation outcome of the \"if\" subschema controls which of the \"then\" or \"else\" keywords are evaluated."),
	then: localize('schema.json.then', "The \"if\" subschema is used for validation when the \"if\" subschema succeeds."),
	else: localize('schema.json.else', "The \"else\" subschema is used for validation when the \"if\" subschema fails.")
};
 
for (const schemaName in schemaContributions.schemas) {
	const schema = schemaContributions.schemas[schemaName];
	for (const property in schema.properties) {
		let propertyObject = schema.properties[property];
		if (typeof propertyObject === 'boolean') {
			propertyObject = schema.properties[property] = {};
		}
		const description = descriptions[property];
		Eif (description) {
			propertyObject['description'] = description;
		} else {
			console.log(`${property}: localize('schema.json.${property}', "")`);
		}
	}
}