Auto-generated commit

.github/workflows/productionize.yml

@@ -34,6 +34,12 @@ on:
         type: boolean
         default: true
 
+  # Run workflow upon completion of `publish` workflow run:
+  workflow_run:
+    workflows: ["publish"]
+    types: [completed]
+
+
 # Concurrency group to prevent multiple concurrent executions:
 concurrency:
   group: productionize
@@ -94,10 +100,11 @@ jobs:
       # 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:

.github/workflows/publish.yml

@@ -21,9 +21,23 @@ name: publish
 
 # Workflow triggers:
 on:
-  # Run workflow when a new tag is pushed to the repository:
-  push:
-    tags: v[0-9]+.[0-9]+.[0-9]+
+  # Allow the workflow to be manually run:
+  workflow_dispatch:
+    # Workflow inputs:
+    inputs:
+      version:
+        description: 'Version Increment'
+        type: choice
+        default: 'none'
+        options:
+          - 'none'
+          - 'major'
+          - 'minor'
+          - 'patch'
+          - 'premajor'
+          - 'preminor'
+          - 'prepatch'
+          - 'prerelease'
 
 # Workflow jobs:
 jobs:
@@ -32,14 +46,15 @@ jobs:
   publish:
 
     # Define display name:
-    name: 'Publish to npm'
+    name: 'Publish package to npm'
 
     # Define the type of virtual host machine on which to run the job:
     runs-on: ubuntu-latest
 
     # Define environment variables:
     env:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
     # Define the sequence of job steps...
     steps:
@@ -55,6 +70,91 @@ jobs:
           node-version: 16
         timeout-minutes: 5
 
+      # Configure git:
+      - name: 'Configure git'
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "stdlib-bot"
+
+      # Increment package version (if requested):
+      - name: 'Increment package version (if requested)'
+        if: ${{ github.event.inputs.version != 'none' }}
+        run: |
+          # Save NPM_TOKEN to user's .npmrc:
+          echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
+
+          # Increment package version:
+          npm version ${{ github.event.inputs.version }} --no-git-tag-version
+
+          # Define variable for new version:
+          NEW_VERSION=$(node -p "require('./package.json').version")
+
+          # Replace branch in README.md link definitions for badges with the new version:
+          find . -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/branch([=:])[^ ]+/branch\1v${NEW_VERSION}/g"
+
+          # Create a new commit and tag:
+          git add package.json README.md
+          git commit -m "Release v${NEW_VERSION}"
+          git tag -a "v${NEW_VERSION}" -m "Release v${NEW_VERSION}"
+
+          # Push changes to GitHub:
+          SLUG=${{ github.repository }}
+          git push "https://$GITHUB_ACTOR:[email protected]/$SLUG.git" --follow-tags
+
+      # Remove CLI:
+      - 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 -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/** && ! 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
+          done
+          jq -r '.devDependencies | keys[]' ./package.json | while read -r dep; do
+            if [[ "$dep" != "@stdlib"* ]]; then
+              continue
+            fi
+            dep=$(echo "$dep" | xargs)
+            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
+          done
+
+          # Remove CLI section:
+          find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?<section class=\"cli\">[\s\S]+?<\!\-\- \/.cli \-\->//"
+
+          # Remove CLI from package.json:
+          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: |
@@ -65,14 +165,39 @@ 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: |
-          find package.json -type f -print0 | xargs -0 sed -Ei 's/"github:stdlib-js[^"]*"/"^0.0.x"/g'
+          for dep in $(jq -r '.dependencies | keys | .[]' package.json); do
+            if [[ "$dep" != "@stdlib"* ]]; then
+              continue
+            fi
+            # Trim leading and trailing whitespace:
+            dep=$(echo "$dep" | xargs)
+            version="^$(npm view $dep version)"
+            jq -r --arg dep "$dep" --arg version "$version" '.dependencies[$dep] = $version' package.json > package.json.tmp
+            mv package.json.tmp package.json
+          done
+          for dep in $(jq -r '.devDependencies | keys | .[]' package.json); do
+            if [[ "$dep" != "@stdlib"* ]]; then
+              continue
+            fi
+            # Trim leading and trailing whitespace:
+            dep=$(echo "$dep" | xargs)
+            version="^$(npm view $dep version)"
+            jq -r --arg dep "$dep" --arg version "$version" '.devDependencies[$dep] = $version' package.json > package.json.tmp
+            mv package.json.tmp package.json
+          done
 
       # 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

.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:
 

.gitignore

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

CONTRIBUTORS

@@ -9,22 +9,30 @@ Bruno Fenzl <[email protected]>
 Christopher Dambamuromo <[email protected]>
 Dominik Moritz <[email protected]>
 Frank Kovacs <[email protected]>
+Harshita Kalani <[email protected]>
 James <[email protected]>
 Jithin KS <[email protected]>
 Joey Reed <[email protected]>
+Jordan-Gallivan <[email protected]>
 Joris Labie <[email protected]>
 Justin Dennison <[email protected]>
+KATTA NAGA NITHIN <[email protected]>
 Marcus <[email protected]>
 Matt Cochrane <[email protected]>
 Milan Raj <[email protected]>
 Momtchil Momtchev <[email protected]>
+Naresh Jagadeesan <[email protected]>
 Ognjen Jevremović <[email protected]>
 Philipp Burckhardt <[email protected]>
 Pranav <[email protected]>
 Ricky Reusser <[email protected]>
+Roman Stetsyk <[email protected]>
 Ryan Seal <[email protected]>
 Seyyed Parsa Neshaei <[email protected]>
 Shraddheya Shendre <[email protected]>
 Stephannie Jiménez Gacha <[email protected]>
+Yernar Yergaziyev <[email protected]>
 dorrin-sot <[email protected]>
+drunken_devv <[email protected]>
+orimiles5 <[email protected]>
 rei2hu <[email protected]>

README.md

@@ -231,7 +231,7 @@ while ( true ) {
 
 ## See Also
 
--   <span class="package-name">[`@stdlib/random/base/gumbel`][@stdlib/random/base/gumbel]</span><span class="delimiter">: </span><span class="description">Gumbel distributed pseudorandom numbers.</span>
+-   <span class="package-name">[`@stdlib/random-base/gumbel`][@stdlib/random/base/gumbel]</span><span class="delimiter">: </span><span class="description">Gumbel distributed pseudorandom numbers.</span>
 
 </section>
 
@@ -290,7 +290,7 @@ Copyright &copy; 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
 

branches.md

@@ -38,12 +38,12 @@ C -->|bundle| D[esm];
 C -->|bundle| E[deno];
 C -->|bundle| F[umd];
 
-click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/gumbel"
-click B href "https://github.com/stdlib-js/random-iter-gumbel/tree/main"
-click C href "https://github.com/stdlib-js/random-iter-gumbel/tree/production"
-click D href "https://github.com/stdlib-js/random-iter-gumbel/tree/esm"
-click E href "https://github.com/stdlib-js/random-iter-gumbel/tree/deno"
-click F href "https://github.com/stdlib-js/random-iter-gumbel/tree/umd"
+%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/gumbel"
+%% click B href "https://github.com/stdlib-js/random-iter-gumbel/tree/main"
+%% click C href "https://github.com/stdlib-js/random-iter-gumbel/tree/production"
+%% click D href "https://github.com/stdlib-js/random-iter-gumbel/tree/esm"
+%% click E href "https://github.com/stdlib-js/random-iter-gumbel/tree/deno"
+%% click F href "https://github.com/stdlib-js/random-iter-gumbel/tree/umd"
 ```
 
 [stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/gumbel

docs/types/index.d.ts

@@ -21,7 +21,7 @@
 /// <reference types="@stdlib/types"/>
 
 import * as random from '@stdlib/types/random';
-import { Iterator } from '@stdlib/types/iter';
+import { TypedIterator } from '@stdlib/types/iter';
 
 /**
 * Interface defining function options.
@@ -56,7 +56,7 @@ interface Options {
 /**
 * Interface for iterators of pseudorandom numbers drawn from a Gumbel distribution.
 */
-interface RandIter extends Iterator {
+interface Iterator<T> extends TypedIterator<T> {
 	/**
 	* Underlying PRNG.
 	*/
@@ -113,7 +113,7 @@ interface RandIter extends Iterator {
 *
 * // ...
 */
-declare function iterator( mu: number, beta: number, options?: Options ): RandIter; // tslint:disable-line:max-line-length
+declare function iterator( mu: number, beta: number, options?: Options ): Iterator<number>;
 
 
 // EXPORTS //

docs/types/test.ts

@@ -23,9 +23,9 @@ import iterator = require( './index' );
 
 // The function returns an iterator...
 {
-	iterator( -2.0, 5.0 ); // $ExpectType RandIter
-	iterator( 2.0, 5.0, {} ); // $ExpectType RandIter
-	iterator( 2.0, 5.0, { 'iter': 10 } ); // $ExpectType RandIter
+	iterator( -2.0, 5.0 ); // $ExpectType Iterator<number>
+	iterator( 2.0, 5.0, {} ); // $ExpectType Iterator<number>
+	iterator( 2.0, 5.0, { 'iter': 10 } ); // $ExpectType Iterator<number>
 }
 
 // The compiler throws an error if the function is provided invalid input arguments...