@stdlib/string-kebabcase 0.0.4 → 0.0.6

package/NOTICE

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

package/README.md

@@ -101,110 +101,19 @@ out = kebabcase( str );
 
 <!-- /.examples -->
 
-* * *
-
-<section class="cli">
-
-## CLI
-
-<section class="installation">
-
-## Installation
-
-To use the module as a general utility, install the module globally
-
-```bash
-npm install -g @stdlib/string-kebabcase
-```
-
-</section>
-
-<!-- CLI usage documentation. -->
-
-<section class="usage">
-
-### Usage
-
-```text
-Usage: kebabcase [options] [<string>]
-
-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
-
-```bash
-$ kebabcase 'hello world!'
-hello-world
-```
-
-To use as a [standard stream][standard-streams],
-
-```bash
-$ 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 -->
-
-</section>
-
-<!-- /.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>
+-   <span class="package-name">[`@stdlib/string-kebabcase-cli`][@stdlib/string-kebabcase-cli]</span><span class="delimiter">: </span><span class="description">CLI package for use as a command-line utility.</span>
+-   <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>
 
@@ -236,7 +145,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -246,11 +155,13 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 <section class="links">
 
+[@stdlib/string-kebabcase-cli]: https://www.npmjs.com/package/@stdlib/string-kebabcase-cli
+
 [npm-image]: http://img.shields.io/npm/v/@stdlib/string-kebabcase.svg
 [npm-url]: https://npmjs.org/package/@stdlib/string-kebabcase
 
-[test-image]: https://github.com/stdlib-js/string-kebabcase/actions/workflows/test.yml/badge.svg?branch=v0.0.4
-[test-url]: https://github.com/stdlib-js/string-kebabcase/actions/workflows/test.yml?query=branch:v0.0.4
+[test-image]: https://github.com/stdlib-js/string-kebabcase/actions/workflows/test.yml/badge.svg?branch=v0.0.6
+[test-url]: https://github.com/stdlib-js/string-kebabcase/actions/workflows/test.yml?query=branch:v0.0.6
 
 [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
@@ -263,12 +174,16 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 -->
 
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 
 [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
 
+[cli-section]: https://github.com/stdlib-js/string-kebabcase#cli
+[cli-url]: https://github.com/stdlib-js/string-kebabcase/tree/cli
+[@stdlib/string-kebabcase]: https://github.com/stdlib-js/string-kebabcase/tree/main
+
 [umd]: https://github.com/umdjs/umd
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import alias from '../docs/index';
+export = alias;

package/dist/index.js

@@ -0,0 +1,3 @@
+"use strict";var a=(r,e)=>()=>(e||r((e={exports:{}}).exports,e),e.exports);var t=a((b,i)=>{"use strict";var s=require("@stdlib/assert-is-string/dist").isPrimitive,u=require("@stdlib/error-tools-fmtprodmsg/dist"),n=require("@stdlib/string-base-kebabcase/dist");function o(r){if(!s(r))throw new TypeError(u("1Oj3B",r));return n(r)}i.exports=o});var v=t();module.exports=v;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../tmp/main.js", "../tmp/index.js"],
+  "sourcesContent": ["/** @license Apache-2.0 */\n'use strict';\nvar isString = require( '@stdlib/assert-is-string/dist' ).isPrimitive;\nvar format = require( '@stdlib/error-tools-fmtprodmsg/dist' );\nvar base = require( '@stdlib/string-base-kebabcase/dist' );\nfunction kebabCase(str) {\n\tif ( !isString( str ) ) {\n\t\tthrow new TypeError( format( '1Oj3B', str ) );\n\t}\n\treturn base( str );\n}\nmodule.exports = kebabCase;\n", "/** @license Apache-2.0 */\n'use strict';\nvar main = require( './main.js' );\nmodule.exports = main;\n"],
+  "mappings": "2EAAA,IAAAA,EAAAC,EAAA,CAAAC,EAAAC,IAAA,cAEA,IAAIC,EAAW,QAAS,+BAAgC,EAAE,YACtDC,EAAS,QAAS,qCAAsC,EACxDC,EAAO,QAAS,oCAAqC,EACzD,SAASC,EAAUC,EAAK,CACvB,GAAK,CAACJ,EAAUI,CAAI,EACnB,MAAM,IAAI,UAAWH,EAAQ,QAASG,CAAI,CAAE,EAE7C,OAAOF,EAAME,CAAI,CAClB,CACAL,EAAO,QAAUI,ICTjB,IAAIE,EAAO,IACX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isString", "format", "base", "kebabCase", "str", "main"]
+}

package/docs/types/index.d.ts

@@ -22,7 +22,7 @@
 * Converts a string to kebab case.
 *
 * @param str - string to convert
-* @returns a kebab-cased string
+* @returns kebab-cased string
 *
 * @example
 * var str = kebabcase( 'fooBar' );

package/lib/index.js

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

package/lib/main.js

@@ -21,17 +21,8 @@
 // MODULES //
 
 var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
-var lowercase = require( '@stdlib/string-lowercase' );
-var replace = require( '@stdlib/string-replace' );
 var format = require( '@stdlib/string-format' );
-var trim = require( '@stdlib/string-trim' );
-
-
-// VARIABLES //
-
-var RE_WHITESPACE = /\s+/g;
-var RE_SPECIAL = /[!"'(),–.:;<>?`{}|~\/\\\[\]_#$*&^@%]+/g; // eslint-disable-line no-useless-escape
-var RE_CAMEL = /([a-z0-9])([A-Z])/g;
+var base = require( '@stdlib/string-base-kebabcase' );
 
 
 // MAIN //
@@ -40,7 +31,7 @@ var RE_CAMEL = /([a-z0-9])([A-Z])/g;
 * Converts a string to kebab case.
 *
 * @param {string} str - string to convert
-* @throws {TypeError} must provide a string primitive
+* @throws {TypeError} must provide a string
 * @returns {string} kebab-cased string
 *
 * @example
@@ -67,11 +58,7 @@ function kebabCase( str ) {
 	if ( !isString( str ) ) {
 		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) );
 	}
-	str = replace( str, RE_SPECIAL, ' ' );
-	str = replace( str, RE_CAMEL, '$1 $2' );
-	str = trim( str );
-	str = replace( str, RE_WHITESPACE, '-' );
-	return lowercase( str );
+	return base( str );
 }
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/string-kebabcase",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Convert a string to kebab case.",
   "license": "Apache-2.0",
   "author": {
@@ -13,9 +13,6 @@
       "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
     }
   ],
-  "bin": {
-    "kebabcase": "./bin/cli"
-  },
   "main": "./lib",
   "directories": {
     "benchmark": "./benchmark",
@@ -40,29 +37,16 @@
     "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/string-format": "^0.0.x",
-    "@stdlib/string-lowercase": "^0.0.x",
-    "@stdlib/string-replace": "^0.0.x",
-    "@stdlib/string-trim": "^0.0.x",
-    "@stdlib/utils-regexp-from-string": "^0.0.x"
+    "@stdlib/assert-is-string": "^0.0.8",
+    "@stdlib/string-base-kebabcase": "^0.0.2",
+    "@stdlib/string-format": "^0.0.3",
+    "@stdlib/error-tools-fmtprodmsg": "^0.0.2"
   },
   "devDependencies": {
-    "@stdlib/assert-is-browser": "^0.0.x",
-    "@stdlib/assert-is-windows": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/process-exec-path": "^0.0.x",
-    "@stdlib/string-from-code-point": "^0.0.x",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "proxyquire": "^2.0.0",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -94,7 +78,7 @@
   ],
   "__stdlib__": {},
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/bin/cli

@@ -1,108 +0,0 @@
-#!/usr/bin/env node
-
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2021 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-'use strict';
-
-// MODULES //
-
-var resolve = require( 'path' ).resolve;
-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 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' );
-
-
-// MAIN //
-
-/**
-* Main execution sequence.
-*
-* @private
-* @returns {void}
-*/
-function main() {
-	var split;
-	var flags;
-	var args;
-	var cli;
-
-	// Create a command-line interface:
-	cli = new CLI({
-		'pkg': require( './../package.json' ),
-		'options': require( './../etc/cli_opts.json' ),
-		'help': readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
-			'encoding': 'utf8'
-		})
-	});
-
-	// Get any provided command-line options:
-	flags = cli.flags();
-	if ( flags.help || flags.version ) {
-		return;
-	}
-
-	// Get any provided command-line arguments:
-	args = cli.args();
-
-	// 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
-
-	/**
-	* Callback invoked upon reading from `stdin`.
-	*
-	* @private
-	* @param {(Error|null)} error - error object
-	* @param {Buffer} data - data
-	* @returns {void}
-	*/
-	function onRead( error, data ) {
-		var lines;
-		var i;
-		if ( error ) {
-			return cli.error( error );
-		}
-		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
-		}
-	}
-}
-
-main();

package/docs/repl.txt

@@ -1,23 +0,0 @@
-
-{{alias}}( str )
-    Converts a string to kebab case.
-
-    Parameters
-    ----------
-    str: string
-        Input string.
-
-    Returns
-    -------
-    out: string
-        Kebab-cased string.
-
-    Examples
-    --------
-    > var out = {{alias}}( 'Hello World!' )
-    'hello-world'
-    > out = {{alias}}( 'I am a tiny little teapot' )
-    'i-am-a-tiny-little-teapot'
-
-    See Also
-    --------

package/docs/types/test.ts

@@ -1,44 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2021 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-import kebabcase = require( './index' );
-
-
-// TESTS //
-
-// The function returns a string...
-{
-	kebabcase( 'Hello World!' ); // $ExpectType string
-}
-
-// The function does not compile if provided a value other than a string...
-{
-	kebabcase( true ); // $ExpectError
-	kebabcase( false ); // $ExpectError
-	kebabcase( null ); // $ExpectError
-	kebabcase( undefined ); // $ExpectError
-	kebabcase( 5 ); // $ExpectError
-	kebabcase( [] ); // $ExpectError
-	kebabcase( {} ); // $ExpectError
-	kebabcase( ( x: number ): number => x ); // $ExpectError
-}
-
-// The function does not compile if provided insufficient arguments...
-{
-	kebabcase(); // $ExpectError
-}

package/docs/usage.txt

@@ -1,8 +0,0 @@
-
-Usage: kebabcase [options] [<string>]
-
-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,17 +0,0 @@
-{
-	"string": [
-		"split"
-	],
-	"boolean": [
-		"help",
-		"version"
-	],
-	"alias": {
-		"help": [
-			"h"
-		],
-		"version": [
-			"V"
-		]
-	}
-}