Auto-generated commit

stdlib-bot · stdlib-bot · commit de5725c4f491 · 2024-12-30T03:07:24.000Z
diff --git a/.editorconfig b/.editorconfig
@@ -121,7 +121,7 @@ indent_style = tab
 [*.{md,md.txt}]
 indent_style = space
 indent_size = 4
-trim_trailing_whitespace = false
+trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim.
 
 # Set properties for `usage.txt` files:
 [usage.txt]
diff --git a/.gitattributes b/.gitattributes
@@ -40,10 +40,27 @@
 *.mov binary
 
 # Override what is considered "vendored" by GitHub's linguist:
-/deps/** linguist-vendored=false
-/lib/node_modules/** linguist-vendored=false linguist-generated=false
-test/fixtures/** linguist-vendored=false
-tools/** linguist-vendored=false
+/lib/node_modules/** -linguist-vendored -linguist-generated
 
-# Override what is considered "documentation" by GitHub's linguist:
-examples/** linguist-documentation=false
+# Configure directories which should *not* be included in GitHub language statistics:
+/deps/** linguist-vendored
+/dist/** linguist-generated
+/workshops/** linguist-vendored
+
+benchmark/** linguist-vendored
+docs/* linguist-documentation
+etc/** linguist-vendored
+examples/** linguist-documentation
+scripts/** linguist-vendored
+test/** linguist-vendored
+tools/** linguist-vendored
+
+# Configure files which should *not* be included in GitHub language statistics:
+Makefile linguist-vendored
+*.mk linguist-vendored
+*.jl linguist-vendored
+*.py linguist-vendored
+*.R linguist-vendored
+
+# Configure files which should be included in GitHub language statistics:
+docs/types/*.d.ts -linguist-documentation
diff --git a/.github/.keepalive b/.github/.keepalive
@@ -0,0 +1 @@
+2024-12-30T03:07:22.062Z
diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml
@@ -93,8 +93,8 @@ jobs:
             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:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         run: |
           git config --local user.email "noreply@stdlib.io"
           git config --local user.name "stdlib-bot"
@@ -190,8 +190,8 @@ jobs:
         # Pin action to full length commit SHA
         uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
-      # Configure git:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         run: |
           git config --local user.email "noreply@stdlib.io"
           git config --local user.name "stdlib-bot"
@@ -343,7 +343,6 @@ jobs:
         uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
         with:
           status: ${{ job.status }}
-          steps: ${{ toJson(steps) }}
           channel: '#npm-ci'
         if: failure()
 
@@ -366,8 +365,8 @@ jobs:
         # Pin action to full length commit SHA
         uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
-      # Configure git:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         run: |
           git config --local user.email "noreply@stdlib.io"
           git config --local user.name "stdlib-bot"
@@ -516,7 +515,6 @@ jobs:
         uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
         with:
           status: ${{ job.status }}
-          steps: ${{ toJson(steps) }}
           channel: '#npm-ci'
         if: failure()
 
@@ -539,8 +537,8 @@ jobs:
         # Pin action to full length commit SHA
         uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
-      # Configure git:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         run: |
           git config --local user.email "noreply@stdlib.io"
           git config --local user.name "stdlib-bot"
@@ -695,7 +693,6 @@ jobs:
         uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
         with:
           status: ${{ job.status }}
-          steps: ${{ toJson(steps) }}
           channel: '#npm-ci'
         if: failure()
 
@@ -718,8 +715,8 @@ jobs:
         # Pin action to full length commit SHA
         uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
-      # Configure git:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         run: |
           git config --local user.email "noreply@stdlib.io"
           git config --local user.name "stdlib-bot"
@@ -893,7 +890,6 @@ jobs:
         uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
         with:
           status: ${{ job.status }}
-          steps: ${{ toJson(steps) }}
           channel: '#npm-ci'
         if: failure()
 
@@ -933,8 +929,8 @@ jobs:
             echo "bump=true" >> $GITHUB_OUTPUT
           fi
 
-      # Configure git:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         if: steps.check-if-bump.outputs.bump
         run: |
           git config --local user.email "noreply@stdlib.io"
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -72,8 +72,8 @@ jobs:
           node-version: 20
         timeout-minutes: 5
 
-      # Configure git:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         run: |
           git config --local user.email "noreply@stdlib.io"
           git config --local user.name "stdlib-bot"
@@ -94,6 +94,10 @@ jobs:
           # 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"
 
+          # Rewrite CHANGELOG.md to replace "Unreleased" with the new version:
+          sed -Ei "s/Unreleased/${NEW_VERSION}/g" CHANGELOG.md
+          sed -Ei "s/unreleased/v${NEW_VERSION}/g" CHANGELOG.md
+
           # Create a new commit and tag:
           git add package.json README.md
           git commit -m "Release v${NEW_VERSION}"
@@ -202,7 +206,7 @@ jobs:
       # Publish package to npm:
       - name: 'Publish package to npm'
         # Pin action to full length commit SHA
-        uses: JS-DevTools/npm-publish@4b07b26a2f6e0a51846e1870223e545bae91c552 # v3.0.1
+        uses: JS-DevTools/npm-publish@19c28f1ef146469e409470805ea4279d47c3d35c # v3.1.1
         with:
           token: ${{ secrets.NPM_TOKEN }}
           access: public
@@ -218,7 +222,6 @@ jobs:
         uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
         with:
           status: ${{ job.status }}
-          steps: ${{ toJson(steps) }}
           channel: '#npm-ci'
         if: failure()
 
diff --git a/.github/workflows/publish_cli.yml b/.github/workflows/publish_cli.yml
@@ -74,8 +74,8 @@ jobs:
           node-version: 20
         timeout-minutes: 5
 
-      # Configure git:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         run: |
           git config --local user.email "noreply@stdlib.io"
           git config --local user.name "stdlib-bot"
@@ -129,7 +129,7 @@ jobs:
       # Publish package to npm:
       - name: 'Publish package to npm'
         # Pin action to full length commit SHA
-        uses: JS-DevTools/npm-publish@4b07b26a2f6e0a51846e1870223e545bae91c552 # v3.0.1
+        uses: JS-DevTools/npm-publish@19c28f1ef146469e409470805ea4279d47c3d35c # v3.1.1
         with:
           token: ${{ secrets.NPM_TOKEN }}
           access: public
@@ -145,7 +145,6 @@ jobs:
         uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
         with:
           status: ${{ job.status }}
-          steps: ${{ toJson(steps) }}
           channel: '#npm-ci'
         if: failure()
 
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -95,6 +95,5 @@ jobs:
         uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
         with:
           status: ${{ job.status }}
-          steps: ${{ toJson(steps) }}
           channel: '#npm-ci'
         if: failure()
diff --git a/.github/workflows/test_bundles.yml b/.github/workflows/test_bundles.yml
@@ -94,7 +94,6 @@ jobs:
         uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
         with:
           status: ${{ job.status }}
-          steps: ${{ toJson(steps) }}
           channel: '#npm-ci'
         if: failure()
 
@@ -139,7 +138,6 @@ jobs:
         uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
         with:
           status: ${{ job.status }}
-          steps: ${{ toJson(steps) }}
           channel: '#npm-ci'
         if: failure()
 
@@ -184,6 +182,5 @@ jobs:
         uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
         with:
           status: ${{ job.status }}
-          steps: ${{ toJson(steps) }}
           channel: '#npm-ci'
         if: failure()
diff --git a/.github/workflows/test_coverage.yml b/.github/workflows/test_coverage.yml
@@ -119,7 +119,6 @@ jobs:
         uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
         with:
           status: ${{ job.status }}
-          steps: ${{ toJson(steps) }}
           channel: '#npm-ci'
         if: failure()
 
diff --git a/.github/workflows/test_install.yml b/.github/workflows/test_install.yml
@@ -50,8 +50,8 @@ jobs:
     env:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
-    # Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
-    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
+    # Run workflow job if `publish` workflow run is successful or when the workflow is manually triggered or on a schedule:
+    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
 
     # Define the sequence of job steps...
     steps:
@@ -81,6 +81,5 @@ jobs:
         uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
         with:
           status: ${{ job.status }}
-          steps: ${{ toJson(steps) }}
           channel: '#npm-ci'
         if: failure()
diff --git a/.github/workflows/test_published_package.yml b/.github/workflows/test_published_package.yml
@@ -0,0 +1,105 @@
+#/
+# @license Apache-2.0
+#
+# Copyright (c) 2024 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.
+#/
+
+# Workflow name:
+name: test_published_package
+
+# Workflow triggers:
+on:
+  # Run workflow on a weekly schedule:
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    - cron:  '15 3 * * 2'
+
+  # Run workflow upon completion of `publish` workflow run:
+  workflow_run:
+    workflows: ["publish"]
+    types: [completed]
+
+  # Allow workflow to be manually run:
+  workflow_dispatch:
+
+# Workflow jobs:
+jobs:
+  test-published:
+    # Define a display name:
+    name: 'Test running examples of published package'
+
+    # Define the type of virtual host machine:
+    runs-on: ubuntu-latest
+
+    # Define environment variables:
+    env:
+      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+
+    # Run workflow job if `publish` workflow run is successful or when the workflow is manually triggered or on a schedule:
+    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
+
+    # Define the job's steps:
+    steps:
+      # Checkout the repository:
+      - name: 'Checkout repository'
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
+
+      # Install Node.js:
+      - name: 'Install Node.js'
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
+        with:
+          node-version: 20
+        timeout-minutes: 5
+
+      # Create test directory and run examples:
+      - name: 'Create test directory and run examples'
+        run: |
+          cd ..
+          mkdir test-published
+          cd test-published
+
+          # Copy example file:
+          cp $GITHUB_WORKSPACE/examples/index.js .
+
+          # Create a minimal package.json
+          echo '{
+            "name": "test-published",
+            "version": "1.0.0",
+            "main": "index.js",
+            "dependencies": {}
+          }' > package.json
+
+          # Get package name and modify example file:
+          PACKAGE_NAME=$(jq -r '.name' $GITHUB_WORKSPACE/package.json)
+          ESCAPED_PACKAGE_NAME=$(echo "$PACKAGE_NAME" | sed 's/[\/&]/\\&/g')
+
+          sed -i "s/require( '.\/..\/lib' )/require( '$ESCAPED_PACKAGE_NAME' )/g" index.js
+
+          # Extract and install dependencies:
+          DEPS=$(grep -oP "require\(\s*'([^']+)'\s*\)" index.js | sed "s/require(\s*'//" | sed "s/'\s*)//" | grep -v "^\.")
+          for dep in $DEPS; do
+            npm install $dep --save
+          done
+
+          # Run the example:
+          node index.js
+
+      # Send Slack notification if job fails:
+      - name: 'Send notification to Slack in case of failure'
+        uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
+        with:
+          status: ${{ job.status }}
+          channel: '#npm-ci'
+        if: failure()
diff --git a/.gitignore b/.gitignore
@@ -101,6 +101,8 @@ docs/**/node_modules/
 pids
 *.pid
 *.seed
+yarn.lock
+package-lock.json
 
 # Typescript #
 ##############
diff --git a/.npmrc b/.npmrc
@@ -27,5 +27,5 @@ shrinkwrap = false
 # Disable automatically "saving" dependencies on install:
 save = false
 
-# Generate provenance metadata:
-provenance = true
+# Do not generate provenance metadata:
+provenance = false
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
diff --git a/package.json b/package.json
