Auto-generated commit

stdlib-js · Jun 5, 2024 · 7e0795d · 7e0795d
1 parent d042618
commit 7e0795d
Show file tree

Hide file tree

Showing 3 changed files with 143 additions and 5 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -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}"

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,4 +2,133 @@
 
 > Package changelog.
 
-See [GitHub Releases](https://github.com/stdlib-js/array-to-fancy/releases) for the changelog.
+<section class="release" id="unreleased">
+
+## Unreleased (2024-06-05)
+
+<section class="features">
+
+### Features
+
+-   [`96e896a`](https://github.com/stdlib-js/stdlib/commit/96e896a39be08912b2e06dfb6b671ec13d042412) - add support for boolean array indices
+
+</section>
+
+<!-- /.features -->
+
+<section class="commits">
+
+### Commits
+
+<details>
+
+-   [`96e896a`](https://github.com/stdlib-js/stdlib/commit/96e896a39be08912b2e06dfb6b671ec13d042412) - **feat:** add support for boolean array indices _(by Athan Reines)_
+-   [`75d4f83`](https://github.com/stdlib-js/stdlib/commit/75d4f83cb85610d23a04dc21a03f8075f6d3665f) - **refactor:** update require and include paths _(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.1">
+
+## 0.1.1 (2024-02-25)
+
+<section class="features">
+
+### Features
+
+-   [`962c155`](https://github.com/stdlib-js/stdlib/commit/962c155e95241834642825085dd4aff8c2f875b3) - add boolean array tests
+-   [`415d506`](https://github.com/stdlib-js/stdlib/commit/415d506180557388d51b876c50139f1c9f1a7760) - attach `ArrayIndex` constructor to the main export
+-   [`993f468`](https://github.com/stdlib-js/stdlib/commit/993f4689776ac7bb86a9eed3bd5977c3549b5e1a) - add support for using index arrays in indexing expressions
+-   [`4394246`](https://github.com/stdlib-js/stdlib/commit/4394246274c5fe1ab05e4b4dafad3217faddcb2b) - add `factory` method for specifying defaults
+-   [`7d12ad0`](https://github.com/stdlib-js/stdlib/commit/7d12ad043d0b88e96bf645ccbe8129fcdb1f4a9e) - add `array/to-fancy`
+
+</section>
+
+<!-- /.features -->
+
+<section class="bug-fixes">
+
+### Bug Fixes
+
+-   [`516b608`](https://github.com/stdlib-js/stdlib/commit/516b60845854eba062430bfb19073a74736c80a0) - support additional error messages
+-   [`29e4c99`](https://github.com/stdlib-js/stdlib/commit/29e4c992e11959432a5347528df132ec56d54121) - propagate options when invoking constructor
+-   [`7eeb330`](https://github.com/stdlib-js/stdlib/commit/7eeb3302172e9a86aa53c803fca6c7b2d2402281) - refactor to preserve constructor behavior and propagate fanciness to returned slices
+
+</section>
+
+<!-- /.bug-fixes -->
+
+<section class="commits">
+
+### Commits
+
+<details>
+
+-   [`64931c5`](https://github.com/stdlib-js/stdlib/commit/64931c5fdb4abc3a339b619658d3b5acc089e556) - **test:** add tests for unsupported index arrays _(by Athan Reines)_
+-   [`ac40e7e`](https://github.com/stdlib-js/stdlib/commit/ac40e7e25c3bba446e70e847f2ae56f165be719a) - **test:** add invalid index expression tests _(by Athan Reines)_
+-   [`eac06b3`](https://github.com/stdlib-js/stdlib/commit/eac06b3dbb611d739adfdf5db52f658ef62c5503) - **test:** add mask array tests _(by Athan Reines)_
+-   [`de52a29`](https://github.com/stdlib-js/stdlib/commit/de52a29daa056e1bd68125b22e72d3796ade59d0) - **test:** fix descriptions and add error condition tests _(by Athan Reines)_
+-   [`962c155`](https://github.com/stdlib-js/stdlib/commit/962c155e95241834642825085dd4aff8c2f875b3) - **feat:** add boolean array tests _(by Athan Reines)_
+-   [`d21b90f`](https://github.com/stdlib-js/stdlib/commit/d21b90f459e4d3853238b8b42aa2440bd71b38c2) - **test:** add integer array tests _(by Athan Reines)_
+-   [`9149295`](https://github.com/stdlib-js/stdlib/commit/9149295a1199abc34a98970fff7bd2ddbf29111c) - **docs:** add support for integer, mask, and boolean arrays _(by Athan Reines)_
+-   [`b8827b4`](https://github.com/stdlib-js/stdlib/commit/b8827b493f1b5c1873ab7a96015f46fcaf8b72b2) - **bench:** add mask and boolean array benchmarks _(by Athan Reines)_
+-   [`516b608`](https://github.com/stdlib-js/stdlib/commit/516b60845854eba062430bfb19073a74736c80a0) - **fix:** support additional error messages _(by Athan Reines)_
+-   [`baae4a9`](https://github.com/stdlib-js/stdlib/commit/baae4a9fda67def76d8668e4417c9f9c3bffd024) - **docs:** fix missing period _(by Athan Reines)_
+-   [`bf00a42`](https://github.com/stdlib-js/stdlib/commit/bf00a4264a988a748bfbba8c23516ac958660a0f) - **test:** add `ArrayIndex` constructor tests _(by Athan Reines)_
+-   [`415d506`](https://github.com/stdlib-js/stdlib/commit/415d506180557388d51b876c50139f1c9f1a7760) - **feat:** attach `ArrayIndex` constructor to the main export _(by Athan Reines)_
+-   [`3e53527`](https://github.com/stdlib-js/stdlib/commit/3e53527323fd705302af15cc66e5dffe45f2cd12) - **bench:** avoid running benchmarks in environments lacking Proxy support _(by Athan Reines)_
+-   [`7137673`](https://github.com/stdlib-js/stdlib/commit/7137673f0798ef13d7c9fd7becf78e557b1d583b) - **docs:** update related packages sections (#1315) _(by stdlib-bot)_
+-   [`d278dc9`](https://github.com/stdlib-js/stdlib/commit/d278dc97ff3c6cbf19dd1ab1fa509b17651ec5db) - **docs:** update note _(by Athan Reines)_
+-   [`993f468`](https://github.com/stdlib-js/stdlib/commit/993f4689776ac7bb86a9eed3bd5977c3549b5e1a) - **feat:** add support for using index arrays in indexing expressions _(by Athan Reines)_
+-   [`9d78727`](https://github.com/stdlib-js/stdlib/commit/9d7872745d201ef9887ccaae9305940abcf57ebc) - **test:** add tests for assigning real-valued arrays to complex-valued arrays _(by Athan Reines)_
+-   [`0188a12`](https://github.com/stdlib-js/stdlib/commit/0188a124778cd4af49a3fbb3ebbeb93f6e7e451f) - **docs:** update copy and clarify identifier _(by Athan Reines)_
+-   [`974889e`](https://github.com/stdlib-js/stdlib/commit/974889e16063cfd28ac32cd90e8d422d669387a2) - **docs:** add note on bounds checking and update cache documentation _(by Athan Reines)_
+-   [`4394246`](https://github.com/stdlib-js/stdlib/commit/4394246274c5fe1ab05e4b4dafad3217faddcb2b) - **feat:** add `factory` method for specifying defaults _(by Athan Reines)_
+-   [`29e4c99`](https://github.com/stdlib-js/stdlib/commit/29e4c992e11959432a5347528df132ec56d54121) - **fix:** propagate options when invoking constructor _(by Athan Reines)_
+-   [`c54fad0`](https://github.com/stdlib-js/stdlib/commit/c54fad0073529822e76c693a17ca168162f89c82) - **docs:** add note _(by Athan Reines)_
+-   [`7eeb330`](https://github.com/stdlib-js/stdlib/commit/7eeb3302172e9a86aa53c803fca6c7b2d2402281) - **fix:** refactor to preserve constructor behavior and propagate fanciness to returned slices _(by Athan Reines)_
+-   [`7442058`](https://github.com/stdlib-js/stdlib/commit/7442058f050c7cc6a4d8b24f2e619f275ea5aae8) - **docs:** update copy _(by Athan Reines)_
+-   [`cdad4f0`](https://github.com/stdlib-js/stdlib/commit/cdad4f0f86efcfb5ef21373c83d454de0a7f7ee2) - **docs:** fix lint errors _(by Athan Reines)_
+-   [`7d12ad0`](https://github.com/stdlib-js/stdlib/commit/7d12ad043d0b88e96bf645ccbe8129fcdb1f4a9e) - **feat:** add `array/to-fancy` _(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 -->
+
diff --git a/docs/types/test.ts b/docs/types/test.ts
@@ -18,6 +18,7 @@
 
 import Complex128Array = require( '@stdlib/array-complex128' );
 import Complex64Array = require( '@stdlib/array-complex64' );
+import BooleanArray = require( '@stdlib/array-bool' );
 import array2fancy = require( './index' );
 
 
@@ -168,16 +169,20 @@ import array2fancy = require( './index' );
 	const y = [ true, false, true, false ];
 	const z = new Uint8Array( [ 1, 0, 1, 0 ] );
 	const w = new Int32Array( [ 1, 2, 3, 4 ] );
+	const v = new BooleanArray( [ true, false, true, false ] );
 
-	array2fancy.idx( x ); // $ExpectType IntegerArrayIndex
-	array2fancy.idx( x, {} ); // $ExpectType IntegerArrayIndex
+	array2fancy.idx( x ); // $ExpectType GenericIntegerArrayIndex
+	array2fancy.idx( x, {} ); // $ExpectType GenericIntegerArrayIndex
 
-	array2fancy.idx( y ); // $ExpectType BooleanArrayIndex
-	array2fancy.idx( y, {} ); // $ExpectType BooleanArrayIndex
+	array2fancy.idx( y ); // $ExpectType GenericBooleanArrayIndex
+	array2fancy.idx( y, {} ); // $ExpectType GenericBooleanArrayIndex
 
 	array2fancy.idx( z ); // $ExpectType MaskArrayIndex
 	array2fancy.idx( z, {} ); // $ExpectType MaskArrayIndex
 
 	array2fancy.idx( w ); // $ExpectType Int32ArrayIndex
 	array2fancy.idx( w, {} ); // $ExpectType Int32ArrayIndex
+
+	array2fancy.idx( v ); // $ExpectType BooleanArrayIndex
+	array2fancy.idx( v, {} ); // $ExpectType BooleanArrayIndex
 }