Auto-generated commit

Author: stdlib-bot

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

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

.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:  '59 11 * * 4'
+
+  # 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()

CHANGELOG.md

@@ -2,6 +2,40 @@
 
 > Package changelog.
 
+<section class="release" id="unreleased">
+
+## Unreleased (2025-01-11)
+
+<section class="commits">
+
+### Commits
+
+<details>
+
+-   [`cdac4cf`](https://github.com/stdlib-js/stdlib/commit/cdac4cfdbfd0895eaffd370f1d85726cf42be7f9) - **chore:** clean-up documentation and fix tests _(by Athan Reines)_
+
+</details>
+
+</section>
+
+<!-- /.commits -->
+
+<section class="contributors">
+
+### Contributors
+
+A total of 1 person contributed to this release. Thank you to this contributor:
+
+-   Athan Reines
+
+</section>
+
+<!-- /.contributors -->
+
+</section>
+
+<!-- /.release -->
+
 <section class="release" id="v0.1.0">
 
 ## 0.1.0 (2024-07-29)

CONTRIBUTORS

@@ -2,9 +2,14 @@
 #
 # Contributors listed in alphabetical order.
 
+Aadish Jain <[email protected]>
+Aayush Khanna <[email protected]>
+Abhijit Raut <[email protected]>
 Adarsh Palaskar <[email protected]>
 Aditya Sapra <[email protected]>
-AgPriyanshu18 <[email protected]>
+Ahmed Atwa <[email protected]>
+Ahmed Kashkoush <[email protected]>
+Ahmed Khaled <[email protected]>
 Aleksandr <[email protected]>
 Ali Salesi <[email protected]>
 Aman Bhansali <[email protected]>
@@ -20,59 +25,82 @@ Christopher Dambamuromo <[email protected]>
 Dan Rose <[email protected]>
 Daniel Killenberger <[email protected]>
 Daniel Yu <[email protected]>
+Debashis Maharana <[email protected]>
+Desh Deepak Kant <[email protected]>
+Dhruv Arvind Singh <[email protected]>
+Divyansh Seth <[email protected]>
+Dominic Lim <[email protected]>
 Dominik Moritz <[email protected]>
 Dorrin Sotoudeh <[email protected]>
 EuniceSim142 <[email protected]>
 Frank Kovacs <[email protected]>
 Golden Kumar <[email protected]>
 Gunj Joshi <[email protected]>
+Gururaj Gurram <[email protected]>
+HarshaNP <[email protected]>
 Harshita Kalani <[email protected]>
 Hridyanshu <[email protected]>
 Jaimin Godhani <[email protected]>
 James Gelok <[email protected]>
 Jaysukh Makvana <[email protected]>
+Jenish Thapa <[email protected]>
 Jithin KS <[email protected]>
 Joel Mathew Koshy <[email protected]>
 Joey Reed <[email protected]>
 Jordan Gallivan <[email protected]>
 Joris Labie <[email protected]>
 Justin Dennison <[email protected]>
+Karan Anand <[email protected]>
 Karthik Prakash <[email protected]>
-Khaldon <kahmd1444@gmail.com>
+Kohantika Nath <[email protected].com>
 Krishnendu Das <[email protected]>
-Lovelin <[email protected]>
+Kshitij-Dale <[email protected]>
+Lovelin Dhoni J B <[email protected]>
 Manik Sharma <[email protected]>
+Manvith M <[email protected]>
 Marcus Fantham <[email protected]>
 Matt Cochrane <[email protected]>
 Mihir Pandit <[email protected]>
 Milan Raj <[email protected]>
+Mohammad Kaif <[email protected]>
 Momtchil Momtchev <[email protected]>
 Muhammad Haris <[email protected]>
 Naresh Jagadeesan <[email protected]>
-NightKnight <[email protected]>
+Naveen Kumar <[email protected]>
+Neeraj Pathak <[email protected]>
+Nishant Shinde <[email protected]>
 Nithin Katta <[email protected]>
 Nourhan Hasan <[email protected]>
 Ognjen Jevremović <[email protected]>
 Oneday12323 <[email protected]>
+Ori Miles <[email protected]>
 Philipp Burckhardt <[email protected]>
 Prajwal Kulkarni <[email protected]>
 Pranav Goswami <[email protected]>
-Praneki <[email protected]>
-Pratik <[email protected]>
-Priyansh <[email protected]>
+Pranjal Jha <[email protected]>
+Prashant Kumar Yadav <[email protected]>
+Pratik Singh <[email protected]>
+Pratyush Kumar Chouhan <[email protected]>
+Priyansh Prajapati <[email protected]>
+Priyanshu Agarwal <[email protected]>
 Pushpendra Chandravanshi <[email protected]>
 Raunak Kumar Gupta <[email protected]>
 Rejoan Sardar <[email protected]>
 Ricky Reusser <[email protected]>
 Ridam Garg <[email protected]>
+Rishav <[email protected]>
 Robert Gislason <[email protected]>
 Roman Stetsyk <[email protected]>
-Rutam <[email protected]>
+Rutam Kathale <[email protected]>
+Ruthwik Chikoti <[email protected]>
 Ryan Seal <[email protected]>
+Rylan Yang <[email protected]>
 Sai Srikar Dumpeti <[email protected]>
+Sarthak Paandey <[email protected]>
+Saurabh Singh <[email protected]>
 Seyyed Parsa Neshaei <[email protected]>
 Shashank Shekhar Singh <[email protected]>
-Shivam <[email protected]>
+Shivam Ahir <[email protected]>
 Shraddheya Shendre <[email protected]>
 Shubh Mehta <[email protected]>
 Shubham Mishra <[email protected]>
@@ -81,16 +109,20 @@ Snehil Shah <[email protected]>
 Soumajit Chatterjee <[email protected]>
 Spandan Barve <[email protected]>
 Stephannie Jiménez Gacha <[email protected]>
-Suraj kumar <[email protected]>
+Suraj Kumar <[email protected]>
 Tirtadwipa Manunggal <[email protected]>
 Tudor Pagu <[email protected]>
+Tufailahmed Bargir <[email protected]>
 Utkarsh <http://[email protected]>
 Utkarsh Raj <[email protected]>
+UtkershBasnet <[email protected]>
+Vaibhav Patel <[email protected]>
 Varad Gupta <[email protected]>
+Vinit Pandit <[email protected]>
+Vivek Maurya <[email protected]>
 Xiaochuan Ye <[email protected]>
+Yaswanth Kosuru <[email protected]>
 Yernar Yergaziyev <[email protected]>
-naveen <[email protected]>
-nishant-s7 <[email protected]>
-orimiles5 <[email protected]>
+olenkabilonizhka <[email protected]>
 rainn <[email protected]>
 rei2hu <[email protected]>

NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2025 The Stdlib Authors.

README.md

@@ -33,7 +33,7 @@ limitations under the License.
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
 
-> Apply a mask to a provided input array and return a new array after applying a mapping function.
+> Apply a mask and a callback function to a provided input array.
 
 <section class="installation">
 
@@ -65,7 +65,7 @@ var mskfilterMap = require( '@stdlib/array-base-mskfilter-map' );
 
 #### mskfilterMap( x, mask, clbk\[, thisArg] )
 
-Applies a mask to a provided input array and returns a new array after applying a mapping function.
+Returns a new array after applying a mask and a callback function to a provided input array.
 
 ```javascript
 function clbk( value ) {
@@ -83,10 +83,10 @@ The function supports the following parameters:
 
 -   **x**: input array.
 -   **mask**: mask array.
--   **clbk**: function to apply.
--   **thisArg**: applied function execution context (_optional_).
+-   **clbk**: callback to apply.
+-   **thisArg**: callback execution context (_optional_).
 
-To set the applied function's execution context, provide a `thisArg`.
+To set the execution context of the callback function, provide a `thisArg`.
 
 <!-- eslint-disable no-invalid-this -->
 
@@ -114,7 +114,7 @@ The function **always** returns a new "generic" array.
 
 #### mskfilterMap.assign( x, mask, out, stride, offset, clbk\[, thisArg] )
 
-Applies a mask and mapping function to a provided input array and assigns results to elements in a provided output array.
+Applies a mask and a callback function to a provided input array and assigns results to elements in a provided output array.
 
 ```javascript
 function clbk( value ) {
@@ -139,8 +139,8 @@ The function supports the following parameters:
 -   **out**: output array.
 -   **stride**: output array stride.
 -   **offset**: output array offset.
--   **clbk**: function to apply.
--   **thisArg**: applied function execution context (_optional_).
+-   **clbk**: callback function.
+-   **thisArg**: callback execution context (_optional_).
 
 </section>
 
@@ -221,7 +221,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -234,8 +234,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/array-base-mskfilter-map.svg
 [npm-url]: https://npmjs.org/package/@stdlib/array-base-mskfilter-map
 
-[test-image]: https://github.com/stdlib-js/array-base-mskfilter-map/actions/workflows/test.yml/badge.svg?branch=v0.1.0
-[test-url]: https://github.com/stdlib-js/array-base-mskfilter-map/actions/workflows/test.yml?query=branch:v0.1.0
+[test-image]: https://github.com/stdlib-js/array-base-mskfilter-map/actions/workflows/test.yml/badge.svg?branch=main
+[test-url]: https://github.com/stdlib-js/array-base-mskfilter-map/actions/workflows/test.yml?query=branch:main
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-mskfilter-map/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/array-base-mskfilter-map?branch=main

benchmark/benchmark.assign.length.js

@@ -27,7 +27,7 @@ var zeros = require( '@stdlib/array-zeros' );
 var ones = require( '@stdlib/array-ones' );
 var isArray = require( '@stdlib/assert-is-array' );
 var isnan = require( '@stdlib/assert-is-nan' ).isPrimitive;
-var identity = require( '@stdlib/math-base-special-identity' );
+var identity = require( '@stdlib/utils-identity-function' );
 var pkg = require( './../package.json' ).name;
 var mskfilterMap = require( './../lib' );
 

benchmark/benchmark.js

@@ -24,7 +24,7 @@ var bench = require( '@stdlib/bench-harness' );
 var isArray = require( '@stdlib/assert-is-array' );
 var zeroTo = require( '@stdlib/array-base-zero-to' );
 var ones = require( '@stdlib/array-base-ones' );
-var identity = require( '@stdlib/math-base-special-identity' );
+var identity = require( '@stdlib/utils-identity-function' );
 var pkg = require( './../package.json' ).name;
 var mskfilterMap = require( './../lib' );