Use string formatting

kgryte · kgryte · commit be5792f603e9 · 2022-03-26T18:33:49.000-07:00
diff --git a/tools/snippets/lib/validate.js b/tools/snippets/lib/validate.js
@@ -22,6 +22,7 @@
 
 var isPlainObject = require( '@stdlib/assert/is-plain-object' );
 var hasOwnProp = require( '@stdlib/assert/has-own-property' );
+var format = require( '@stdlib/string/format' );
 
 
 // MAIN //
@@ -44,12 +45,12 @@ var hasOwnProp = require( '@stdlib/assert/has-own-property' );
 */
 function validate( opts, options ) {
 	if ( !isPlainObject( options ) ) {
-		return new TypeError( 'invalid argument. Options argument must be an object. Value: `' + options + '`.' );
+		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
 	}
 	if ( hasOwnProp( options, 'TODO' ) ) {
 		opts.TODO = options.TODO;
 		if ( !isPlainObject( opts.TODO ) ) {
-			return new TypeError( 'invalid option. `TODO` option must be a TODO. Option: `' + opts.TODO + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a TODO. Option: `%s`.', 'TODO', opts.TODO ) );
 		}
 	}
 	return null;
diff --git a/tools/snippets/test/test.validate.js b/tools/snippets/test/test.validate.js
@@ -21,6 +21,7 @@
 // MODULES //
 
 var tape = require( 'tape' );
+var format = require( '@stdlib/string/format' );
 var validate = require( './../lib/validate.js' );
 
 
@@ -51,7 +52,7 @@ tape( 'the function returns an error if provided an `options` argument which is
 
 	for ( i = 0; i < values.length; i++ ) {
 		err = validate( {}, values[ i ] );
-		t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] );
+		t.strictEqual( err instanceof TypeError, true, format( 'returns an error when provided %s', values[i] ) );
 	}
 	t.end();
 });
@@ -67,7 +68,7 @@ tape( 'the function returns `null` if all options are valid', function test( t )
 	options = {}; // TODO: add options
 
 	err = validate( opts, options );
-	t.strictEqual( err, null, 'returns null' );
+	t.strictEqual( err, null, 'returns expected value' );
 	t.deepEqual( opts, options, 'sets options' );
 
 	t.end();
@@ -85,7 +86,7 @@ tape( 'the function will ignore unrecognized options', function test( t ) {
 	};
 
 	err = validate( opts, options );
-	t.strictEqual( err, null, 'returns null' );
+	t.strictEqual( err, null, 'returns expected value' );
 	t.deepEqual( opts, {}, 'ignores unrecognized options' );
 
 	t.end();

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@`
`22`	`22`
`23`	`23`	`var isPlainObject = require( '@stdlib/assert/is-plain-object' );`
`24`	`24`	`var hasOwnProp = require( '@stdlib/assert/has-own-property' );`
	`25`	`+var format = require( '@stdlib/string/format' );`
`25`	`26`
`26`	`27`
`27`	`28`	`// MAIN //`
`@@ -44,12 +45,12 @@ var hasOwnProp = require( '@stdlib/assert/has-own-property' );`
`44`	`45`	`*/`
`45`	`46`	`function validate( opts, options ) {`
`46`	`47`	`if ( !isPlainObject( options ) ) {`
`47`		- return new TypeError( 'invalid argument. Options argument must be an object. Value: `' + options + '`.' );
	`48`	+ return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
`48`	`49`	`}`
`49`	`50`	`if ( hasOwnProp( options, 'TODO' ) ) {`
`50`	`51`	`opts.TODO = options.TODO;`
`51`	`52`	`if ( !isPlainObject( opts.TODO ) ) {`
`52`		- return new TypeError( 'invalid option. `TODO` option must be a TODO. Option: `' + opts.TODO + '`.' );
	`53`	+ return new TypeError( format( 'invalid option. `%s` option must be a TODO. Option: `%s`.', 'TODO', opts.TODO ) );
`53`	`54`	`}`
`54`	`55`	`}`
`55`	`56`	`return null;`