refactor: consolidate error messages

Signed-off-by: Athan <[email protected]>

Author: kgryte

lib/node_modules/@stdlib/_tools/remark/plugins/remark-lint-expected-html-sections/lib/validate.js

@@ -21,52 +21,49 @@
 // MODULES //
 
 var objectKeys = require( '@stdlib/utils/keys' );
-var isObject = require( '@stdlib/assert/is-plain-object' );
+var isPlainObject = require( '@stdlib/assert/is-plain-object' );
 var hasOwnProp = require( '@stdlib/assert/has-own-property' );
-var isArray = require( '@stdlib/assert/is-array' );
-var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
-var join = require( '@stdlib/array/base/join' );
+var isStringArray = require( '@stdlib/assert/is-string-array' ).primitives;
+var isEmptyArray = require( '@stdlib/assert/is-empty-array' );
 var format = require( '@stdlib/string/format' );
 
 
 // FUNCTIONS //
 
 /**
-* Validates a section schema configuration.
+* Validates a schema object.
 *
 * @private
-* @param {Object} schema - schema section to validate
-* @param {string} section - section name
+* @param {Object} schema - schema object
 * @returns {(Error|null)} null or an error object
 */
-function validateSection( schema, section ) {
+function validateSchema( schema ) {
+	var section;
+	var keys;
+	var obj;
 	var i;
-	if ( !isObject( schema ) ) {
-		return new TypeError( format( 'invalid option. `%s` schema section must be an object. Value: `%s`.', section, schema ) );
-	}
-	if ( hasOwnProp( schema, 'required' ) ) {
-		if ( !isArray( schema.required ) ) {
-			return new TypeError( format( 'invalid option. `%s` must be an array. Value: `%s`.', section+'.required', schema.required ) );
+	
+	keys = objectKeys( schema );
+	for ( i = 0; i < keys.length; i++ ) {
+		section = keys[ i ];
+		obj = schema[ section ];
+		if ( !isPlainObject( obj ) ) {
+			return new TypeError( format( 'invalid option. `%s` option must be an object containing properties having values which are objects. Option: `%s`.', 'schema', JSON.stringify( obj ) ) );
 		}
-		for ( i = 0; i < schema.required.length; i++ ) {
-			if ( !isString( schema.required[ i ] ) ) {
-				return new TypeError( format( 'invalid option. `%s` must only contain strings. Index: `%u`. Value: `%s`.', section+'.required', i, schema.required[ i ] ) );
+		if ( hasOwnProp( obj, 'required' ) ) {
+			if ( !isStringArray( obj.required ) && !isEmptyArray( obj.required ) ) {
+				return new TypeError( format( 'invalid option. `%s` option must be an object having %s `%s` property which is an array of strings. Option: `%s`.', 'schema', 'a', section+'.required', JSON.stringify( obj ) ) );
 			}
+		} else {
+			return new TypeError( format( 'invalid option. `%s` option must be an object having %s `%s` property which is an array of strings. Option: `%s`.', 'schema', 'a', section+'.required', JSON.stringify( obj ) ) );
 		}
-	} else {
-		return new TypeError( format( 'invalid option. `%s` schema section must have %s `%s` property.', section, 'a', 'required' ) );
-	}
-	if ( hasOwnProp( schema, 'optional' ) ) {
-		if ( !isArray( schema.optional ) ) {
-			return new TypeError( format( 'invalid option. `%s` must be an array. Value: `%s`.', section+'.optional', schema.optional ) );
-		}
-		for ( i = 0; i < schema.optional.length; i++ ) {
-			if ( !isString( schema.optional[ i ] ) ) {
-				return new TypeError( format( 'invalid option. `%s` must only contain strings. Index: `%u`. Value: `%s`.', section+'.optional', i, schema.optional[ i ] ) );
+		if ( hasOwnProp( obj, 'optional' ) ) {
+			if ( !isStringArray( obj.optional ) && !isEmptyArray( obj.optional ) ) {
+				return new TypeError( format( 'invalid option. `%s` option must be an object having %s `%s` property which is an array of strings. Option: `%s`.', 'schema', 'a', section+'.optional', JSON.stringify( obj ) ) );
 			}
+		} else {
+			return new TypeError( format( 'invalid option. `%s` option must be an object having %s `%s` property which is an array of strings. Option: `%s`.', 'schema', 'a', section+'.optional', JSON.stringify( obj ) ) );
 		}
-	} else {
-		return new TypeError( format( 'invalid option. `%s` schema section must have %s `%s` property.', section, 'an', 'optional' ) );
 	}
 	return null;
 }
@@ -99,29 +96,21 @@ function validateSection( schema, section ) {
 * }
 */
 function validate( opts, options ) {
-	var section;
-	var keys;
 	var err;
-	var i;
-
-	if ( !isObject( options ) ) {
+	if ( !isPlainObject( options ) ) {
 		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
 	}
 	if ( hasOwnProp( options, 'schema' ) ) {
-		if ( !isObject( options.schema ) ) {
+		if ( !isPlainObject( options.schema ) ) {
 			return new TypeError( format( 'invalid option. `%s` option must be an object. Option: `%s`.', 'schema', options.schema ) );
 		}
 		if ( !hasOwnProp( options.schema, 'root' ) ) {
 			return new TypeError( format( 'invalid option. `%s` option must have %s `%s` property.', 'schema', 'a', 'root' ) );
 		}
-		keys = objectKeys( options.schema );
-		for ( i = 0; i < keys.length; i++ ) {
-			section = keys[ i ];
-			err = validateSection( options.schema[ section ], section );
-			if ( err ) {
-				return err;
-			}
-		}
+		err = validateSchema( options.schema );
+		if ( err ) {
+			return err;
+		}	
 		opts.schema = options.schema;
 	}
 	return null;