feat: add truncate-middle-grapheme-cluster string package

lib/node_modules/@stdlib/string/base/truncate-middle-grapheme-cluster/README.md

@@ -0,0 +1,104 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2023 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.
+
+-->
+
+# truncateMiddleGraphemeCluster
+
+> Truncate grapheme clusters of string in the middle to a specified length.
+
+<section class="usage">
+
+## Usage
+
+<!-- eslint-disable id-length -->
+
+```javascript
+var truncateMiddleGraphemeCluster = require( '@stdlib/string/base/truncate-middle-grapheme-cluster' );
+```
+
+#### truncateMiddleGraphemeCluster( str, len\[, seq] )
+
+Truncates grapheme clusters of string in the middle to a specified length.
+
+<!-- eslint-disable id-length -->
+
+```javascript
+var out = truncateMiddleGraphemeCluster( 'beep boop', 7 );
+// returns 'be...op'
+```
+
+By default, the truncated string uses the replacement sequence `'...'`. To customize the replacement sequence, provide a `seq` argument:
+
+<!-- eslint-disable id-length -->
+
+```javascript
+var out = truncateMiddleGraphemeCluster( 'beep boop', 7, '!' );
+// returns 'bee!oop'
+
+out = truncateMiddleGraphemeCluster( 'beep boop', 7, '!!!' );
+// returns 'be!!!op'
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+<!-- eslint-disable id-length -->
+
+```javascript
+var truncateMiddleGraphemeCluster = require( '@stdlib/string/truncate-middle-grapheme-cluster' );
+
+var str = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.';
+var out = truncateMiddleGraphemeCluster( str, 15 );
+// returns 'Lorem ... elit.'
+
+str = 'To be or not to be, that is the question';
+out = truncateMiddleGraphemeCluster( str, 19, '|' );
+// returns 'To be or | question'
+
+str = 'The quick fox jumps over the lazy dog.';
+out = truncateMiddleGraphemeCluster( str, 28, '...' );
+// returns 'The quick fox...he lazy dog.'
+```
+
+</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/truncate-middle-grapheme-cluster/benchmark/benchmark.js

@@ -0,0 +1,56 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 truncateMiddle = 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 = truncateMiddle( values[ i%values.length ], 1 );
+		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/truncate-middle-grapheme-cluster/docs/repl.txt

@@ -0,0 +1,31 @@
+
+{{alias}}( str, len[, seq] )
+    Truncate grapheme clusters of string in the middle to a specified length.
+
+    Parameters
+    ----------
+    str: string
+        Input string.
+
+    len: integer
+        Output string length.
+
+    seq: string (optional)
+        Custom replacement sequence. Default: '...'.
+
+    Returns
+    -------
+    out: string
+        Truncated string.
+
+    Examples
+    --------
+    > var str = 'beep boop';
+    > var out = {{alias}}( str, 5 )
+    'b...p'
+
+    > out = {{alias}}( str, 5, '|' )
+    'be|op'
+
+    See Also
+    --------

lib/node_modules/@stdlib/string/base/truncate-middle-grapheme-cluster/docs/types/index.d.ts

@@ -0,0 +1,59 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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: 4.1
+
+/**
+* Truncate grapheme clusters of string in the middle to a specified length.
+*
+* @param str - input string
+* @param len - output string length (including sequence)
+* @param seq - custom replacement sequence (default: `...`)
+* @returns truncated string
+*
+* @example
+* var str = 'beep boop';
+* var out = truncateMiddle( str, 5 );
+* // returns 'b...p'
+*
+* @example
+* var str = 'beep boop';
+* var out = truncateMiddle( str, 5, '>>>' );
+* // returns 'b>>>p'
+*
+* @example
+* var str = 'beep boop';
+* var out = truncateMiddle( str, 10 );
+* // returns 'beep boop'
+*
+* @example
+* var str = 'beep boop';
+* var out = truncateMiddle( str, 0 );
+* // returns ''
+*
+* @example
+* var str = 'beep boop';
+* var out = truncateMiddle( str, 2 );
+* // returns '..'
+*/
+declare function truncateMiddle( str: string, len: number, seq?: string ): string; // tslint-disable-line max-line-length
+
+
+// EXPORTS //
+
+export = truncateMiddle;

lib/node_modules/@stdlib/string/base/truncate-middle-grapheme-cluster/docs/types/test.ts

@@ -0,0 +1,64 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 truncateMiddle = require( './index' );
+
+
+// TESTS //
+
+// The function returns a string...
+{
+	truncateMiddle( 'abcdefghi', 3 ); // $ExpectType string
+	truncateMiddle( 'abcdefghi', 10, '|' ); // $ExpectType string
+}
+
+//  The compiler throws an error if the function is not provided a string as its first argument...
+{
+	truncateMiddle( true, 6 ); // $ExpectError
+	truncateMiddle( false, 6 ); // $ExpectError
+	truncateMiddle( 3, 6 ); // $ExpectError
+	truncateMiddle( [], 6 ); // $ExpectError
+	truncateMiddle( {}, 6 ); // $ExpectError
+	truncateMiddle( ( x: number ): number => x, 6 ); // $ExpectError
+}
+
+//  The compiler throws an error if the function is not provided a number as its second argument...
+{
+	truncateMiddle( 'abd', true ); // $ExpectError
+	truncateMiddle( 'abd', false ); // $ExpectError
+	truncateMiddle( 'abd', 'abc' ); // $ExpectError
+	truncateMiddle( 'abd', [], 0 ); // $ExpectError
+	truncateMiddle( 'abd', {}, 0 ); // $ExpectError
+	truncateMiddle( 'abd', ( x: number ): number => x, 0 ); // $ExpectError
+}
+
+//  The compiler throws an error if the function is not provided a string as its third argument...
+{
+	truncateMiddle( 'beep boop', 4, true ); // $ExpectError
+	truncateMiddle( 'beep boop', 4, false ); // $ExpectError
+	truncateMiddle( 'beep boop', 4, 123 ); // $ExpectError
+	truncateMiddle( 'beep boop', 4, [], 0 ); // $ExpectError
+	truncateMiddle( 'beep boop', 4, {}, 0 ); // $ExpectError
+	truncateMiddle( 'beep boop', 4, ( x: number ): number => x, 0 ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	truncateMiddle(); // $ExpectError
+	truncateMiddle( 'abc', 4, '|', true ); // $ExpectError
+}

lib/node_modules/@stdlib/string/base/truncate-middle-grapheme-cluster/examples/index.js

@@ -0,0 +1,51 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 truncateMiddle = require( './../lib' );
+
+var str = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.';
+var out = truncateMiddle( str, 15 );
+console.log( out );
+// => 'Lorem ... elit.'
+
+str = 'To be or not to be, that is the question';
+out = truncateMiddle( str, 19, '|' );
+console.log( out );
+// => 'To be or | question'
+
+str = 'The quick fox jumps over the lazy dog.';
+out = truncateMiddle( str, 28, '...' );
+console.log( out );
+// => 'The quick fox...he lazy dog.'
+
+str = 'अनुच्छेद';
+out = truncateMiddle( str, 6, '...' );
+console.log( out );
+// => 'अनुच्...छेद'
+
+str = '🐺 Wolf Brothers 🐺';
+out = truncateMiddle( str, 7 );
+console.log( out );
+// => '🐺 ... 🐺'
+
+str = '🐺 Wolf Pack 🐺';
+out = truncateMiddle( str, 7, '🐺🐺🐺' );
+console.log( out );
+// => '🐺 🐺🐺🐺 🐺'