@stdlib/string-ends-with 0.0.4 → 0.0.8

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2021 The Stdlib Authors.
+Copyright (c) 2016-2022 The Stdlib Authors.

package/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # endsWith
 
-[![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] -->
 
 > Test if a string ends with the characters of another string.
 
@@ -136,6 +136,8 @@ npm install -g @stdlib/string-ends-with
 
 </section>
 
+<!-- CLI usage documentation. -->
+
 <section class="usage">
 
 ### Usage
@@ -149,12 +151,37 @@ Options:
   -V,    --version             Print the package version.
          --search string       Search string.
          --len int             Substring length.
+         --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 $'Hello, World!\nBeep Boop Baz' | ends-with --search=Beep --split /\r?\n/
+
+    # Escaped...
+    $ echo -n $'Hello, World!\nBeep Boop Baz' | ends-with --search=Beep --split /\\r?\\n/
+    ```
+
+-   The implementation ignores trailing delimiters.
+
+</section>
+
+</section>
+
+<!-- /.notes -->
+
 <section class="examples">
 
 ### Examples
@@ -171,6 +198,14 @@ $ echo -n 'boop' | ends-with --search=ep
 false
 ```
 
+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' | ends-with --search=Boop --split '\t'
+false
+true
+```
+
 </section>
 
 <!-- /.examples -->
@@ -179,6 +214,22 @@ false
 
 <!-- /.cli -->
 
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/string/starts-with`][@stdlib/string/starts-with]</span><span class="delimiter">: </span><span class="description">test if a string starts with the characters of another string.</span>
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
 
 <section class="main-repo" >
 
@@ -203,7 +254,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -222,9 +273,20 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-ends-with/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/string-ends-with?branch=main
 
+<!--
+
 [dependencies-image]: https://img.shields.io/david/stdlib-js/string-ends-with.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/string-ends-with/main
 
+-->
+
+[umd]: https://github.com/umdjs/umd
+[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+
+[deno-url]: https://github.com/stdlib-js/string-ends-with/tree/deno
+[umd-url]: https://github.com/stdlib-js/string-ends-with/tree/umd
+[esm-url]: https://github.com/stdlib-js/string-ends-with/tree/esm
+
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
 [chat-url]: https://gitter.im/stdlib-js/stdlib/
 
@@ -236,6 +298,14 @@ Copyright &copy; 2016-2021. 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/string/starts-with]: https://www.npmjs.com/package/@stdlib/string-starts-with
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

package/bin/cli

@@ -24,10 +24,12 @@
 
 var resolve = require( 'path' ).resolve;
 var readFileSync = require( '@stdlib/fs-read-file' ).sync;
-var CLI = require( '@stdlib/cli' );
+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 endsWith = require( './../lib' );
 
 
@@ -40,6 +42,7 @@ var endsWith = require( './../lib' );
 * @returns {void}
 */
 function main() {
+	var split;
 	var flags;
 	var args;
 	var cli;
@@ -77,6 +80,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( endsWith( str, flags.search, len ) ); // eslint-disable-line no-console
@@ -95,7 +106,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++ ) {
 			if ( !len ) {
 				len = lines[ i ].length;

package/docs/usage.txt

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

package/etc/cli_opts.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/string-ends-with",
-  "version": "0.0.4",
+  "version": "0.0.8",
   "description": "Test if a string ends with the characters of another string.",
   "license": "Apache-2.0",
   "author": {
@@ -19,7 +19,6 @@
   "main": "./lib",
   "directories": {
     "benchmark": "./benchmark",
-    "bin": "./bin",
     "doc": "./docs",
     "example": "./examples",
     "lib": "./lib",
@@ -42,12 +41,14 @@
   },
   "dependencies": {
     "@stdlib/assert-is-integer": "^0.0.x",
+    "@stdlib/assert-is-regexp-string": "^0.0.x",
     "@stdlib/assert-is-string": "^0.0.x",
-    "@stdlib/cli": "^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/CHANGELOG.md

@@ -1,5 +0,0 @@
-# CHANGELOG
-
-> Package changelog.
-
-See [GitHub Releases](https://github.com/stdlib-js/string-ends-with/releases) for the changelog.