Auto-generated commit

Author: stdlib-bot

.github/workflows/productionize.yml

@@ -82,28 +82,14 @@ jobs:
         id: transform-error-messages
         uses: stdlib-js/transform-errors-action@main
 
-      # Format error messages:
-      - name: 'Replace double quotes with single quotes in rewritten format string error messages'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \;
-
-      # Format string literal error messages:
-      - name: 'Replace double quotes with single quotes in rewritten string literal error messages'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \;
-
-      # Format code:
-      - name: 'Replace double quotes with single quotes in inserted `require` calls'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \;
-
       # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency:
       - name: 'Update dependencies in package.json'
         run: |
+          PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version)
           if grep -q '"@stdlib/string-format"' package.json; then
-            sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json
+            sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json
           else
-            node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );"
+            node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );"
           fi
 
       # Configure git:
@@ -348,7 +334,7 @@ jobs:
 
       # Send status to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}
@@ -519,7 +505,7 @@ jobs:
 
       # Send status to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}
@@ -696,7 +682,7 @@ jobs:
 
       # Send status to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}

.github/workflows/publish.yml

@@ -105,15 +105,19 @@ jobs:
       - name: 'Remove CLI'
         if: ${{ github.ref == 'refs/heads/main' }}
         run: |
+          # Exit if the package does not have a CLI:
+          if ! grep -q '"bin":' package.json; then
+            exit 0
+          fi
           rm -rf ./bin/cli
-          rm test/test.cli.js
-          rm etc/cli_opts.json
-          rm docs/usage.txt
+          rm -f test/test.cli.js
+          rm -f etc/cli_opts.json
+          rm -f docs/usage.txt
 
           # For all dependencies, check in all *.js files if they are still used; if not, remove them:
           jq -r '.dependencies | keys[]' ./package.json | while read -r dep; do
             dep=$(echo "$dep" | xargs)
-            if ! grep -q "$dep" lib/**; then
+            if ! grep -q "$dep" lib/** && ! grep -q -s "$dep" manifest.json && ! grep -q -s "$dep" include.gypi; then
               jq --indent 2 "del(.dependencies[\"$dep\"])" ./package.json > ./package.json.tmp
               mv ./package.json.tmp ./package.json
             fi
@@ -123,7 +127,7 @@ jobs:
               continue
             fi
             dep=$(echo "$dep" | xargs)
-            if ! grep -q "$dep" ./lib/**; then
+            if ! grep -q "$dep" lib/** && ! grep -q -s "$dep" manifest.json && ! grep -q -s "$dep" include.gypi; then
               jq --indent 2 "del(.devDependencies[\"$dep\"])" ./package.json > ./package.json.tmp
               mv ./package.json.tmp ./package.json
             fi
@@ -136,6 +140,21 @@ jobs:
           jq -r 'del(.bin)' package.json > package.json.tmp
           mv package.json.tmp package.json
 
+          # Add entry for CLI package to See Also section of README.md:
+          cliPkgName=$(jq -r '.name' package.json)-cli
+          escapedPkg=$(echo "$cliPkgName" | sed -e 's/\//\\\//g')
+          escapedPkg=$(echo "$escapedPkg" | sed -e 's/\@/\\\@/g')
+          find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/<section class=\"related\">(?:\n\n\* \* \*\n\n## See Also\n\n)?/<section class=\"related\">\n\n## See Also\n\n-   <span class=\"package-name\">[\`$escapedPkg\`][$escapedPkg]<\/span><span class=\"delimiter\">: <\/span><span class=\"description\">CLI package for use as a command-line utility.<\/span>\n/"
+
+          # Add link definition for CLI package to README.md:
+          find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/<section class=\"links\">/<section class=\"links\">\n\n[$escapedPkg]: https:\/\/www.npmjs.com\/package\/$escapedPkg/"
+
+      # Replace GitHub MathJax equations with SVGs:
+      - name: 'Replace GitHub MathJax equations with SVGs'
+        run: |
+          find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe 's/```math\n([\s\S]+?)\n```\n\n//g'
+          find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe 's/<!-- <div class="equation"(.*)(<\/div>\s*-->)/<div class="equation"$1<\/div>/sg'
+
       # Replace GitHub links to individual packages with npm links:
       - name: 'Replace all GitHub links to individual packages with npm links'
         run: |
@@ -146,6 +165,12 @@ jobs:
         run: |
           find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`\n\nAlternatively,[^<]+<\/section>/\`\`\`\n\n<\/section>/"
 
+      # Remove unnecessary files:
+      - name: 'Remove unnecessary files'
+        run: |
+          rm -f docs/repl.txt
+          rm -f docs/types/test.ts
+
       # Replace all stdlib GitHub dependencies with the respective npm packages:
       - name: 'Replace all stdlib GitHub dependencies with the respective npm packages'
         run: |
@@ -172,7 +197,7 @@ jobs:
 
       # Publish package to npm:
       - name: 'Publish package to npm'
-        uses: JS-DevTools/npm-publish@v1
+        uses: JS-DevTools/npm-publish@v2
         with:
           token: ${{ secrets.NPM_TOKEN }}
           access: public
@@ -184,7 +209,7 @@ jobs:
 
       # Send status to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}

.github/workflows/test.yml

@@ -32,6 +32,11 @@ on:
   # Run workflow on each push to the main branch:
   push:
 
+  # Run workflow upon completion of `publish` workflow run:
+  workflow_run:
+    workflows: ["publish"]
+    types: [completed]
+
 # Workflow jobs:
 jobs:
 
@@ -84,7 +89,7 @@ jobs:
 
       # Send status to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}

.github/workflows/test_bundles.yml

@@ -88,7 +88,7 @@ jobs:
 
       # Send notification to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}
@@ -130,7 +130,7 @@ jobs:
 
       # Send notification to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}
@@ -172,7 +172,7 @@ jobs:
 
       # Send notification to Slack channel if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}

.github/workflows/test_coverage.yml

@@ -106,7 +106,7 @@ jobs:
 
       # Send Slack notification if job fails:
       - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}

.github/workflows/test_install.yml

@@ -75,7 +75,7 @@ jobs:
 
       # Send Slack notification if job fails:
       - name: 'Send notification to Slack in case of failure'
-        uses: act10ns/slack@v1
+        uses: act10ns/slack@v2
         with:
           status: ${{ job.status }}
           steps: ${{ toJson(steps) }}

.gitignore

@@ -182,3 +182,7 @@ jsconfig.json
 ################
 *.sublime-workspace
 *.sublime-project
+
+# Other editor files #
+######################
+.idea/

CONTRIBUTORS

@@ -3,28 +3,37 @@
 # Contributors listed in alphabetical order.
 
 Ali Salesi <ali_sal1381@yahoo.com>
+Amit Jimiwal <amitjimiwal45@gmail.com>
 Athan Reines <kgryte@gmail.com>
 Brendan Graetz <bguiz@users.noreply.github.com>
 Bruno Fenzl <brunofenzl@gmail.com>
 Christopher Dambamuromo <chridam@gmail.com>
+Dan Rose <danoftheroses@gmail.com>
 Dominik Moritz <domoritz@gmail.com>
+Dorrin Sotoudeh <dorrinsotoudeh123@gmail.com>
 Frank Kovacs <fran70kk@gmail.com>
-James <jdgelok@gmail.com>
+Harshita Kalani <harshitakalani02@gmail.com>
+James Gelok <jdgelok@gmail.com>
 Jithin KS <jithinks112@gmail.com>
 Joey Reed <joeyrreed@gmail.com>
+Jordan Gallivan <115050475+Jordan-Gallivan@users.noreply.github.com>
 Joris Labie <joris.labie1@gmail.com>
 Justin Dennison <justin1dennison@gmail.com>
-Marcus <mfantham@users.noreply.github.com>
+Marcus Fantham <mfantham@users.noreply.github.com>
 Matt Cochrane <matthew.cochrane.eng@gmail.com>
 Milan Raj <rajsite@users.noreply.github.com>
 Momtchil Momtchev <momtchil@momtchev.com>
+Naresh Jagadeesan <naresh.naresh000@gmail.com>
+Nithin Katta <88046362+nithinkatta@users.noreply.github.com>
 Ognjen Jevremović <ognjenjevremovic@users.noreply.github.com>
 Philipp Burckhardt <pburckhardt@outlook.com>
-Pranav <85227306+Pranavchiku@users.noreply.github.com>
+Pranav Goswami <goswami.4@iitj.ac.in>
 Ricky Reusser <rsreusser@gmail.com>
+Roman Stetsyk <25715951+romanstetsyk@users.noreply.github.com>
 Ryan Seal <splrk@users.noreply.github.com>
 Seyyed Parsa Neshaei <spneshaei@users.noreply.github.com>
 Shraddheya Shendre <shendreshraddheya@gmail.com>
 Stephannie Jiménez Gacha <steff456@hotmail.com>
-dorrin-sot <59933477+dorrin-sot@users.noreply.github.com>
-rei2hu <rei2hu@users.noreply.github.com>
+Yernar Yergaziyev <yernar.yergaziyev@erg.kz>
+orimiles5 <97595296+orimiles5@users.noreply.github.com>
+rei2hu <reimu@reimu.ws>

README.md

@@ -212,7 +212,7 @@ Copyright © 2016-2023. 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
 

dist/index.d.ts

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