Add base utility to convert a string to kebab-case

Author: kgryte

lib/node_modules/@stdlib/string/base/kebabcase/README.md

@@ -0,0 +1,106 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2022 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.
+
+-->
+
+# kebabcase
+
+> Convert a string to kebab case.
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var kebabcase = require( '@stdlib/string/base/kebabcase' );
+```
+
+#### kebabcase( str )
+
+Converts a string to kebab case.
+
+```javascript
+var str = kebabcase( 'Foo Bar' );
+// returns 'foo-bar'
+
+str = kebabcase( 'I am a tiny little house' );
+// returns 'i-am-a-tiny-little-house'
+
+str = kebabcase( 'Hello World!' );
+// returns 'hello-world'
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+```javascript
+var kebabcase = require( '@stdlib/string/base/kebabcase' );
+
+var str = 'foo bar baz';
+var out = kebabcase( str );
+// returns 'foo-bar-baz'
+
+str = 'foo_baz';
+out = kebabcase( str );
+// returns 'foo-baz'
+
+str = 'foo-bar-baz!';
+out = kebabcase( str );
+// returns 'foo-bar-baz'
+
+str = 'beep    boop!';
+out = kebabcase( str );
+// returns 'beep-boop'
+
+str = 'foo-baz';
+out = kebabcase( str );
+// returns 'foo-baz'
+
+str = 'Welcome! 😀';
+out = kebabcase( str );
+// returns 'welcome-😀'
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</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="links">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/string/base/kebabcase/benchmark/benchmark.js

@@ -0,0 +1,55 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2022 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 bench = require( '@stdlib/bench' );
+var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
+var pkg = require( './../package.json' ).name;
+var kebabcase = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var values;
+	var out;
+	var i;
+
+	values = [
+		'beep boop',
+		'foo bar',
+		'xyz abc'
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = kebabcase( values[ i%values.length ] );
+		if ( typeof out !== 'string' ) {
+			b.fail( 'should return a string' );
+		}
+	}
+	b.toc();
+	if ( !isString( out ) ) {
+		b.fail( 'should return a string' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/string/base/kebabcase/docs/repl.txt

@@ -0,0 +1,23 @@
+
+{{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
+    --------

lib/node_modules/@stdlib/string/base/kebabcase/docs/types/index.d.ts

@@ -0,0 +1,44 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2022 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.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Converts a string to kebab case.
+*
+* @param str - string to convert
+* @returns kebab-cased string
+*
+* @example
+* var str = kebabcase( 'fooBar' );
+* // returns 'foo-bar'
+*
+* @example
+* var str = kebabcase( 'foo_bar' );
+* // returns 'foo-bar'
+*
+* @example
+* var str = kebabcase( 'foo-bar' );
+* // returns 'foo-bar'
+*/
+declare function kebabcase( str: string ): string;
+
+
+// EXPORTS //
+
+export = kebabcase;

lib/node_modules/@stdlib/string/base/kebabcase/docs/types/test.ts

@@ -0,0 +1,44 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2022 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 compiler throws an error if the function is 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 compiler throws an error if the function is provided insufficient arguments...
+{
+	kebabcase(); // $ExpectError
+}

lib/node_modules/@stdlib/string/base/kebabcase/examples/index.js

@@ -0,0 +1,51 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2022 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';
+
+var kebabcase = require( './../lib' );
+
+var str = 'foo bar baz';
+var out = kebabcase( str );
+console.log( out );
+// => 'foo-bar-baz'
+
+str = 'foo_baz';
+out = kebabcase( str );
+console.log( out );
+// => 'foo-baz'
+
+str = 'foo-bar-baz!';
+out = kebabcase( str );
+console.log( out );
+// => 'foo-bar-baz'
+
+str = 'beep    boop!';
+out = kebabcase( str );
+console.log( out );
+// => 'beep-boop'
+
+str = 'foo-baz';
+out = kebabcase( str );
+console.log( out );
+// => 'foo-baz'
+
+str = 'Welcome! 😀';
+out = kebabcase( str );
+console.log( out );
+// => 'welcome-😀'

lib/node_modules/@stdlib/string/base/kebabcase/lib/index.js

@@ -0,0 +1,43 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2022 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';
+
+/**
+* Convert a string to kebab case.
+*
+* @module @stdlib/string/base/kebabcase
+*
+* @example
+* var kebabcase = require( '@stdlib/string/base/kebabcase' );
+*
+* var str = kebabcase( 'Foo Bar' );
+* // returns 'foo-bar'
+*
+* str = kebabcase( 'I am a tiny little house' );
+* // returns 'i-am-a-tiny-little-house'
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;