feat: add support for boolean arrays

kgryte · kgryte · commit 20b38726fe1b · 2025-01-19T19:59:13.000-08:00
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/_tools/doctest/compare-values/lib/main.js b/lib/node_modules/@stdlib/_tools/doctest/compare-values/lib/main.js
@@ -46,6 +46,7 @@ var isObjectLike = require( '@stdlib/assert/is-object-like' );
 var isFunction = require( '@stdlib/assert/is-function' );
 var isTypedArray = require( '@stdlib/assert/is-typed-array' );
 var isComplexTypedArray = require( '@stdlib/assert/is-complex-typed-array' );
+var isBooleanArray = require( '@stdlib/assert/is-booleanarray' );
 var isError = require( '@stdlib/assert/is-error' );
 var isTypeError = require( '@stdlib/assert/is-type-error' );
 var isSyntaxError = require( '@stdlib/assert/is-syntax-error' );
@@ -63,6 +64,7 @@ var trim = require( '@stdlib/string/trim' );
 var PINF = require( '@stdlib/constants/float64/pinf' );
 var NINF = require( '@stdlib/constants/float64/ninf' );
 var reinterpretComplex = require( '@stdlib/strided/base/reinterpret-complex' );
+var copyArray = require( '@stdlib/array/base/copy' );
 var createAnnotationValue = require( '@stdlib/_tools/doctest/create-annotation-value' );
 var parse = require( './parse.js' );
 
@@ -255,6 +257,8 @@ function checkTypedArrays( actual, expected ) {
 		if ( entries ) {
 			if ( isComplexTypedArray( actual ) ) {
 				actual = reinterpretComplex( actual, 0 );
+			} else if ( isBooleanArray( actual ) ) {
+				actual = copyArray( actual );
 			}
 			return compareEntries( actual, parse( entries ) );
 		}
@@ -409,7 +413,7 @@ function compareValues( actual, expected ) {
 		}
 		return null;
 	}
-	if ( isTypedArray( actual ) || isComplexTypedArray( actual ) ) {
+	if ( isTypedArray( actual ) || isComplexTypedArray( actual ) || isBooleanArray( actual ) ) {
 		return checkTypedArrays( actual, expected );
 	}
 	if ( isArray( actual ) ) {
diff --git a/lib/node_modules/@stdlib/_tools/doctest/compare-values/test/test.js b/lib/node_modules/@stdlib/_tools/doctest/compare-values/test/test.js
@@ -29,6 +29,7 @@ var Complex64 = require( '@stdlib/complex/float32/ctor' );
 var Complex128 = require( '@stdlib/complex/float64/ctor' );
 var Complex64Array = require( '@stdlib/array/complex64' );
 var Complex128Array = require( '@stdlib/array/complex128' );
+var BooleanArray = require( '@stdlib/array/bool' );
 var compareValues = require( './../lib' );
 
 
@@ -315,6 +316,15 @@ tape( 'the function compares a typed array and a corresponding return annotation
 	msg = 'Expected array entries [1,1,2,2], but observed [1,-1,2,-2]';
 	t.strictEqual( compareValues( actual, expected ), msg, 'returns expected message' );
 
+	actual = new BooleanArray( [ true, false, true, false ] );
+	expected = '<BooleanArray>[ true, false, true, false ]';
+	t.strictEqual( compareValues( actual, expected ), null, 'returns null' );
+
+	actual = new BooleanArray( [ true, false, true, false ] );
+	expected = '<BooleanArray>[ true, true, true, true ]';
+	msg = 'Expected array entries [true,true,true,true], but observed [true,false,true,false]';
+	t.strictEqual( compareValues( actual, expected ), msg, 'returns expected message' );
+
 	t.end();
 });
 
