Rename file and clean-up

Author: kgryte

lib/node_modules/@stdlib/string/right-trim/README.md

@@ -18,7 +18,7 @@ limitations under the License.
 
 -->
 
-# Right Trim
+# rtrim
 
 > Trim whitespace characters from the end of a string.
 
@@ -47,7 +47,23 @@ var out = rtrim( ' \t\t\n  Beep \r\n\t  ' );
 
 ## Notes
 
--   Following [Unicode 6.3.0][unicode] and later, "whitespace" is defined as the following characters: `[ \\f\\n\\r\\t\\v\\u0020\\u00a0\\u1680\\u2000-\\u200a\\u2028\\u2029\\u202f\\u205f\\u3000\\ufeff]`.
+-   Following [Unicode 6.3.0][unicode] and later, "whitespace" is defined as the following characters:
+
+    -   `\f`
+    -   `\n`
+    -   `\r`
+    -   `\t`
+    -   `\v`
+    -   `\u0020`
+    -   `\u00a0`
+    -   `\u1680`
+    -   `\u2000-\u200a`
+    -   `\u2028`
+    -   `\u2029`
+    -   `\u202f`
+    -   `\u205f`
+    -   `\u3000`
+    -   `\ufeff`
 
 </section>
 

lib/node_modules/@stdlib/string/right-trim/benchmark/benchmark.js

@@ -22,7 +22,6 @@
 
 var bench = require( '@stdlib/bench' );
 var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
-var fromCodePoint = require( '@stdlib/string/from-code-point' );
 var pkg = require( './../package.json' ).name;
 var rtrim = require( './../lib' );
 
@@ -32,23 +31,26 @@ var rtrim = require( './../lib' );
 var opts = {
 	'skip': ( typeof String.prototype.trimRight !== 'function' )
 };
+var whitespace = '\\f\\n\\r\\t\\v\\u0020\\u00a0\\u1680\\u2000-\\u200a\\u2028\\u2029\\u202f\\u205f\\u3000\\ufeff';
 
 
 // MAIN //
 
 bench( pkg, function benchmark( b ) {
-	var whitespace;
-	var str;
+	var values;
 	var out;
 	var i;
 
-	whitespace = '\\f\\n\\r\\t\\v\\u0020\\u00a0\\u1680\\u2000-\\u200a\\u2028\\u2029\\u202f\\u205f\\u3000\\ufeff';
+	values = [
+		'beep boop' + whitespace,
+		'foo bar' + whitespace,
+		'abc xyz' + whitespace
+	];
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		str = fromCodePoint( i%126 ) + 'eep boop' + whitespace;
-		out = rtrim( str );
-		if ( !isString( out ) ) {
+		out = rtrim( values[ i%values.length ] );
+		if ( typeof out !== 'string' ) {
 			b.fail( 'should return a string' );
 		}
 	}
@@ -61,18 +63,20 @@ bench( pkg, function benchmark( b ) {
 });
 
 bench( pkg+'::built-in', opts, function benchmark( b ) {
-	var whitespace;
-	var str;
+	var values;
 	var out;
 	var i;
 
-	whitespace = '\\f\\n\\r\\t\\v\\u0020\\u00a0\\u1680\\u2000-\\u200a\\u2028\\u2029\\u202f\\u205f\\u3000\\ufeff';
+	values = [
+		'beep boop' + whitespace,
+		'foo bar' + whitespace,
+		'abc xyz' + whitespace
+	];
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		str = fromCodePoint( i%126 ) + 'eep boop' + whitespace;
-		out = str.trimRight();
-		if ( !isString( out ) ) {
+		out = values[ i%values.length ].trimRight();
+		if ( typeof out !== 'string' ) {
 			b.fail( 'should return a string' );
 		}
 	}

lib/node_modules/@stdlib/string/right-trim/docs/repl.txt

@@ -1,6 +1,6 @@
 
 {{alias}}( str )
-    Trims whitespace from the end of a `string`.
+    Trims whitespace from the end of a string.
 
     "Whitespace" is defined as the following characters:
 

lib/node_modules/@stdlib/string/right-trim/docs/types/test.ts

@@ -26,7 +26,7 @@ import rtrim = require( './index' );
 	rtrim( '   Whitespace   ' ); // $ExpectType string
 }
 
-// The function does not compile if provided a value other than a string...
+// The compiler throws an error if the function is provided a value other than a string...
 {
 	rtrim( true ); // $ExpectError
 	rtrim( false ); // $ExpectError
@@ -38,7 +38,7 @@ import rtrim = require( './index' );
 	rtrim( ( x: number ): number => x ); // $ExpectError
 }
 
-// The function does not compile if provided insufficient arguments...
+// The compiler throws an error if the function is provided insufficient arguments...
 {
 	rtrim(); // $ExpectError
 }

lib/node_modules/@stdlib/string/right-trim/lib/index.js

@@ -38,7 +38,7 @@
 
 // MODULES //
 
-var rtrim = require( './right_trim.js' );
+var rtrim = require( './main.js' );
 
 
 // EXPORTS //

lib/node_modules/@stdlib/string/right-trim/lib/right_trim.js renamed to lib/node_modules/@stdlib/string/right-trim/lib/main.js

@@ -21,7 +21,7 @@
 // MODULES //
 
 var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
-var replace = require( '@stdlib/string/replace' );
+var replace = require( '@stdlib/string/base/replace' );
 var format = require( '@stdlib/string/format' );
 
 
@@ -37,7 +37,7 @@ var RE = /[\u0020\f\n\r\t\v\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u30
 * Trims whitespace from the end of a string.
 *
 * @param {string} str - input string
-* @throws {TypeError} must provide a string primitive
+* @throws {TypeError} must provide a string
 * @returns {string} trimmed string
 *
 * @example

lib/node_modules/@stdlib/string/right-trim/test/test.js

@@ -32,15 +32,15 @@ tape( 'main export is a function', function test( t ) {
 	t.end();
 });
 
-tape( 'the function throws an error if not provided a string primitive', function test( t ) {
+tape( 'the function throws an error if not provided a string', function test( t ) {
 	var values;
 	var i;
 
 	values = [
-		new String( 'beep' ), // eslint-disable-line no-new-wrappers
 		5,
 		null,
 		true,
+		false,
 		void 0,
 		NaN,
 		[],
@@ -100,13 +100,6 @@ tape( 'the function removes all whitespace characters at the end of a string', f
 	actual = rtrim( 'beep\u1680' );
 	t.equal( actual, expected, 'removes \\u1680' );
 
-	/*
-	* Note: removed support to match Unicode 6.3.0 and later.
-	* expected = 'beep';
-	* actual = rtrim( 'beep\u180e' );
-	* t.equal( actual, expected, 'removes \\u180e' );
-	*/
-
 	expected = 'beep';
 	actual = rtrim( 'beep\u2000' );
 	t.equal( actual, expected, 'removes \\u2000' );
@@ -177,3 +170,14 @@ tape( 'the function removes all whitespace characters at the end of a string', f
 
 	t.end();
 });
+
+tape( 'the function does not trim the Mongolian space separator in accordance with Unicode 6.3.0 and later', function test( t ) {
+	var expected;
+	var actual;
+
+	expected = 'beep';
+	actual = rtrim( 'beep\u180e' );
+	t.equal( actual, expected, 'does not remove \\u180e' );
+
+	t.end();
+});