Auto-generated commit

.github/workflows/benchmark.yml

@@ -28,7 +28,7 @@ jobs:
   benchmark:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions/setup-node@v2
         with:
           node-version: 16

.github/workflows/bundle.yml

@@ -25,15 +25,15 @@ on:
   push:
     branches:
       - main
-    tags_ignore:
+    tags-ignore:
       - 'v[0-9]+\.[0-9]+\.[0-9]+'
 
 # Workflow jobs:
 jobs:
   deno:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Copy files to deno directory
         run: |
           mkdir -p deno
@@ -92,7 +92,7 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./deno
           publish_branch: deno
-          keep_files: true
+          force_orphan: true
           user_name: 'stdlib-bot'
           user_email: '[email protected]'
           commit_message: 'Auto-generated commit'
@@ -107,7 +107,7 @@ jobs:
   umd:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Copy files to umd directory
         run: |
           mkdir -p umd
@@ -153,7 +153,7 @@ jobs:
           find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "1 while s/<script type=\"text\/javascript\">\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);?/<script type=\"text\/javascript\" src=\"https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/bundle.js\"><\/script>\n<script type=\"text\/javascript\">/g"
 
           # Wrap contents of `<script type="text/javascript">` tag contents in an IIFE:
-          find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/<script type=\"text\/javascript\">([\s\S]+?)<\/script>/<script type=\"text\/javascript\">\n\(function \(\) {\1}\)\(\)\n<\/script>/g"
+          find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/<script type=\"text\/javascript\">([\s\S]+?)<\/script>/<script type=\"text\/javascript\">\n\(function \(\) {\1}\)\(\);\n<\/script>/g"
 
           # Create package.json file for umd branch:
           jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "main": "./bundle.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./umd/package.json
@@ -164,7 +164,7 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./umd
           publish_branch: umd
-          keep_files: true
+          force_orphan: true
           user_name: 'stdlib-bot'
           user_email: '[email protected]'
           commit_message: 'Auto-generated commit'
@@ -179,7 +179,7 @@ jobs:
   esm:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Copy files to umd directory
         run: |
           mkdir -p esm
@@ -242,7 +242,7 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./esm
           publish_branch: esm
-          keep_files: true
+          force_orphan: true
           user_name: 'stdlib-bot'
           user_email: '[email protected]'
           commit_message: 'Auto-generated commit'

.github/workflows/examples.yml

@@ -28,7 +28,7 @@ jobs:
   examples:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions/setup-node@v2
         with:
           node-version: 16

.github/workflows/publish.yml

@@ -31,7 +31,7 @@ jobs:
     env:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions/setup-node@v2
         with:
           node-version: 16
@@ -63,7 +63,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout main branch
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: main
       - name: Increment version in `package.json` to the version number of the tag

.github/workflows/test.yml

@@ -34,7 +34,7 @@ jobs:
     env:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions/setup-node@v2
         with:
           node-version: 16

.github/workflows/test_bundles.yml

@@ -34,7 +34,7 @@ jobs:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
     steps:
       - name: Checkout branch with UMD build
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: umd
       - name: Setup Node.js
@@ -57,7 +57,7 @@ jobs:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
     steps:
       - name: Checkout branch with ESM build
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: esm
       - name: Setup Node.js
@@ -80,7 +80,7 @@ jobs:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
     steps:
       - name: Checkout branch with Deno build
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: deno
       - name: Install Deno

.github/workflows/test_coverage.yml

@@ -31,7 +31,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions/setup-node@v2
         with:
           node-version: 16

.github/workflows/test_install.yml

@@ -37,7 +37,7 @@ jobs:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
     if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions/setup-node@v2
         with:
           node-version: 16

docs/types/index.d.ts

@@ -52,6 +52,7 @@ import rtrim = require( './../../right-trim' );
 import rtrimN = require( './../../right-trim-n' );
 import snakecase = require( './../../snakecase' );
 import splitGraphemeClusters = require( './../../split-grapheme-clusters' );
+import format = require( './../../format' );
 import startcase = require( './../../startcase' );
 import startsWith = require( './../../starts-with' );
 import substringAfter = require( './../../substring-after' );
@@ -800,6 +801,24 @@ interface Namespace {
 	*/
 	splitGraphemeClusters: typeof splitGraphemeClusters;
 
+	/**
+	* Inserts supplied variable values into a format string.
+	*
+	* @param str - input string
+	* @param ...args - variable values
+	* @throws invalid flags
+	* @returns formatted string
+	*
+	* @example
+	* var str = ns.format( 'Hello %s!', 'world' );
+	* // returns 'Hello world!'
+	*
+	* @example
+	* var str = ns.format( 'Pi: ~%.2f', 3.141592653589793 );
+	* // returns 'Pi: ~3.14'
+	*/
+	format: typeof format;
+
 	/**
 	* Capitalizes the first letter of each word in an input string.
 	*

kebabcase/lib/main.js

@@ -65,7 +65,7 @@ var RE_CAMEL = /([a-z0-9])([A-Z])/g;
 */
 function kebabCase( str ) {
 	if ( !isString( str ) ) {
-		throw new TypeError( format( 'invalid argument. Must provide a string primitive. Value: `%s`.', 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' );

left-trim/lib/left_trim.js

@@ -54,7 +54,7 @@ var RE = /^[\u0020\f\n\r\t\v\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3
 */
 function ltrim( str ) {
 	if ( !isString( str ) ) {
-		throw new TypeError( format( 'invalid argument. Must provide a string primitive. Value: `%s`.', str ) );
+		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) );
 	}
 	return replace( str, RE, '' );
 }

lowercase/lib/lowercase.js

@@ -30,7 +30,7 @@ var format = require( './../../format' );
 * Converts a string to lowercase.
 *
 * @param {string} str - string to convert
-* @throws {TypeError} must provide a primitive string
+* @throws {TypeError} must provide a string
 * @returns {string} lowercase string
 *
 * @example
@@ -39,7 +39,7 @@ var format = require( './../../format' );
 */
 function lowercase( str ) {
 	if ( !isString( str ) ) {
-		throw new TypeError( format( 'invalid argument. Must provide a primitive string. Value: `%s`.', str ) );
+		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) );
 	}
 	return str.toLowerCase();
 }

remove-punctuation/lib/remove_punctuation.js

@@ -56,7 +56,7 @@ var RE = /[!"'(),–.:;<>?`{}|~\/\\\[\]]/g; // eslint-disable-line no-useless-es
 */
 function removePunctuation( str ) {
 	if ( !isString( str ) ) {
-		throw new TypeError( format( 'invalid argument. Must provide a string primitive. Value: `%s`.', str ) );
+		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) );
 	}
 	return replace( str, RE, '' );
 }

remove-utf8-bom/lib/remove_utf_8_bom.js

@@ -54,7 +54,7 @@ var BOM = 65279;
 */
 function removeUTF8BOM( str ) {
 	if ( !isString( str ) ) {
-		throw new TypeError( format( 'invalid argument. Must provide a string primitive. Value: `%s`.', str ) );
+		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) );
 	}
 	if ( str.charCodeAt( 0 ) === BOM ) {
 		return str.slice( 1 );

right-trim-n/lib/main.js

@@ -74,7 +74,7 @@ function rtrimN( str, n, chars ) {
 	var RE;
 	var i;
 	if ( !isString( str ) ) {
-		throw new TypeError( format( 'invalid argument. Must provide a string primitive. Value: `%s`.', str ) );
+		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) );
 	}
 	if ( !isNonNegativeInteger( n ) ) {
 		throw new TypeError( format( 'invalid argument. Must provide a nonnegative integer. Value: `%s`.', n ) );

right-trim/lib/right_trim.js

@@ -54,7 +54,7 @@ var RE = /[\u0020\f\n\r\t\v\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u30
 */
 function rtrim( str ) {
 	if ( !isString( str ) ) {
-		throw new TypeError( format( 'invalid argument. Must provide a string primitive. Value: `%s`.', str ) );
+		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) );
 	}
 	return replace( str, RE, '' );
 }

snakecase/lib/main.js

@@ -65,7 +65,7 @@ var RE_CAMEL = /([a-z0-9])([A-Z])/g;
 */
 function snakecase( str ) {
 	if ( !isString( str ) ) {
-		throw new TypeError( format( 'invalid argument. Must provide a string primitive. Value: `%s`.', 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' );

startcase/lib/startcase.js

@@ -31,7 +31,7 @@ var format = require( './../../format' );
 * Capitalizes the first letter of each word in an input string.
 *
 * @param {string} str - string to convert
-* @throws {TypeError} must provide a primitive string
+* @throws {TypeError} must provide a string
 * @returns {string} start case string
 *
 * @example
@@ -44,7 +44,7 @@ function startcase( str ) {
 	var ch;
 	var i;
 	if ( !isString( str ) ) {
-		throw new TypeError( format( 'invalid argument. Must provide a primitive string. Value: `%s`.', str ) );
+		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) );
 	}
 	cap = true;
 	out = '';

trim/lib/trim.js

@@ -54,7 +54,7 @@ var RE = /^[\u0020\f\n\r\t\v\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3
 */
 function trim( str ) {
 	if ( !isString( str ) ) {
-		throw new TypeError( format( 'invalid argument. Must provide a string primitive. Value: `%s`.', str ) );
+		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) );
 	}
 	return replace( str, RE, '$1' );
 }

truncate-middle/lib/main.js

@@ -85,7 +85,7 @@ function truncateMiddle( str, len, seq ) {
 		throw new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', str ) );
 	}
 	if ( !isNonNegativeInteger( len ) ) {
-		throw new TypeError( format( 'invalid argument. Second argument must be a nonnegative integer primitive. Value: `%s`.', len ) );
+		throw new TypeError( format( 'invalid argument. Second argument must be a nonnegative integer. Value: `%s`.', len ) );
 	}
 	if ( arguments.length > 2 ) {
 		if ( !isString( seq ) ) {

truncate/lib/main.js

@@ -79,7 +79,7 @@ function truncate( str, len, ending ) {
 		throw new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', str ) );
 	}
 	if ( !isNonNegativeInteger( len ) ) {
-		throw new TypeError( format( 'invalid argument. Second argument must be a nonnegative integer primitive. Value: `%s`.', len ) );
+		throw new TypeError( format( 'invalid argument. Second argument must be a nonnegative integer. Value: `%s`.', len ) );
 	}
 	if ( arguments.length > 2 ) {
 		if ( !isString( ending ) ) {

uppercase/lib/uppercase.js

@@ -30,7 +30,7 @@ var format = require( './../../format' );
 * Converts a string to uppercase.
 *
 * @param {string} str - string to convert
-* @throws {TypeError} must provide a primitive string
+* @throws {TypeError} must provide a string
 * @returns {string} uppercase string
 *
 * @example
@@ -39,7 +39,7 @@ var format = require( './../../format' );
 */
 function uppercase( str ) {
 	if ( !isString( str ) ) {
-		throw new TypeError( format( 'invalid argument. Must provide a primitive string. Value: `%s`.', str ) );
+		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) );
 	}
 	return str.toUpperCase();
 }