fix: add review changes

Author: steff456

lib/node_modules/@stdlib/string/base/truncate-code-points/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # truncateCodePoints
 
-> Truncate the Unicode code points of a provided string in order to return a string having a specified length.
+> Truncate the Unicode code points of a provided string in order to return a string having a specified number of Unicode code points.
 
 <section class="usage">
 
@@ -32,7 +32,7 @@ var truncateCodePoints = require( '@stdlib/string/base/truncate-code-points' );
 
 #### truncateCodePoints( str, N, ending )
 
-Truncates the Unicode code points of a provided string in order to return a string having a specified length.
+Truncates the Unicode code points of a provided string in order to return a string having a specified number of Unicode code points.
 
 ```javascript
 var out = truncateCodePoints( 'beep boop', 7, '...' );

lib/node_modules/@stdlib/string/base/truncate-code-points/docs/repl.txt

@@ -1,7 +1,7 @@
 
 {{alias}}( str, len, ending )
     Truncate the Unicode code points of a provided string in order to return a
-    string having a specified length.
+    string having a specified number of Unicode code points.
 
     Parameters
     ----------

lib/node_modules/@stdlib/string/base/truncate-code-points/docs/types/index.d.ts

@@ -19,7 +19,7 @@
 // TypeScript Version: 2.0
 
 /**
-* Truncate the Unicode code points of a provided string in order to return a string having a specified length.
+* Truncate the Unicode code points of a provided string in order to return a string having a specified number of Unicode code points.
 *
 * @param str - input string
 * @param len - output string length (including ending)

lib/node_modules/@stdlib/string/base/truncate-code-points/lib/index.js

@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* Truncate the Unicode code points of a provided string in order to return a string having a specified length.
+* Truncate the Unicode code points of a provided string in order to return a string having a specified number of Unicode code points.
 *
 * @module @stdlib/string/base/truncate-code-points
 *

lib/node_modules/@stdlib/string/base/truncate-code-points/lib/main.js

@@ -32,7 +32,7 @@ var RE_UTF16_HIGH_SURROGATE = /[\uD800-\uDBFF]/; // TODO: replace with stdlib pk
 // MAIN //
 
 /**
-* Truncates the Unicode code points of a provided string in order to return a string having a specified length.
+* Truncates the Unicode code points of a provided string in order to return a string having a specified number of Unicode code points.
 *
 * @param {string} str - input string
 * @param {NonNegativeInteger} len - output string length (including ending)

lib/node_modules/@stdlib/string/base/truncate-code-points/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/string/base/truncate-code-points",
   "version": "0.0.0",
-  "description": "Truncate the Unicode code points of a provided string in order to return a string having a specified length.",
+  "description": "Truncate the Unicode code points of a provided string in order to return a string having a specified number of Unicode code points.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

lib/node_modules/@stdlib/string/num-code-points/README.md

@@ -2,7 +2,7 @@
 
 @license Apache-2.0
 
-Copyright (c) 2020 The Stdlib Authors.
+Copyright (c) 2023 The Stdlib Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -40,6 +40,9 @@ var out = numCodePoints( 'last man standing' );
 
 out = numCodePoints( 'Hidden Treasures' );
 // returns 16
+
+out = numCodePoints( '𐒻𐓟𐒻𐓟' );
+// returns 4
 ```
 
 </section>
@@ -55,14 +58,17 @@ out = numCodePoints( 'Hidden Treasures' );
 ```javascript
 var numCodePoints = require( '@stdlib/string/num-code-points' );
 
-var str = numCodePoints( 'last man standing' );
+var out = numCodePoints( 'last man standing' );
 // returns 17
 
-str = numCodePoints( '六书/六書' );
+out = numCodePoints( '六书/六書' );
 // returns 5
 
-str = numCodePoints( 'अनुच्छेद' );
+out = numCodePoints( 'अनुच्छेद' );
 // returns 8
+
+out = numCodePoints( '𐒻𐓟𐒻𐓟' );
+// returns 4
 ```
 
 </section>

lib/node_modules/@stdlib/string/num-code-points/benchmark/benchmark.js

@@ -21,30 +21,42 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var fromCodePoint = require( '@stdlib/string/from-code-point' );
-var UNICODE_MAX = require( '@stdlib/constants/unicode/max' );
-var randu = require( '@stdlib/random/base/randu' );
-var floor = require( '@stdlib/math/base/special/floor' );
+var isInteger = require( '@stdlib/assert/is-integer' );
 var pkg = require( './../package.json' ).name;
 var numCodePoints = require( './../lib' );
 
 
 // MAIN //
 
 bench( pkg, function benchmark( b ) {
-	var str;
+	var strings;
 	var out;
 	var i;
 
+	strings = [
+		'last man standing',
+		'presidential election',
+		'अनुच्छेद',
+		'🌷',
+		'书/六書',
+		'เ❄︎நி',
+		'กิิก้้ก็็ก็็กิิก้้ก็็กิิก้้กิิก้้ก็็ก็็กิิก้้ก็็กิิก้้',
+		'書六/书六',
+		'ܶƔλʃݖͱšɕ҆ʧѸؐҜҦɳΏ',
+		'âݝΝ‚ҳӌݾҀƳ۵ۧ޳ǁǸΓ'
+	];
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		str = fromCodePoint( floor( randu() * UNICODE_MAX ) ) + 'eep boop';
-		out = numCodePoints( str );
+		out = numCodePoints( strings[ i%strings.length ] );
 		if ( out < 0 ) {
 			b.fail( 'should never be a negative integer' );
 		}
 	}
 	b.toc();
+	if ( !isInteger( out ) ) {
+		b.fail( 'should return an integer' );
+	}
 	b.pass( 'benchmark finished' );
 	b.end();
 });

lib/node_modules/@stdlib/string/num-code-points/bin/cli

@@ -28,6 +28,8 @@ var CLI = require( '@stdlib/cli/ctor' );
 var stdin = require( '@stdlib/process/read-stdin' );
 var stdinStream = require( '@stdlib/streams/node/stdin' );
 var RE_EOL = require( '@stdlib/regexp/eol' ).REGEXP;
+var isRegExpString = require( '@stdlib/assert/is-regexp-string' );
+var reFromString = require( '@stdlib/utils/regexp-from-string' );
 var numCodePoints = require( './../lib' );
 
 
@@ -41,10 +43,9 @@ var numCodePoints = require( './../lib' );
 */
 function main() {
 	var flags;
-	var lines;
+	var split;
 	var args;
 	var cli;
-	var i;
 
 	// Create a command-line interface:
 	cli = new CLI({
@@ -66,16 +67,17 @@ function main() {
 
 	// Check if we are receiving data from `stdin`...
 	if ( !stdinStream.isTTY ) {
-		return stdin( onRead );
-	}
-	if ( flags.lines ) {
-		lines = args[ 0 ].split( RE_EOL );
-		for ( i = 0; i < lines.length; i++ ) {
-			console.log( numCodePoints( lines[ i ] ) ); // eslint-disable-line no-console
+		if ( flags.split ) {
+			if ( !isRegExpString( flags.split ) ) {
+				flags.split = '/'+flags.split+'/';
+			}
+			split = reFromString( flags.split );
+		} else {
+			split = RE_EOL;
 		}
-	} else {
-		console.log( numCodePoints( args[ 0 ] ) ); // eslint-disable-line no-console
+		return stdin( onRead );
 	}
+	console.log( numCodePoints( args[ 0 ] ) ); // eslint-disable-line no-console
 
 	/**
 	* Callback invoked upon reading from `stdin`.
@@ -91,14 +93,14 @@ function main() {
 		if ( error ) {
 			return cli.error( error );
 		}
-		data = data.toString();
-		if ( flags.lines ) {
-			lines = data.split( RE_EOL );
-			for ( i = 0; i < lines.length; i++ ) {
-				console.log( numCodePoints( lines[ i ] ) ); // eslint-disable-line no-console
-			}
-		} else {
-			console.log( numCodePoints( data ) ); // eslint-disable-line no-console
+		lines = data.toString().split( split );
+
+		// Remove any trailing separators (e.g., trailing newline)...
+		if ( lines[ lines.length-1 ] === '' ) {
+			lines.pop();
+		}
+		for ( i = 0; i < lines.length; i++ ) {
+			console.log( numCodePoints( lines[ i ] ) ); // eslint-disable-line no-console
 		}
 	}
 }

lib/node_modules/@stdlib/string/num-code-points/examples/index.js

@@ -28,3 +28,6 @@ console.log( numCodePoints( '六书/六書' ) );
 
 console.log( numCodePoints( 'अनुच्छेद' ) );
 // => 8
+
+console.log( numCodePoints( '𐒻𐓟𐒻𐓟' ) );
+// => 4

lib/node_modules/@stdlib/string/num-code-points/lib/main.js

@@ -53,8 +53,6 @@ var RE_UTF16_HIGH_SURROGATE = /[\uD800-\uDBFF]/; // TODO: replace with stdlib pk
 */
 function numCodePoints( str ) {
 	var count;
-	var ch1;
-	var ch2;
 	var i;
 
 	if ( !isString( str ) ) {
@@ -64,18 +62,16 @@ function numCodePoints( str ) {
 
 	// Process the string one Unicode code unit at a time and count UTF-16 surrogate pairs as a single Unicode code point...
 	for ( i = 0; i < str.length; i++ ) {
-		ch1 = str[ i ];
-
 		// Check for a high UTF-16 surrogate...
-		if ( RE_UTF16_HIGH_SURROGATE.test( ch1 ) ) {
+		if ( RE_UTF16_HIGH_SURROGATE.test( str[ i ] ) ) {
 			// Check for an unpaired surrogate at the end of the input string...
 			if ( i === str.length-1 ) {
 				// We found an unpaired surrogate...
+				count += 1;
 				break;
 			}
 			// Check whether the high surrogate is paired with a low surrogate...
-			ch2 = str[ i+1 ];
-			if ( RE_UTF16_LOW_SURROGATE.test( ch2 ) ) {
+			if ( RE_UTF16_LOW_SURROGATE.test( str[ i+1 ] ) ) {
 				// We found a surrogate pair:
 				i += 1; // bump the index to process the next code unit
 				count += 1;

lib/node_modules/@stdlib/string/num-code-points/test/test.cli.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2020 The Stdlib Authors.
+* Copyright (c) 2023 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -175,7 +175,7 @@ tape( 'when invoked with a `-l` flag, the command-line interface prints the numb
 		if ( error ) {
 			t.fail( error.message );
 		} else {
-			t.strictEqual( stdout.toString(), '4\n4\n', 'expected value' );
+			t.strictEqual( stdout.toString(), '9\n', 'expected value' );
 			t.strictEqual( stderr.toString(), '', 'does not print to `stderr`' );
 		}
 		t.end();
@@ -196,7 +196,7 @@ tape( 'the command-line interface supports use as a standard stream', opts, func
 		if ( error ) {
 			t.fail( error.message );
 		} else {
-			t.strictEqual( stdout.toString(), '10\n', 'expected value' );
+			t.strictEqual( stdout.toString(), '4\n5\n', 'expected value' );
 			t.strictEqual( stderr.toString(), '', 'does not print to `stderr`' );
 		}
 		t.end();

lib/node_modules/@stdlib/string/truncate/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # truncate
 
-> Truncate a string to a specified length.
+> Truncate a string.
 
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
 
@@ -40,9 +40,9 @@ limitations under the License.
 var truncate = require( '@stdlib/string/truncate' );
 ```
 
-#### truncate( str, len\[, ending]\[, options] )
+#### truncate( str, N\[, ending]\[, options] )
 
-Truncates a string to a specified length.
+Truncates a string.
 
 ```javascript
 var out = truncate( 'beep boop', 7 );
@@ -146,7 +146,7 @@ Options:
 
   -h,    --help                Print this message.
   -V,    --version             Print the package version.
-         --len length          String length.
+         --N length            String length.
          --ending str          Custom ending. Default: '...'.
          --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.
          --mode mode           Type of character to return. Default: 'grapheme'.
@@ -166,10 +166,10 @@ Options:
 
     ```bash
     # Not escaped...
-    $ echo -n $'Hello, World!\nBeep Boop Baz' | truncate --len 6 --split /\r?\n/
+    $ echo -n $'Hello, World!\nBeep Boop Baz' | truncate --N 6 --split /\r?\n/
 
     # Escaped...
-    $ echo -n $'Hello, World!\nBeep Boop Baz' | truncate --len 6 --split /\\r?\\n/
+    $ echo -n $'Hello, World!\nBeep Boop Baz' | truncate --N 6 --split /\\r?\\n/
     ```
 
 -   The implementation ignores trailing delimiters.
@@ -187,24 +187,24 @@ Options:
 ### Examples
 
 ```bash
-$ truncate 'Hello, World!' --len 8
+$ truncate 'Hello, World!' --N 8
 Hello...
 
-$ truncate 'Hello, World!' --len 6 --ending '!'
+$ truncate 'Hello, World!' --N 6 --ending '!'
 Hello!
 ```
 
 To use as a [standard stream][standard-streams],
 
 ```bash
-$ echo -n 'Hello, World!' | truncate --len 8
+$ echo -n 'Hello, World!' | truncate --N 8
 Hello...
 ```
 
 By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the `split` option.
 
 ```bash
-$ echo -n 'Hello, World!\tBeep Boop' | truncate --split '\t' --len 8
+$ echo -n 'Hello, World!\tBeep Boop' | truncate --split '\t' --N 8
 Hello...
 Beep ...
 ```

lib/node_modules/@stdlib/string/truncate/bin/cli

@@ -78,7 +78,7 @@ function main() {
 	// Get any provided command-line arguments:
 	args = cli.args();
 
-	len = parseInt( flags.len, 10 );
+	len = parseInt( flags.N, 10 );
 
 	// Check if we are receiving data from `stdin`...
 	if ( !stdinStream.isTTY ) {

lib/node_modules/@stdlib/string/truncate/docs/repl.txt

@@ -1,13 +1,13 @@
 
-{{alias}}( str, len[, ending][, options] )
-    Truncates a string to a specified length.
+{{alias}}( str, N[, ending][, options] )
+    Truncates a string.
 
     Parameters
     ----------
     str: string
         Input string.
 
-    len: integer
+    N: integer
         Output string length.
 
     ending: string (optional)