Add split option support

Planeshifter · Planeshifter · commit 6a4a33014640 · 2021-11-06T18:40:30.000-04:00
diff --git a/lib/node_modules/@stdlib/string/pad/README.md b/lib/node_modules/@stdlib/string/pad/README.md
@@ -212,12 +212,35 @@ Options:
          --lpad str            String used to left pad. Default: ''.
          --rpad str            String used to right pad. Default: ' '.
          --cright              Center right in the event of a tie.
+         --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.
 ```
 
 </section>
 
 <!-- /.usage -->
 
+<!-- CLI usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+### Notes
+
+-   If the split separator is a [regular expression][mdn-regexp], ensure that the `split` option is either properly escaped or enclosed in quotes.
+
+    ```bash
+    # Not escaped...
+    $ echo -n $'beep\nboop' | padstr --len 10 --split /\r?\n/
+
+    # Escaped...
+    $ echo -n $'beep\nboop' | padstr --len 10 --split /\\r?\\n/
+    ```
+
+-   The implementation ignores trailing delimiters.
+
+</section>
+
+<!-- /.notes -->
+
 <section class="examples">
 
 ### Examples
@@ -231,7 +254,15 @@ To use as a [standard stream][standard-streams],
 
 ```bash
 $ echo -n 'beep' | pad --len 9 --lpad a --rpad o
-aabeepoo0
+aabeepooo
+```
+
+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 'beep\tboop' | pad --len 9 --lpad a --rpad o --split '\t'
+aabeepooo
+aaboopooo
 ```
 
 </section>
@@ -263,6 +294,8 @@ aabeepoo0
 
 [standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
 
+[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
+
 <!-- <related-links> -->
 
 [@stdlib/string/left-pad]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/left-pad
diff --git a/lib/node_modules/@stdlib/string/pad/bin/cli b/lib/node_modules/@stdlib/string/pad/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 pad = require( './../lib' );
 
 
@@ -85,6 +87,14 @@ function main() {
 
 	// Check if we are receiving data from `stdin`...
 	if ( !stdinStream.isTTY ) {
+		if ( flags.split ) {
+			if ( !isRegExpString( flags.split ) ) {
+				flags.split = '/'+flags.split+'/';
+			}
+			opts.split = reFromString( flags.split );
+		} else {
+			opts.split = RE_EOL;
+		}
 		return stdin( onRead );
 	}
 	console.log( pad( str, len, opts ) ); // eslint-disable-line no-console
@@ -103,7 +113,12 @@ function main() {
 		if ( error ) {
 			return cli.error( error );
 		}
-		lines = data.toString().split( RE_EOL );
+		lines = data.toString().split( opts.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( pad( lines[ i ], len, opts ) ); // eslint-disable-line no-console
 		}
diff --git a/lib/node_modules/@stdlib/string/pad/docs/usage.txt b/lib/node_modules/@stdlib/string/pad/docs/usage.txt
@@ -9,3 +9,4 @@ Options:
          --lpad str            String used to left pad. Default: ''.
          --rpad str            String used to right pad. Default: ' '.
          --cright              Center right in the event of a tie.
+         --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.
diff --git a/lib/node_modules/@stdlib/string/pad/etc/cli_opts.json b/lib/node_modules/@stdlib/string/pad/etc/cli_opts.json
@@ -7,7 +7,8 @@
 	"string": [
 		"len",
 		"lpad",
-		"rpad"
+		"rpad",
+		"split"
 	],
 	"alias": {
 		"help": [
diff --git a/lib/node_modules/@stdlib/string/pad/test/test.cli.js b/lib/node_modules/@stdlib/string/pad/test/test.cli.js
@@ -232,6 +232,56 @@ tape( 'the command-line interface supports use as a standard stream', opts, func
 	}
 });
 
+tape( 'the command-line interface supports specifying a custom delimiter when used as a standard stream (string)', opts, function test( t ) {
+	var cmd = [
+		'printf \'beep\tboop\'',
+		'|',
+		EXEC_PATH,
+		fpath,
+		'--split \'\t\'',
+		'--len=6',
+		'--rpad=!',
+		'--lpad=%'
+	];
+
+	exec( cmd.join( ' ' ), done );
+
+	function done( error, stdout, stderr ) {
+		if ( error ) {
+			t.fail( error.message );
+		} else {
+			t.strictEqual( stdout.toString(), '%beep!\n%boop!\n', 'expected value' );
+			t.strictEqual( stderr.toString(), '', 'does not print to `stderr`' );
+		}
+		t.end();
+	}
+});
+
+tape( 'the command-line interface supports specifying a custom delimiter when used as a standard stream (regexp)', opts, function test( t ) {
+	var cmd = [
+		'printf \'beep\tboop\'',
+		'|',
+		EXEC_PATH,
+		fpath,
+		'--split=/\\\\t/',
+		'--len=6',
+		'--rpad=!',
+		'--lpad=%'
+	];
+
+	exec( cmd.join( ' ' ), done );
+
+	function done( error, stdout, stderr ) {
+		if ( error ) {
+			t.fail( error.message );
+		} else {
+			t.strictEqual( stdout.toString(), '%beep!\n%boop!\n', 'expected value' );
+			t.strictEqual( stderr.toString(), '', 'does not print to `stderr`' );
+		}
+		t.end();
+	}
+});
+
 tape( 'when used as a standard stream, if an error is encountered when reading from `stdin`, the command-line interface prints an error and sets a non-zero exit code', opts, function test( t ) {
 	var script;
 	var opts;
