Add split option support

Author: Planeshifter

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

@@ -116,12 +116,35 @@ Options:
   -V,    --version             Print the package version.
          --search string       Search string.
          --newval string       Replacement string.
+         --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 $'foo\nbar' | replace --search='o' --newval='e' --split /\r?\n/
+
+    # Escaped...
+    $ echo -n $'foo\nbar' | replace --search='o' --newval='e' --split /\\r?\\n/
+    ```
+
+-   The implementation ignores trailing delimiters.
+
+</section>
+
+<!-- /.notes -->
+
 <section class="examples">
 
 ### Examples
@@ -134,10 +157,18 @@ baap
 To use as a [standard stream][standard-streams],
 
 ```bash
-$ echo -n 'boop' | replace --search='o' newval='e'
+$ echo -n 'boop' | replace --search='o' --newval='e'
 beep
 ```
 
+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 'boop\tfoo' | replace --search='o' --newval='e' --split '\t'
+beep
+fee
+```
+
 </section>
 
 <!-- /.examples -->
@@ -162,6 +193,8 @@ beep
 
 [standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
 
+[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
+
 </section>
 
 <!-- /.links -->

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

@@ -43,6 +43,7 @@ var replace = require( './../lib' );
 */
 function main() {
 	var search;
+	var split;
 	var flags;
 	var args;
 	var cli;
@@ -72,6 +73,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+'/';
+			}
+			split = reFromString( flags.split );
+		} else {
+			split = RE_EOL;
+		}
 		return stdin( onRead );
 	}
 	console.log( replace( args[ 0 ], search, flags.newval ) ); // eslint-disable-line no-console
@@ -90,7 +99,12 @@ function main() {
 		if ( error ) {
 			return cli.error( error );
 		}
-		lines = data.toString().split( RE_EOL );
+		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( replace( lines[ i ], search, flags.newval ) ); // eslint-disable-line no-console
 		}

lib/node_modules/@stdlib/string/replace/docs/usage.txt

@@ -7,3 +7,4 @@ Options:
   -V,    --version             Print the package version.
          --search string       Search string.
          --newval string       Replacement string.
+         --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.

lib/node_modules/@stdlib/string/replace/etc/cli_opts.json

@@ -5,7 +5,8 @@
 	],
 	"string": [
 		"search",
-		"newval"
+		"newval",
+		"split"
 	],
 	"alias": {
 		"help": [

lib/node_modules/@stdlib/string/replace/test/test.cli.js

@@ -209,6 +209,54 @@ 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 \'a11y\ti18n\ta16z\'',
+		'|',
+		EXEC_PATH,
+		fpath,
+		'--search=/[0-9]/g',
+		'--newval=""',
+		'--split \'\t\''
+	];
+
+	exec( cmd.join( ' ' ), done );
+
+	function done( error, stdout, stderr ) {
+		if ( error ) {
+			t.fail( error.message );
+		} else {
+			t.strictEqual( stdout.toString(), 'ay\nin\naz\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 \'a11y\ti18n\ta16z\'',
+		'|',
+		EXEC_PATH,
+		fpath,
+		'--search=/[0-9]/g',
+		'--newval=""',
+		'--split=/\\\\t/'
+	];
+
+	exec( cmd.join( ' ' ), done );
+
+	function done( error, stdout, stderr ) {
+		if ( error ) {
+			t.fail( error.message );
+		} else {
+			t.strictEqual( stdout.toString(), 'ay\nin\naz\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;