chore(lint): use jest/prefer-to-have-length rule (#13370)

Author: mrazauskas

.eslintrc.cjs

@@ -167,6 +167,8 @@ module.exports = {
         'jest/no-focused-tests': 'error',
         'jest/no-identical-title': 'error',
         'jest/prefer-to-be': 'error',
+        'jest/prefer-to-contain': 'error',
+        'jest/prefer-to-have-length': 'error',
         'jest/valid-expect': 'error',
       },
     },

docs/Es6ClassMocks.md

@@ -349,7 +349,7 @@ jest.mock('./sound-player', () => {
 });
 ```
 
-This will let us inspect usage of our mocked class, using `SoundPlayer.mock.calls`: `expect(SoundPlayer).toHaveBeenCalled();` or near-equivalent: `expect(SoundPlayer.mock.calls.length).toBe(1);`
+This will let us inspect usage of our mocked class, using `SoundPlayer.mock.calls`: `expect(SoundPlayer).toHaveBeenCalled();` or near-equivalent: `expect(SoundPlayer.mock.calls.length).toBeGreaterThan(0);`
 
 ### Mocking non-default class exports
 

docs/JestObjectAPI.md

@@ -230,16 +230,16 @@ const example = jest.createMockFromModule('../example');
 test('should run example code', () => {
   // creates a new mocked function with no formal arguments.
   expect(example.function.name).toBe('square');
-  expect(example.function.length).toBe(0);
+  expect(example.function).toHaveLength(0);
 
   // async functions get the same treatment as standard synchronous functions.
   expect(example.asyncFunction.name).toBe('asyncSquare');
-  expect(example.asyncFunction.length).toBe(0);
+  expect(example.asyncFunction).toHaveLength(0);
 
   // creates a new class with the same interface, member functions and properties are mocked.
   expect(example.class.constructor.name).toBe('Bar');
   expect(example.class.foo.name).toBe('foo');
-  expect(example.class.array.length).toBe(0);
+  expect(example.class.array).toHaveLength(0);
 
   // creates a deeply cloned version of the original object.
   expect(example.object).toEqual({
@@ -251,7 +251,7 @@ test('should run example code', () => {
   });
 
   // creates a new empty array, ignoring the original array.
-  expect(example.array.length).toBe(0);
+  expect(example.array).toHaveLength(0);
 
   // creates a new property with the same primitive value as the original property.
   expect(example.number).toBe(123);

e2e/__tests__/jasmineAsync.test.ts

@@ -47,7 +47,7 @@ describe('async jasmine', () => {
     expect(json.numPendingTests).toBe(0);
     expect(json.testResults[0].message).toBe('');
 
-    expect((result.stderr.match(/unset flag/g) || []).length).toBe(1);
+    expect(result.stderr.match(/unset flag/g) || []).toHaveLength(1);
   });
 
   it('works with afterEach', () => {

e2e/__tests__/setupFilesAfterEnvConfig.test.ts

@@ -40,7 +40,7 @@ describe('setupFilesAfterEnv', () => {
 
     expect(result.json.numTotalTests).toBe(2);
     expect(result.json.numPassedTests).toBe(2);
-    expect(result.json.testResults.length).toBe(2);
+    expect(result.json.testResults).toHaveLength(2);
     expect(result.exitCode).toBe(0);
   });
 
@@ -61,7 +61,7 @@ describe('setupFilesAfterEnv', () => {
 
     expect(result.json.numTotalTests).toBe(1);
     expect(result.json.numPassedTests).toBe(1);
-    expect(result.json.testResults.length).toBe(1);
+    expect(result.json.testResults).toHaveLength(1);
     expect(result.exitCode).toBe(0);
   });
 });

e2e/__tests__/testInRoot.test.ts

@@ -19,7 +19,7 @@ it('runs tests in only test.js and spec.js', () => {
     .map(name => path.basename(name))
     .sort();
 
-  expect(testNames.length).toBe(2);
+  expect(testNames).toHaveLength(2);
   expect(testNames[0]).toBe('spec.js');
   expect(testNames[1]).toBe('test.js');
 });

e2e/auto-clear-mocks/with-auto-clear/__tests__/index.js

@@ -15,14 +15,14 @@ test('first test', () => {
   importedFn();
   expect(localFn()).toBe('abcd');
 
-  expect(importedFn.mock.calls.length).toBe(1);
-  expect(localFn.mock.calls.length).toBe(1);
+  expect(importedFn).toHaveBeenCalledTimes(1);
+  expect(localFn).toHaveBeenCalledTimes(1);
 });
 
 test('second test', () => {
   importedFn();
   expect(localFn()).toBe('abcd');
 
-  expect(importedFn.mock.calls.length).toBe(1);
-  expect(localFn.mock.calls.length).toBe(1);
+  expect(importedFn).toHaveBeenCalledTimes(1);
+  expect(localFn).toHaveBeenCalledTimes(1);
 });

e2e/auto-clear-mocks/without-auto-clear/__tests__/index.js

@@ -17,16 +17,16 @@ describe('without an explicit reset', () => {
     importedFn();
     expect(localFn()).toBe('abcd');
 
-    expect(importedFn.mock.calls.length).toBe(1);
-    expect(localFn.mock.calls.length).toBe(1);
+    expect(importedFn).toHaveBeenCalledTimes(1);
+    expect(localFn).toHaveBeenCalledTimes(1);
   });
 
   test('second test', () => {
     importedFn();
     expect(localFn()).toBe('abcd');
 
-    expect(importedFn.mock.calls.length).toBe(2);
-    expect(localFn.mock.calls.length).toBe(2);
+    expect(importedFn).toHaveBeenCalledTimes(2);
+    expect(localFn).toHaveBeenCalledTimes(2);
   });
 });
 
@@ -39,15 +39,15 @@ describe('with an explicit reset', () => {
     importedFn();
     expect(localFn()).toBe('abcd');
 
-    expect(importedFn.mock.calls.length).toBe(1);
-    expect(localFn.mock.calls.length).toBe(1);
+    expect(importedFn).toHaveBeenCalledTimes(1);
+    expect(localFn).toHaveBeenCalledTimes(1);
   });
 
   test('second test', () => {
     importedFn();
     expect(localFn()).toBe('abcd');
 
-    expect(importedFn.mock.calls.length).toBe(1);
-    expect(localFn.mock.calls.length).toBe(1);
+    expect(importedFn).toHaveBeenCalledTimes(1);
+    expect(localFn).toHaveBeenCalledTimes(1);
   });
 });

e2e/auto-reset-mocks/with-auto-reset/__tests__/index.js

@@ -15,14 +15,14 @@ test('first test', () => {
   importedFn();
   localFn();
 
-  expect(importedFn.mock.calls.length).toBe(1);
-  expect(localFn.mock.calls.length).toBe(1);
+  expect(importedFn).toHaveBeenCalledTimes(1);
+  expect(localFn).toHaveBeenCalledTimes(1);
 });
 
 test('second test', () => {
   importedFn();
   localFn();
 
-  expect(importedFn.mock.calls.length).toBe(1);
-  expect(localFn.mock.calls.length).toBe(1);
+  expect(importedFn).toHaveBeenCalledTimes(1);
+  expect(localFn).toHaveBeenCalledTimes(1);
 });

e2e/auto-reset-mocks/without-auto-reset/__tests__/index.js

@@ -17,16 +17,16 @@ describe('without an explicit reset', () => {
     importedFn();
     localFn();
 
-    expect(importedFn.mock.calls.length).toBe(1);
-    expect(localFn.mock.calls.length).toBe(1);
+    expect(importedFn).toHaveBeenCalledTimes(1);
+    expect(localFn).toHaveBeenCalledTimes(1);
   });
 
   test('second test', () => {
     importedFn();
     localFn();
 
-    expect(importedFn.mock.calls.length).toBe(2);
-    expect(localFn.mock.calls.length).toBe(2);
+    expect(importedFn).toHaveBeenCalledTimes(2);
+    expect(localFn).toHaveBeenCalledTimes(2);
   });
 });
 
@@ -39,15 +39,15 @@ describe('with an explicit reset', () => {
     importedFn();
     localFn();
 
-    expect(importedFn.mock.calls.length).toBe(1);
-    expect(localFn.mock.calls.length).toBe(1);
+    expect(importedFn).toHaveBeenCalledTimes(1);
+    expect(localFn).toHaveBeenCalledTimes(1);
   });
 
   test('second test', () => {
     importedFn();
     localFn();
 
-    expect(importedFn.mock.calls.length).toBe(1);
-    expect(localFn.mock.calls.length).toBe(1);
+    expect(importedFn).toHaveBeenCalledTimes(1);
+    expect(localFn).toHaveBeenCalledTimes(1);
   });
 });