@stdlib/string-kebabcase 0.0.2 → 0.0.3

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.
 
 # kebabcase
 
-[![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] -->
 
 > Convert a string to kebab case.
 
@@ -63,7 +63,6 @@ str = kebabcase( 'Hello World!' );
 
 <!-- /.usage -->
 
-
 <!-- Package usage examples. -->
 
 <section class="examples">
@@ -102,7 +101,6 @@ out = kebabcase( str );
 
 <!-- /.examples -->
 
-
 * * *
 
 <section class="cli">
@@ -121,6 +119,8 @@ npm install -g @stdlib/string-kebabcase
 
 </section>
 
+<!-- CLI usage documentation. -->
+
 <section class="usage">
 
 ### Usage
@@ -132,12 +132,35 @@ 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\nisMobile' | kebabcase --split /\r?\n/
+
+    # Escaped...
+    $ echo -n $'beEp booP\nisMobile' | kebabcase --split /\\r?\\n/
+    ```
+
+-   The implementation ignores trailing delimiters.
+
+</section>
+
+<!-- /.notes -->
+
 <section class="examples">
 
 ### Examples
@@ -154,6 +177,14 @@ $ echo -n 'beEp booP' | kebabcase
 beep-boop
 ```
 
+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_boop\tisMobile' | kebabcase --split '\t'
+beep-boop
+is-mobile
+```
+
 </section>
 
 <!-- /.examples -->
@@ -162,6 +193,25 @@ beep-boop
 
 <!-- /.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/camelcase`][@stdlib/string/camelcase]</span><span class="delimiter">: </span><span class="description">convert a string to camel case.</span>
+-   <span class="package-name">[`@stdlib/string/constantcase`][@stdlib/string/constantcase]</span><span class="delimiter">: </span><span class="description">convert a string to constant case.</span>
+-   <span class="package-name">[`@stdlib/string/pascalcase`][@stdlib/string/pascalcase]</span><span class="delimiter">: </span><span class="description">convert a string to Pascal case.</span>
+-   <span class="package-name">[`@stdlib/string/snakecase`][@stdlib/string/snakecase]</span><span class="delimiter">: </span><span class="description">convert a string to snake case.</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" >
 
@@ -186,7 +236,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>
 
@@ -205,9 +255,20 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-kebabcase/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/string-kebabcase?branch=main
 
+<!--
+
 [dependencies-image]: https://img.shields.io/david/stdlib-js/string-kebabcase.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/string-kebabcase/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-kebabcase/tree/deno
+[umd-url]: https://github.com/stdlib-js/string-kebabcase/tree/umd
+[esm-url]: https://github.com/stdlib-js/string-kebabcase/tree/esm
+
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
 [chat-url]: https://gitter.im/stdlib-js/stdlib/
 
@@ -219,6 +280,20 @@ 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/camelcase]: https://www.npmjs.com/package/@stdlib/string-camelcase
+
+[@stdlib/string/constantcase]: https://www.npmjs.com/package/@stdlib/string-constantcase
+
+[@stdlib/string/pascalcase]: https://www.npmjs.com/package/@stdlib/string-pascalcase
+
+[@stdlib/string/snakecase]: https://www.npmjs.com/package/@stdlib/string-snakecase
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

package/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 kebabcase = require( './../lib' );
 
 
@@ -40,6 +42,7 @@ var kebabcase = 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( kebabcase( args[ 0 ] ) ); // eslint-disable-line no-console
@@ -82,7 +93,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( kebabcase( lines[ i ] ) ); // eslint-disable-line no-console
 		}

package/docs/usage.txt

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

package/etc/cli_opts.json

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

package/lib/main.js

@@ -76,4 +76,4 @@ function kebabCase( str ) {
 
 // EXPORTS //
 
-module.exports= kebabCase;
+module.exports = kebabCase;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/string-kebabcase",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Convert a string to kebab case.",
   "license": "Apache-2.0",
   "author": {
@@ -40,6 +40,7 @@
     "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",
@@ -48,7 +49,8 @@
     "@stdlib/streams-node-stdin": "^0.0.x",
     "@stdlib/string-lowercase": "^0.0.x",
     "@stdlib/string-replace": "^0.0.x",
-    "@stdlib/string-trim": "^0.0.x"
+    "@stdlib/string-trim": "^0.0.x",
+    "@stdlib/utils-regexp-from-string": "^0.0.x"
   },
   "devDependencies": {
     "@stdlib/assert-is-browser": "^0.0.x",