change the schema service to accept an object instead of a JSON string (#53)

Author: joscol

language-service/CHANGELOG.md

@@ -1,4 +1,7 @@
 
+#### 0.5.4
+Change schema service to use a schema object instead of a JSON string [#PR-53](https://github.com/Microsoft/azure-pipelines-language-server/pull/53)
+
 #### 0.5.3
 Improve performance [#PR-51](https://github.com/Microsoft/azure-pipelines-language-server/pull/51)
 Improve error messages and suggestions [#PR-52](https://github.com/Microsoft/azure-pipelines-language-server/pull/52)

language-service/package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "azure-pipelines-language-service",
   "description": "Azure Pipelines language service",
-  "version": "0.5.3",
+  "version": "0.5.4",
   "author": "Microsoft",
   "license": "MIT",
   "main": "./lib/src/index.js",

language-service/package.json

@@ -15,26 +15,8 @@ import {SchemaRequestService, WorkspaceContextService, PromiseConstructor, Thena
 import * as nls from 'vscode-nls';
 const localize = nls.loadMessageBundle();
 
-/**
- * getParseErrorMessage has been removed from jsonc-parser since 1.0.0
- *
- * see https://github.com/Microsoft/node-jsonc-parser/blob/42ec16f9c91582d4267a0c48199cdac283c90fc9/CHANGELOG.md
- * 1.0.0
- *  remove nls dependency (remove getParseErrorMessage)
- */
-function getParseErrorMessage(errorCode: Json.ParseErrorCode): string {
-	switch (errorCode) {
-		case Json.ParseErrorCode.InvalidSymbol: return localize('error.invalidSymbol', 'Invalid symbol');
-		case Json.ParseErrorCode.InvalidNumberFormat: return localize('error.invalidNumberFormat', 'Invalid number format');
-		case Json.ParseErrorCode.PropertyNameExpected: return localize('error.propertyNameExpected', 'Property name expected');
-		case Json.ParseErrorCode.ValueExpected: return localize('error.valueExpected', 'Value expected');
-		case Json.ParseErrorCode.ColonExpected: return localize('error.colonExpected', 'Colon expected');
-		case Json.ParseErrorCode.CommaExpected: return localize('error.commaExpected', 'Comma expected');
-		case Json.ParseErrorCode.CloseBraceExpected: return localize('error.closeBraceExpected', 'Closing brace expected');
-		case Json.ParseErrorCode.CloseBracketExpected: return localize('error.closeBracketExpected', 'Closing bracket expected');
-		case Json.ParseErrorCode.EndOfFileExpected: return localize('error.endOfFileExpected', 'End of file expected');
-		default: return '';
-	}
+export function ParseSchema(schemaString: string): JSONSchema {
+	return Json.parse(schemaString);
 }
 
 export interface IJSONSchemaService {
@@ -384,17 +366,13 @@ export class JSONSchemaService implements IJSONSchemaService {
 		}
 
 		return this.requestService(url).then(
-			content => {
+			(content: JSONSchema) => {
 				if (!content) {
 					let errorMessage = localize('json.schema.nocontent', 'Unable to load schema from \'{0}\': No content.', toDisplayString(url));
 					return new UnresolvedSchema(<JSONSchema>{}, [errorMessage]);
 				}
 
-				let schemaContent: JSONSchema = {};
-				let jsonErrors = [];
-				schemaContent = Json.parse(content, jsonErrors);
-				let errors = jsonErrors.length ? [localize('json.schema.invalidFormat', 'Unable to parse content from \'{0}\': {1}.', toDisplayString(url), getParseErrorMessage(jsonErrors[0]))] : [];
-				return new UnresolvedSchema(schemaContent, errors);
+				return new UnresolvedSchema(content, []);
 			},
 			(error: any) => {
 				let errorMessage = localize('json.schema.unabletoload', 'Unable to load schema from \'{0}\': {1}', toDisplayString(url), error.toString());

language-service/src/services/jsonSchemaService.ts

@@ -74,7 +74,7 @@ export interface WorkspaceContextService {
  * in case of an error, a displayable error string
  */
 export interface SchemaRequestService {
-	(uri: string): Thenable<string>;
+	(uri: string): Thenable<JSONSchema>;
 }
 
 export interface SchemaConfiguration {

language-service/src/yamlLanguageService.ts

@@ -1,6 +1,7 @@
 import fs = require('fs');
 import { YAMLCompletion } from '../../src/services/yamlCompletion';
 import * as JSONSchemaService from '../../src/services/jsonSchemaService';
+import { JSONSchema } from '../../src/jsonSchema';
 import * as URL from 'url';
 import { TextDocument, Position, CompletionList } from 'vscode-languageserver-types';
 import * as yamlparser from '../../src/parser/yamlParser'
@@ -96,8 +97,8 @@ const requestService = (path: string): Thenable<string> => {
     });
 };
 
-const schemaResolver = (url: string): Promise<string> => {
-    return Promise.resolve(url);
+const schemaResolver = (url: string): Promise<JSONSchema> => {
+    return Promise.resolve(JSONSchemaService.ParseSchema(url));
 }
 
 

language-service/test/pipelinesTests/yamlcompletion.test.ts

@@ -1,6 +1,7 @@
 import fs = require('fs');
 import { YAMLValidation } from '../../src/services/yamlValidation';
 import * as JSONSchemaService from '../../src/services/jsonSchemaService';
+import { JSONSchema } from '../../src/jsonSchema';
 import * as URL from 'url';
 import { TextDocument, Position, Diagnostic } from 'vscode-languageserver-types';
 import * as yamlparser from '../../src/parser/yamlParser'
@@ -36,8 +37,8 @@ const requestService = (path: string): Thenable<string> => {
     });
 };
 
-const schemaResolver = (url: string): Promise<string> => {
-    return Promise.resolve(url);
+const schemaResolver = (url: string): Promise<JSONSchema> => {
+    return Promise.resolve(JSONSchemaService.ParseSchema(url));
 }
 
 

language-service/test/pipelinesTests/yamlvalidation.test.ts

@@ -17,20 +17,20 @@ const fixtureDocuments = {
 	'http://schema.management.azure.com/schemas/2014-04-01/SuccessBricks.ClearDB.json': 'SuccessBricks.ClearDB.json',
 	'http://schema.management.azure.com/schemas/2015-08-01/Microsoft.Compute.json': 'Microsoft.Compute.json'
 };
-const requestServiceMock = function (uri: string): Promise<string> {
+const requestServiceMock = function (uri: string): Promise<JsonSchema.JSONSchema> {
 	if (uri.length && uri[uri.length - 1] === '#') {
 		uri = uri.substr(0, uri.length - 1);
 	}
 	let fileName = fixtureDocuments[uri];
 	if (fileName) {
-		return new Promise<string>((c, e) => {
+		return new Promise<JsonSchema.JSONSchema>((c, e) => {
 			let fixturePath = path.join(__dirname, './fixtures', fileName);
 			fs.readFile(fixturePath, 'UTF-8', (err, result) => {
-				err ? e("Resource not found.") : c(result.toString());
+				err ? e("Resource not found.") : c(SchemaService.ParseSchema(result.toString()));
 			});
 		});
 	}
-	return Promise.reject<string>("Resource not found.");
+	return Promise.reject<JsonSchema.JSONSchema>("Resource not found.");
 };