Auto-generated commit

Author: stdlib-bot

.gitattributes

@@ -23,6 +23,22 @@
 # Automatically normalize the line endings of any committed text files:
 * text=auto
 
+# Override line endings for certain files on checkout:
+*.crlf.csv text eol=crlf
+
+# Denote that certain files are binary and should not be modified:
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.gz binary
+*.zip binary
+*.7z binary
+*.mp3 binary
+*.mp4 binary
+*.mov binary
+
 # Override what is considered "vendored" by GitHub's linguist:
 /deps/** linguist-vendored=false
 /lib/node_modules/** linguist-vendored=false linguist-generated=false

.github/.keepalive

@@ -52,7 +52,7 @@ var capitalize = require( '@stdlib/string-capitalize' );
 
 #### capitalize( str )
 
-Capitalizes the first character in a `string`.
+Capitalizes the first character in a string.
 
 ```javascript
 var out = capitalize( 'last man standing' );
@@ -75,9 +75,7 @@ out = capitalize( 'Hidden Treasures' );
 ```javascript
 var capitalize = require( '@stdlib/string-capitalize' );
 
-var str;
-
-str = capitalize( 'last man standing' );
+var str = capitalize( 'last man standing' );
 // returns 'Last man standing'
 
 str = capitalize( 'presidential election' );

README.md

@@ -22,23 +22,27 @@
 
 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 capitalize = require( './../lib' );
 
 
 // MAIN //
 
 bench( pkg, function benchmark( b ) {
-	var str;
+	var values;
 	var out;
 	var i;
 
+	values = [
+		'beep boop',
+		'foo bar',
+		'xyz xyz'
+	];
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		str = fromCodePoint( i%126 ) + 'eep boop';
-		out = capitalize( str );
-		if ( !isString( out ) ) {
+		out = capitalize( values[ i%values.length ] );
+		if ( typeof out !== 'string' ) {
 			b.fail( 'should return a string' );
 		}
 	}

benchmark/benchmark.js

@@ -1,6 +1,6 @@
 
 {{alias}}( str )
-    Capitalizes the first character in a `string`.
+    Capitalizes the first character in a string.
 
     Parameters
     ----------

docs/repl.txt

@@ -26,7 +26,7 @@ import capitalize = require( './index' );
 	capitalize( 'abc' ); // $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...
 {
 	capitalize( true ); // $ExpectError
 	capitalize( false ); // $ExpectError
@@ -38,7 +38,7 @@ import capitalize = require( './index' );
 	capitalize( ( 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...
 {
 	capitalize(); // $ExpectError
 }

docs/types/test.ts

@@ -35,9 +35,9 @@
 
 // MODULES //
 
-var capitalize = require( './capitalize.js' );
+var main = require( './main.js' );
 
 
 // EXPORTS //
 
-module.exports = capitalize;
+module.exports = main;

lib/index.js

@@ -22,6 +22,7 @@
 
 var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
 var format = require( '@stdlib/string-format' );
+var base = require( '@stdlib/string-base-capitalize' );
 
 
 // MAIN //
@@ -30,7 +31,7 @@ var format = require( '@stdlib/string-format' );
 * Capitalizes the first character in a string.
 *
 * @param {string} str - input string
-* @throws {TypeError} must provide a string primitive
+* @throws {TypeError} must provide a string
 * @returns {string} capitalized string
 *
 * @example
@@ -53,10 +54,7 @@ function capitalize( str ) {
 	if ( !isString( str ) ) {
 		throw new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', str ) );
 	}
-	if ( str === '' ) {
-		return '';
-	}
-	return str.charAt( 0 ).toUpperCase() + str.slice( 1 );
+	return base( str );
 }
 
 

lib/capitalize.js lib/main.jslib/capitalize.js renamed to lib/main.js

@@ -47,6 +47,7 @@
     "@stdlib/process-read-stdin": "^0.0.x",
     "@stdlib/regexp-eol": "^0.0.x",
     "@stdlib/streams-node-stdin": "^0.0.x",
+    "@stdlib/string-base-capitalize": "^0.0.x",
     "@stdlib/string-format": "^0.0.x",
     "@stdlib/utils-regexp-from-string": "^0.0.x"
   },
@@ -55,7 +56,6 @@
     "@stdlib/assert-is-windows": "^0.0.x",
     "@stdlib/bench": "^0.0.x",
     "@stdlib/process-exec-path": "^0.0.x",
-    "@stdlib/string-from-code-point": "^0.0.x",
     "@stdlib/string-replace": "^0.0.x",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "proxyquire": "^2.0.0",

package.json

@@ -64,7 +64,7 @@ tape( 'the function returns an empty string if provided an empty string', functi
 	t.end();
 });
 
-tape( 'the function capitalizes the first character in a given string', function test( t ) {
+tape( 'the function capitalizes the first character in a provided string', function test( t ) {
 	var out;
 
 	out = capitalize( 'hello world' );