Code review changes part 3

SAP · Mar 24, 2020 · 2ab3f4d · 2ab3f4d
1 parent 892fd46
commit 2ab3f4d
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git 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
@@ -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<undefined>} 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
@@ -2115,7 +2115,7 @@ metadata:
 		},
 		yaml: {
 			documentIndex: 0,
-			path: "/application/ui5.yaml",
+			path: configPath,
 			source: ui5yaml,
 		},
 	}],