feat: BigInt Support (#8382)

* feat(jest-get-type) include bigint

* (jest-matcher-utils) add ensureActualIsNumberOrBigInit

Originally planned on just including biginit in ensurenumbers, but the only built in matcher that cant accept biginit would be toBeCloseTo

* (expect) add biginit support

* Revert gettype to ifelse

* Add tests mixing numbers and bigint

* bigDumbTypo

* babel-plugin-jest-hoist add to whitelist

* Wrap BigInt Tests with guard

* temp fix test suite must contain at least one test

* remove MatchingSnapshot tests due to unsupported env having obsoletes

* remove unnecessary bigint check in equals

* Remove ensure*NumbersOrBigInt, include BigInt in originals, add `or bigint` to errors

* Update snapshots with new error message `number or bigint`

* add bigint support to toBeCloseTo, replace ensureNumbersOrBigInt to ensureNumbers

* tests(expect) remove temp_test, add bigint tests to matchers.test

* tests(jest-matcher-utils) remove temp_tests, add bigint tests to index,test

* Update CHANGELOG.md

* Update CHANGELOG.md

* (babel-preset-jest)-add @babel/plugin-syntax-bigint

* Add tests for bigint syntax

* Update CHANGELOG.md

*   🔤

* Checking if node6 breaks with lookup

* Revert "Checking if node6 breaks with lookup"

This reverts commit 592d6f3.

* Revert "Add tests for bigint syntax"

This reverts commit be5cbb6.

* Update CHANGELOG.md

Co-Authored-By: JoshRosenstein <josh@joshuarosenstein.com>

* Remove Default Precision Value and update error msg via code review

#8382 (comment)
#8382 (comment)

* Replace ensureExpectedIsNumber with ensureExpectedIsNonNegativeInteger for spy matchers

https://github.com/facebook/jest/pull/8382/files/fb6655d33f5efac890b77f199bd5b3f7684b1421#r280160170

* Update Matchers interface

* Revert Bigint Support for 'toBeCloseTo'

* Update CHANGELOG.md

* pedrottimark's CR fixes in tests 👀 🎯

* Update CHANGELOG.md

* move changelog entries

* fix changelog formatting

* Delete unnecessary disable of eslint rules

* Update ExpectAPI.md

* Update CHANGELOG.md

* Edit ExpectAPI.md

CHANGELOG.md

@@ -3,12 +3,17 @@
 ### Features
 
 - `[babel-plugin-jest-hoist]` Show codeframe on static hoisting issues ([#8865](https://github.com/facebook/jest/pull/8865))
+- `[babel-plugin-jest-hoist]` Add `BigInt` to `WHITELISTED_IDENTIFIERS` ([#8382](https://github.com/facebook/jest/pull/8382))
+- `[babel-preset-jest]` Add `@babel/plugin-syntax-bigint` ([#8382](https://github.com/facebook/jest/pull/8382))
+- `[expect]` Add `BigInt` support to `toBeGreaterThan`, `toBeGreaterThanOrEqual`, `toBeLessThan` and `toBeLessThanOrEqual` ([#8382](https://github.com/facebook/jest/pull/8382))
 - `[jest-config]` [**BREAKING**] Set default display name color based on runner ([#8689](https://github.com/facebook/jest/pull/8689))
 - `[jest-diff]` Add options for colors and symbols ([#8841](https://github.com/facebook/jest/pull/8841))
 - `[jest-diff]` [**BREAKING**] Export as ECMAScript module ([#8873](https://github.com/facebook/jest/pull/8873))
 - `[jest-diff]` Add `includeChangeCounts` and rename `Indicator` options ([#8881](https://github.com/facebook/jest/pull/8881))
 - `[jest-diff]` Add `changeColor` and `patchColor` options ([#8911](https://github.com/facebook/jest/pull/8911))
 - `[@jest/fake-timers]` Add Lolex as implementation of fake timers ([#8897](https://github.com/facebook/jest/pull/8897))
+- `[jest-get-type]` Add `BigInt` support. ([#8382](https://github.com/facebook/jest/pull/8382))
+- `[jest-matcher-utils]` Add `BigInt` support to `ensureNumbers` `ensureActualIsNumber`, `ensureExpectedIsNumber` ([#8382](https://github.com/facebook/jest/pull/8382))
 - `[jest-runner]` Warn if a worker had to be force exited ([#8206](https://github.com/facebook/jest/pull/8206))
 - `[@jest/test-result]` Create method to create empty `TestResult` ([#8867](https://github.com/facebook/jest/pull/8867))
 - `[jest-worker]` [**BREAKING**] Return a promise from `end()`, resolving with the information whether workers exited gracefully ([#8206](https://github.com/facebook/jest/pull/8206))
@@ -447,7 +452,7 @@ We skipped 24.2.0 because a draft was accidentally published. Please use `24.3.0
 - `[jest-haste-map]` Add `getCacheFilePath` to get the path to the cache file for a `HasteMap` instance ([#7217](https://github.com/facebook/jest/pull/7217))
 - `[jest-runtime]` Remove `cacheDirectory` from `ignorePattern` for `HasteMap` if not necessary ([#7166](https://github.com/facebook/jest/pull/7166))
 - `[jest-validate]` Add syntax to validate multiple permitted types ([#7207](https://github.com/facebook/jest/pull/7207))
-- `[jest-config]` Accept an array as as well as a string for `testRegex`([#7209]https://github.com/facebook/jest/pull/7209))
+- `[jest-config]` Accept an array as as well as a string for `testRegex` ([#7209]https://github.com/facebook/jest/pull/7209))
 - `[expect/jest-matcher-utils]` Improve report when assertion fails, part 4 ([#7241](https://github.com/facebook/jest/pull/7241))
 - `[expect/jest-matcher-utils]` Improve report when assertion fails, part 5 ([#7557](https://github.com/facebook/jest/pull/7557))
 - `[expect]` Check constructor equality in .toStrictEqual() ([#7005](https://github.com/facebook/jest/pull/7005))
@@ -496,7 +501,7 @@ We skipped 24.2.0 because a draft was accidentally published. Please use `24.3.0
 - `[jest-jasmine2]` Better error message when a describe block is empty ([#6372](https://github.com/facebook/jest/pull/6372))
 - `[jest-jasmine2]` Pending calls inside async tests are reported as pending not failed ([#6782](https://github.com/facebook/jest/pull/6782))
 - `[jest-circus]` Better error message when a describe block is empty ([#6372](https://github.com/facebook/jest/pull/6372))
-- `[jest-jasmine2]` Add missing testLocationResults for `xit` and `fit`([#6482](https://github.com/facebook/jest/pull/6482))
+- `[jest-jasmine2]` Add missing testLocationResults for `xit` and `fit` ([#6482](https://github.com/facebook/jest/pull/6482))
 - `[expect]` Return false from asymmetric matchers if received value isn’t string ([#7107](https://github.com/facebook/jest/pull/7107))
 - `[jest-cli]` Fix unhandled error when a bad revision is provided to `changedSince` ([#7115](https://github.com/facebook/jest/pull/7115))
 - `[jest-config]` Moved dynamically assigned `cwd` from `jest-cli` to default configuration in `jest-config` ([#7146](https://github.com/facebook/jest/pull/7146))

docs/ExpectAPI.md

@@ -831,25 +831,29 @@ test('this house has my desired features', () => {
 
 ### `.toBeCloseTo(number, numDigits?)`
 
-Using exact equality with floating point numbers is a bad idea. Rounding means that intuitive things fail. For example, this test fails:
+Use `toBeCloseTo` to compare floating point numbers for approximate equality.
+
+The optional `numDigits` argument limits the number of digits to check **after** the decimal point. For the default value `2`, the test criterion is `Math.abs(expected - received) < 0.005` (that is, `10 ** -2 / 2`).
+
+Intuitive equality comparisons often fail, because arithmetic on decimal (base 10) values often have rounding errors in limited precision binary (base 2) representation. For example, this test fails:
 
 ```js
 test('adding works sanely with simple decimals', () => {
   expect(0.2 + 0.1).toBe(0.3); // Fails!
 });
 ```
 
-It fails because in JavaScript, `0.2 + 0.1` is actually `0.30000000000000004`. Sorry.
+It fails because in JavaScript, `0.2 + 0.1` is actually `0.30000000000000004`.
 
-Instead, use `.toBeCloseTo`. Use `numDigits` to control how many digits after the decimal point to check. For example, if you want to be sure that `0.2 + 0.1` is equal to `0.3` with a precision of 5 decimal digits, you can use this test:
+For example, this test passes with a precision of 5 digits:
 
 ```js
 test('adding works sanely with simple decimals', () => {
   expect(0.2 + 0.1).toBeCloseTo(0.3, 5);
 });
 ```
 
-The optional `numDigits` argument has default value `2` which means the criterion is `Math.abs(expected - received) < 0.005` (that is, `10 ** -2 / 2`).
+Because floating point errors are the problem that `toBeCloseTo` solves, it does not support big integer values.
 
 ### `.toBeDefined()`
 
@@ -885,39 +889,39 @@ test('drinking La Croix does not lead to errors', () => {
 
 In JavaScript, there are six falsy values: `false`, `0`, `''`, `null`, `undefined`, and `NaN`. Everything else is truthy.
 
-### `.toBeGreaterThan(number)`
+### `.toBeGreaterThan(number | bigint)`
 
-To compare floating point numbers, you can use `toBeGreaterThan`. For example, if you want to test that `ouncesPerCan()` returns a value of more than 10 ounces, write:
+Use `toBeGreaterThan` to compare `received > expected` for number or big integer values. For example, test that `ouncesPerCan()` returns a value of more than 10 ounces:
 
 ```js
 test('ounces per can is more than 10', () => {
   expect(ouncesPerCan()).toBeGreaterThan(10);
 });
 ```
 
-### `.toBeGreaterThanOrEqual(number)`
+### `.toBeGreaterThanOrEqual(number | bigint)`
 
-To compare floating point numbers, you can use `toBeGreaterThanOrEqual`. For example, if you want to test that `ouncesPerCan()` returns a value of at least 12 ounces, write:
+Use `toBeGreaterThanOrEqual` to compare `received >= expected` for number or big integer values. For example, test that `ouncesPerCan()` returns a value of at least 12 ounces:
 
 ```js
 test('ounces per can is at least 12', () => {
   expect(ouncesPerCan()).toBeGreaterThanOrEqual(12);
 });
 ```
 
-### `.toBeLessThan(number)`
+### `.toBeLessThan(number | bigint)`
 
-To compare floating point numbers, you can use `toBeLessThan`. For example, if you want to test that `ouncesPerCan()` returns a value of less than 20 ounces, write:
+Use `toBeLessThan` to compare `received < expected` for number or big integer values. For example, test that `ouncesPerCan()` returns a value of less than 20 ounces:
 
 ```js
 test('ounces per can is less than 20', () => {
   expect(ouncesPerCan()).toBeLessThan(20);
 });
 ```
 
-### `.toBeLessThanOrEqual(number)`
+### `.toBeLessThanOrEqual(number | bigint)`
 
-To compare floating point numbers, you can use `toBeLessThanOrEqual`. For example, if you want to test that `ouncesPerCan()` returns a value of at most 12 ounces, write:
+Use `toBeLessThanOrEqual` to compare `received <= expected` for number or big integer values. For example, test that `ouncesPerCan()` returns a value of at most 12 ounces:
 
 ```js
 test('ounces per can is at most 12', () => {

packages/babel-plugin-jest-hoist/src/index.ts

@@ -20,6 +20,7 @@ const WHITELISTED_IDENTIFIERS = new Set<string>(
     'Array',
     'ArrayBuffer',
     'Boolean',
+    'BigInt',
     'DataView',
     'Date',
     'Error',

packages/babel-preset-jest/index.js

@@ -9,5 +9,6 @@ module.exports = () => ({
   plugins: [
     require.resolve('babel-plugin-jest-hoist'),
     require.resolve('@babel/plugin-syntax-object-rest-spread'),
+    require.resolve('@babel/plugin-syntax-bigint'),
   ],
 });

packages/babel-preset-jest/package.json

@@ -9,6 +9,7 @@
   "license": "MIT",
   "main": "index.js",
   "dependencies": {
+    "@babel/plugin-syntax-bigint": "^7.0.0",
     "@babel/plugin-syntax-object-rest-spread": "^7.0.0",
     "babel-plugin-jest-hoist": "^24.9.0"
   },