From cb21e15be26aae5223e9bdf33bc400286adecc59 Mon Sep 17 00:00:00 2001 From: Matthias Osswald Date: Tue, 24 Mar 2020 09:21:57 +0100 Subject: [PATCH] Code review changes part 3 --- lib/validation/ValidationError.js | 4 +++- lib/validation/validator.js | 11 +++++------ test/lib/projectPreprocessor.js | 2 +- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/lib/validation/ValidationError.js b/lib/validation/ValidationError.js index 5ddcc87fb..7822d08d1 100644 --- a/lib/validation/ValidationError.js +++ b/lib/validation/ValidationError.js @@ -18,6 +18,8 @@ class ValidationError extends Error { * ValidationError * * @const + * @default + * @type {string} * @readonly * @public */ @@ -29,7 +31,7 @@ class ValidationError extends Error { this.errors = ValidationError.filterErrors(errors); /** - * Error message + * Formatted error message * * @type {string} * @readonly diff --git a/lib/validation/validator.js b/lib/validation/validator.js index f65190500..07682a94c 100644 --- a/lib/validation/validator.js +++ b/lib/validation/validator.js @@ -47,8 +47,6 @@ class Validator { project, yaml }); - } else { - return undefined; } } } @@ -73,12 +71,13 @@ module.exports = { * @param {string} options.yaml.source Content of the YAML file * @param {number} [options.yaml.documentIndex=0] Document index in case the YAML file contains multiple documents * @throws {module:@ui5/project.validation.ValidationError} - * Throws a {@link module:@ui5/project.validation.ValidationError ValidationError} when the validation fails. - * @returns {undefined} Returns when the validation succeeds + * Rejects with a {@link module:@ui5/project.validation.ValidationError ValidationError} + * when the validation fails. + * @returns {Promise} Returns a Promise that resolves when the validation succeeds * @public */ - validate: (options) => { - return validator.validate(options); + validate: async (options) => { + await validator.validate(options); }, _Validator: Validator // For testing only }; diff --git a/test/lib/projectPreprocessor.js b/test/lib/projectPreprocessor.js index 2420aa932..766a609ca 100644 --- a/test/lib/projectPreprocessor.js +++ b/test/lib/projectPreprocessor.js @@ -2115,7 +2115,7 @@ metadata: }, yaml: { documentIndex: 0, - path: "/application/ui5.yaml", + path: configPath, source: ui5yaml, }, }],