Better TypeScript configuration for jest

jdeniau · jdeniau · commit 992f37c28c34 · 2025-03-28T22:47:56.000Z
diff --git a/__tests__/ArraySeq.ts b/__tests__/ArraySeq.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { Seq } from 'immutable';
 
 describe('ArraySequence', () => {
diff --git a/__tests__/Comparator.ts b/__tests__/Comparator.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { List, OrderedSet, Seq, type Comparator, PairSorting } from 'immutable';
 
 const sourceNumbers: readonly number[] = [3, 4, 5, 6, 7, 9, 10, 12, 90, 92, 95];
diff --git a/__tests__/Conversion.ts b/__tests__/Conversion.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { fromJS, is, List, Map, OrderedMap, Record } from 'immutable';
 import fc, { type JsonValue } from 'fast-check';
 
diff --git a/__tests__/Equality.ts b/__tests__/Equality.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { is, List, Map, Seq, Set } from 'immutable';
 import fc from 'fast-check';
 
@@ -143,6 +144,7 @@ describe('Equality', () => {
     fc.assert(
       fc.property(genVal, genVal, (a, b) => {
         if (is(a, b)) {
+          // eslint-disable-next-line jest/no-conditional-expect
           expect(a.hashCode()).toBe(b.hashCode());
         }
       }),
diff --git a/__tests__/IndexedSeq.ts b/__tests__/IndexedSeq.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { Seq } from 'immutable';
 
 describe('IndexedSequence', () => {
diff --git a/__tests__/KeyedSeq.ts b/__tests__/KeyedSeq.ts
@@ -1,8 +1,9 @@
+import { describe, expect, it } from '@jest/globals';
 import { Range, Seq } from 'immutable';
 import fc from 'fast-check';
 
 describe('KeyedSeq', () => {
-  it('it iterates equivalently', () => {
+  it('iterates equivalently', () => {
     fc.assert(
       fc.property(fc.array(fc.integer()), (ints) => {
         const seq = Seq(ints);
diff --git a/__tests__/List.ts b/__tests__/List.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { fromJS, List, Map, Range, Seq, Set } from 'immutable';
 import fc from 'fast-check';
 import { create as createSeed } from 'random-seed';
diff --git a/__tests__/ListJS.js b/__tests__/ListJS.js
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { List } from 'immutable';
 
 const NON_NUMBERS = {
diff --git a/__tests__/Map.ts b/__tests__/Map.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it, jest } from '@jest/globals';
 import { fromJS, is, List, Map, Range, Record, Seq } from 'immutable';
 import fc from 'fast-check';
 
diff --git a/__tests__/MultiRequire.js b/__tests__/MultiRequire.js
@@ -1,3 +1,4 @@
+import { describe, expect, it, jest } from '@jest/globals';
 import * as Immutable1 from '../src/Immutable';
 
 jest.resetModules();
diff --git a/__tests__/ObjectSeq.ts b/__tests__/ObjectSeq.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { Seq } from 'immutable';
 
 describe('ObjectSequence', () => {
diff --git a/__tests__/OrderedMap.ts b/__tests__/OrderedMap.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { OrderedMap, Range, Seq } from 'immutable';
 
 describe('OrderedMap', () => {
diff --git a/__tests__/OrderedSet.ts b/__tests__/OrderedSet.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { OrderedSet, Map } from 'immutable';
 
 describe('OrderedSet', () => {
diff --git a/__tests__/Predicates.ts b/__tests__/Predicates.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import {
   is,
   isImmutable,
diff --git a/__tests__/Range.ts b/__tests__/Range.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { Range } from 'immutable';
 import fc from 'fast-check';
 
@@ -86,6 +87,7 @@ describe('Range', () => {
         const last = to + (isIncreasing ? -1 : 1);
         expect(r.last()).toBe(size ? last : undefined);
         if (size) {
+          // eslint-disable-next-line jest/no-conditional-expect
           expect(a[a.length - 1]).toBe(last);
         }
       })
diff --git a/__tests__/Record.ts b/__tests__/Record.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { isKeyed, List, Map, Record, Seq } from 'immutable';
 
 describe('Record', () => {
@@ -78,7 +79,7 @@ describe('Record', () => {
     const MyType = Record({ a: 1, b: 2, c: 3 });
     const t1 = MyType({ a: 10 });
     const t2 = MyType({ a: 10, b: 2 });
-    expect(t1.equals(t2));
+    expect(t1.equals(t2)).toBe(true);
   });
 
   it('if compared against undefined or null should return false', () => {
diff --git a/__tests__/RecordJS.js b/__tests__/RecordJS.js
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { Record } from 'immutable';
 
 describe('Record', () => {
@@ -41,8 +42,8 @@ describe('Record', () => {
     const t = new Alphabet();
     const t2 = t.set('b', 200);
 
-    expect(t instanceof Record);
-    expect(t instanceof Alphabet);
+    expect(t instanceof Record).toBe(true);
+    expect(t instanceof Alphabet).toBe(true);
     expect(t.soup()).toBe(6);
     expect(t2.soup()).toBe(204);
 
diff --git a/__tests__/Repeat.ts b/__tests__/Repeat.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { Repeat } from 'immutable';
 
 describe('Repeat', () => {
diff --git a/__tests__/Seq.ts b/__tests__/Seq.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { isCollection, isIndexed, isKeyed, Seq } from 'immutable';
 
 describe('Seq', () => {
diff --git a/__tests__/Set.ts b/__tests__/Set.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it, jest } from '@jest/globals';
 import { fromJS, is, List, Map, OrderedSet, Seq, Set } from 'immutable';
 
 describe('Set', () => {
diff --git a/__tests__/Stack.ts b/__tests__/Stack.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { Seq, Stack } from 'immutable';
 import fc from 'fast-check';
 
diff --git a/__tests__/concat.ts b/__tests__/concat.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { List, Seq, Set } from 'immutable';
 
 describe('concat', () => {
diff --git a/__tests__/count.ts b/__tests__/count.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { Range, Seq } from 'immutable';
 
 describe('count', () => {
diff --git a/__tests__/find.ts b/__tests__/find.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { Seq } from 'immutable';
 
 describe('find', () => {
diff --git a/__tests__/flatten.ts b/__tests__/flatten.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { Collection, fromJS, List, Range, Seq } from 'immutable';
 
 describe('flatten', () => {
diff --git a/__tests__/fromJS.ts b/__tests__/fromJS.ts
@@ -1,5 +1,5 @@
+import { describe, expect, it } from '@jest/globals';
 import { runInNewContext } from 'vm';
-
 import { List, Map, Set, isCollection, fromJS } from 'immutable';
 
 describe('fromJS', () => {
@@ -64,6 +64,7 @@ describe('fromJS', () => {
     expect(isCollection(fromJS({}))).toBe(true);
   });
 
+  // eslint-disable-next-line jest/expect-expect
   it('is iterable inside of a vm', () => {
     runInNewContext(
       `
diff --git a/__tests__/functional/get.ts b/__tests__/functional/get.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { get, Map, List, Range } from 'immutable';
 
 describe('get', () => {
diff --git a/__tests__/functional/has.ts b/__tests__/functional/has.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { has, Map, List, Range } from 'immutable';
 
 describe('has', () => {
diff --git a/__tests__/functional/remove.ts b/__tests__/functional/remove.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { remove, List, Map } from 'immutable';
 
 describe('remove', () => {
diff --git a/__tests__/functional/set.ts b/__tests__/functional/set.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { set } from 'immutable';
 
 describe('set', () => {
diff --git a/__tests__/functional/update.ts b/__tests__/functional/update.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { update } from 'immutable';
 
 describe('update', () => {
diff --git a/__tests__/get.ts b/__tests__/get.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { Range } from 'immutable';
 
 describe('get', () => {
diff --git a/__tests__/getIn.ts b/__tests__/getIn.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { fromJS, getIn, List, Map } from 'immutable';
 
 describe('getIn', () => {
diff --git a/__tests__/groupBy.ts b/__tests__/groupBy.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import {
   Collection,
   Map,
@@ -40,8 +41,10 @@ describe('groupBy', () => {
       expect(isOrdered(col)).toBe(constructorIsOrdered);
       expect(isOrdered(grouped)).toBe(constructorIsOrdered);
       if (constructorIsOrdered) {
+        // eslint-disable-next-line jest/no-conditional-expect
         expect(grouped).toBeInstanceOf(OrderedMap);
       } else {
+        // eslint-disable-next-line jest/no-conditional-expect
         expect(grouped).not.toBeInstanceOf(OrderedMap);
       }
     }
diff --git a/__tests__/hasIn.ts b/__tests__/hasIn.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { fromJS, hasIn, List, Map } from 'immutable';
 
 describe('hasIn', () => {
diff --git a/__tests__/hash.ts b/__tests__/hash.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { hash } from 'immutable';
 import fc from 'fast-check';
 
diff --git a/__tests__/interpose.ts b/__tests__/interpose.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { Range } from 'immutable';
 
 describe('interpose', () => {
diff --git a/__tests__/issues.ts b/__tests__/issues.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import {
   fromJS,
   List,
@@ -34,7 +35,7 @@ describe('Issue #1188', () => {
   });
 });
 
-describe('Issue #1220 : Seq.rest() throws an exception when invoked on a single item sequence ', () => {
+describe('Issue #1220 : Seq.rest() throws an exception when invoked on a single item sequence', () => {
   it('should be iterable', () => {
     // Helper for this test
     const ITERATOR_SYMBOL =
@@ -122,15 +123,17 @@ describe('Issue #1643', () => {
 
     it(`Collection#hashCode() should handle objects that return ${label} for valueOf`, () => {
       const set = Set().add(new MyClass());
-      set.hashCode();
+      expect(() => set.hashCode()).not.toThrow();
     });
   });
 });
 
 describe('Issue #1785', () => {
-  const emptyRecord = Record({})();
+  it('merge() should not return undefined', () => {
+    const emptyRecord = Record({})();
 
-  expect(emptyRecord.merge({ id: 1 })).toBe(emptyRecord);
+    expect(emptyRecord.merge({ id: 1 })).toBe(emptyRecord);
+  });
 });
 
 describe('Issue #1475', () => {
diff --git a/__tests__/join.ts b/__tests__/join.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { Seq } from 'immutable';
 import fc from 'fast-check';
 
diff --git a/__tests__/merge.ts b/__tests__/merge.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import {
   fromJS,
   List,
@@ -34,7 +35,7 @@ describe('merge', () => {
     const m1 = Map({ a: 1, b: 2, c: 3 });
     const m2 = Map({ d: 10, b: 20, e: 30 });
     // @ts-expect-error -- test that runtime does throw
-    expect(() => m1.mergeWith(1, m2)).toThrowError(TypeError);
+    expect(() => m1.mergeWith(1, m2)).toThrow(TypeError);
   });
 
   it('provides key as the third argument of merge function', () => {
diff --git a/__tests__/minmax.ts b/__tests__/minmax.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { is, Seq } from 'immutable';
 import fc from 'fast-check';
 
diff --git a/__tests__/partition.ts b/__tests__/partition.ts
@@ -1,3 +1,4 @@
+import { beforeEach, describe, expect, it, jest } from '@jest/globals';
 import {
   isAssociative,
   isIndexed,
@@ -13,7 +14,7 @@ import {
 } from 'immutable';
 
 describe('partition', () => {
-  let isOdd: jest.Mock<unknown, [x: number]>;
+  let isOdd: jest.Mock<(x: number) => number>;
 
   beforeEach(() => {
     isOdd = jest.fn((x) => x % 2);
diff --git a/__tests__/slice.ts b/__tests__/slice.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { List, Range, Seq } from 'immutable';
 import fc from 'fast-check';
 
diff --git a/__tests__/sort.ts b/__tests__/sort.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { List, OrderedMap, Range, Seq } from 'immutable';
 
 describe('sort', () => {
diff --git a/__tests__/splice.ts b/__tests__/splice.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { List, Range, Seq } from 'immutable';
 import fc from 'fast-check';
 
diff --git a/__tests__/transformerProtocol.ts b/__tests__/transformerProtocol.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import * as t from 'transducers-js';
 import { List, Map, Set, Stack } from 'immutable';
 
diff --git a/__tests__/ts-utils.ts b/__tests__/ts-utils.ts
@@ -1,3 +1,5 @@
+import { expect } from '@jest/globals';
+
 export function expectToBeDefined<T>(
   arg: T
 ): asserts arg is Exclude<T, undefined> {
diff --git a/__tests__/updateIn.ts b/__tests__/updateIn.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import {
   fromJS,
   List,
diff --git a/__tests__/zip.ts b/__tests__/zip.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from '@jest/globals';
 import { List, Range, Seq } from 'immutable';
 import fc from 'fast-check';
 import { expectToBeDefined } from './ts-utils';
diff --git a/eslint.config.mjs b/eslint.config.mjs
diff --git a/jest.config.mjs b/jest.config.mjs
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/perf/List.js b/perf/List.js
diff --git a/website/src/MarkdownContent.tsx b/website/src/MarkdownContent.tsx

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { describe, expect, it } from '@jest/globals';`
`1`	`2`	`import { Seq } from 'immutable';`
`2`	`3`
`3`	`4`	`describe('ArraySequence', () => {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { describe, expect, it } from '@jest/globals';`
`1`	`2`	`import { List, OrderedSet, Seq, type Comparator, PairSorting } from 'immutable';`
`2`	`3`
`3`	`4`	`const sourceNumbers: readonly number[] = [3, 4, 5, 6, 7, 9, 10, 12, 90, 92, 95];`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { describe, expect, it } from '@jest/globals';`
`1`	`2`	`import { fromJS, is, List, Map, OrderedMap, Record } from 'immutable';`
`2`	`3`	`import fc, { type JsonValue } from 'fast-check';`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { describe, expect, it } from '@jest/globals';`
`1`	`2`	`import { fromJS, List, Map, Range, Seq, Set } from 'immutable';`
`2`	`3`	`import fc from 'fast-check';`
`3`	`4`	`import { create as createSeed } from 'random-seed';`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { describe, expect, it } from '@jest/globals';`
`1`	`2`	`import { List } from 'immutable';`
`2`	`3`
`3`	`4`	`const NON_NUMBERS = {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { describe, expect, it, jest } from '@jest/globals';`
`1`	`2`	`import { fromJS, is, List, Map, Range, Record, Seq } from 'immutable';`
`2`	`3`	`import fc from 'fast-check';`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { describe, expect, it, jest } from '@jest/globals';`
`1`	`2`	`import * as Immutable1 from '../src/Immutable';`
`2`	`3`
`3`	`4`	`jest.resetModules();`