Auto-generated commit

Author: stdlib-bot

CONTRIBUTORS

@@ -16,6 +16,7 @@ Justin Dennison <[email protected]>
 Marcus <[email protected]>
 Matt Cochrane <[email protected]>
 Milan Raj <[email protected]>
+Momtchil Momtchev <[email protected]>
 Ognjen Jevremović <[email protected]>
 Philipp Burckhardt <[email protected]>
 Ricky Reusser <[email protected]>

README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # substringBeforeLast
 
-[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
 
 > Return the part of a string before the last occurrence of a specified substring.
 
@@ -143,6 +143,7 @@ Options:
   -h,    --help                Print this message.
   -V,    --version             Print the package version.
          --search string       Search string.
+         --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.
 ```
 
 </section>
@@ -153,6 +154,20 @@ Options:
 
 <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\nbaz' | substring-before-last --search a --split /\r?\n/
+
+    # Escaped...
+    $ echo -n $'foo\nbar\nbaz' | substring-before-last --search a --split /\\r?\\n/
+    ```
+
+-   The implementation ignores trailing delimiters.
+
 </section>
 
 <!-- /.notes -->
@@ -168,6 +183,22 @@ $ substring-before-last abcdefg --search d
 abc
 ```
 
+To use as a [standard stream][standard-streams],
+
+```bash
+$ echo -n $'beep\nboop' | substring-before-last --search p
+bee
+boo
+```
+
+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' | substring-before-last --search p --split '\t'
+bee
+boo
+```
+
 </section>
 
 <!-- /.examples -->
@@ -245,9 +276,13 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-substring-before-last/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/string-substring-before-last?branch=main
 
+<!--
+
 [dependencies-image]: https://img.shields.io/david/stdlib-js/string-substring-before-last.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/string-substring-before-last/main
 
+-->
+
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
 [chat-url]: https://gitter.im/stdlib-js/stdlib/
 
@@ -257,6 +292,10 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-substring-before-last/main/LICENSE
 
+[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/substring-before]: https://github.com/stdlib-js/string-substring-before

bin/cli

@@ -27,7 +27,9 @@ var readFileSync = require( '@stdlib/fs-read-file' ).sync;
 var CLI = require( '@stdlib/cli-ctor' );
 var stdin = require( '@stdlib/process-read-stdin' );
 var stdinStream = require( '@stdlib/streams-node-stdin' );
-var reEOL = require( '@stdlib/regexp-eol' );
+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 substringBeforeLast = require( './../lib' );
 
 
@@ -40,6 +42,7 @@ var substringBeforeLast = require( './../lib' );
 * @returns {void}
 */
 function main() {
+	var split;
 	var flags;
 	var args;
 	var cli;
@@ -71,6 +74,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( substringBeforeLast( str, flags.search ) ); // eslint-disable-line no-console
@@ -89,7 +100,12 @@ function main() {
 		if ( error ) {
 			return cli.error( error );
 		}
-		lines = data.toString().split( reEOL.REGEXP );
+		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( substringBeforeLast( lines[ i ], flags.search ) ); // eslint-disable-line no-console
 		}

docs/usage.txt

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

etc/cli_opts.json

@@ -1,6 +1,7 @@
 {
 	"string": [
-		"search"
+		"search",
+		"split"
 	],
 	"boolean": [
 		"help",

package.json

@@ -40,13 +40,15 @@
     "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/types": "^0.0.x"
+    "@stdlib/types": "^0.0.x",
+    "@stdlib/utils-regexp-from-string": "^0.0.x"
   },
   "devDependencies": {
     "@stdlib/assert-is-browser": "^0.0.x",

test/test.cli.js

@@ -186,6 +186,52 @@ 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 boop\tboop beep\'',
+		'|',
+		EXEC_PATH,
+		fpath,
+		'--search="e"',
+		'--split \'\t\''
+	];
+
+	exec( cmd.join( ' ' ), done );
+
+	function done( error, stdout, stderr ) {
+		if ( error ) {
+			t.fail( error.message );
+		} else {
+			t.strictEqual( stdout.toString(), 'be\nboop be\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 boop\tboop beep\'',
+		'|',
+		EXEC_PATH,
+		fpath,
+		'--search="e"',
+		'--split=/\\\\t/'
+	];
+
+	exec( cmd.join( ' ' ), done );
+
+	function done( error, stdout, stderr ) {
+		if ( error ) {
+			t.fail( error.message );
+		} else {
+			t.strictEqual( stdout.toString(), 'be\nboop be\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;