Auto-generated commit

Author: stdlib-bot

.github/.keepalive

@@ -132,12 +132,34 @@ Options:
 
   -h,    --help                Print this message.
   -V,    --version             Print the package version.
+         --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 booP\n100001110' | is-binary-string --split /\r?\n/
+    # Escaped...
+    $ echo -n $'beEp booP\n100001110' | is-binary-string --split /\\r?\\n/
+    ```
+
+-   The implementation ignores trailing delimiters.
+
+</section>
+
+<!-- /.notes -->
+
 <section class="examples">
 
 ### Examples
@@ -154,6 +176,14 @@ $ echo -n '0110' | is-binary-string
 true
 ```
 
+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 '0110\t1234' | is-binary-string --split '\t'
+true
+false
+```
+
 </section>
 
 <!-- /.examples -->
@@ -247,6 +277,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 [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/assert/is-string]: https://github.com/stdlib-js/assert-is-string

README.md

@@ -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 isBinaryString = require( './../lib' );
 
 
@@ -40,6 +42,7 @@ var isBinaryString = require( './../lib' );
 * @returns {void}
 */
 function main() {
+	var split;
 	var flags;
 	var args;
 	var cli;
@@ -64,6 +67,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( isBinaryString( String( args[ 0 ] ) ) ); // eslint-disable-line no-console
@@ -82,7 +93,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( isBinaryString( lines[ i ] ) ); // eslint-disable-line no-console
 		}

bin/cli

@@ -5,4 +5,4 @@ Options:
 
   -h,    --help                Print this message.
   -V,    --version             Print the package version.
-
+         --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.

docs/usage.txt

@@ -1,4 +1,7 @@
 {
+	"string": [
+		"split"
+	],
 	"boolean": [
 		"help",
 		"version"

etc/cli_opts.json

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

lib/index.js

@@ -40,12 +40,14 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
+    "@stdlib/assert-is-regexp-string": "^0.0.x",
     "@stdlib/assert-is-string": "^0.0.x",
     "@stdlib/cli-ctor": "^0.0.x",
     "@stdlib/fs-read-file": "^0.0.x",
     "@stdlib/process-read-stdin": "^0.0.x",
     "@stdlib/regexp-eol": "^0.0.x",
-    "@stdlib/streams-node-stdin": "^0.0.x"
+    "@stdlib/streams-node-stdin": "^0.0.x",
+    "@stdlib/utils-regexp-from-string": "^0.0.x"
   },
   "devDependencies": {
     "@stdlib/assert-is-boolean": "^0.0.x",

package.json

@@ -183,6 +183,50 @@ 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 \'1234\t0110\'',
+		'|',
+		EXEC_PATH,
+		fpath,
+		'--split \'\t\''
+	];
+
+	exec( cmd.join( ' ' ), done );
+
+	function done( error, stdout, stderr ) {
+		if ( error ) {
+			t.fail( error.message );
+		} else {
+			t.strictEqual( stdout.toString(), 'false\ntrue\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 \'1234\t0110\'',
+		'|',
+		EXEC_PATH,
+		fpath,
+		'--split=/\\\\t/'
+	];
+
+	exec( cmd.join( ' ' ), done );
+
+	function done( error, stdout, stderr ) {
+		if ( error ) {
+			t.fail( error.message );
+		} else {
+			t.strictEqual( stdout.toString(), 'false\ntrue\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;