chore: use ban-types eslint rule (#8041)

jestjs · Mar 4, 2019 · 4a5d5d7 · 4a5d5d7
1 parent 5ba35be
commit 4a5d5d7
Show file tree

Hide file tree

Showing 17 changed files with 42 additions and 31 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -21,6 +21,7 @@ module.exports = {
       plugins: ['@typescript-eslint/eslint-plugin'],
       rules: {
         '@typescript-eslint/array-type': ['error', 'generic'],
+        '@typescript-eslint/ban-types': 'error',
         '@typescript-eslint/no-unused-vars': [
           'error',
           {argsIgnorePattern: '^_'},

diff --git a/packages/expect/src/asymmetricMatchers.ts b/packages/expect/src/asymmetricMatchers.ts
@@ -12,7 +12,7 @@ import {emptyObject} from './utils';
 
 export class AsymmetricMatcher<T> {
   protected sample: T;
-  $$typeof: Symbol;
+  $$typeof: symbol;
   inverse?: boolean;
 
   constructor(sample: T) {
@@ -139,8 +139,8 @@ class ArrayContaining extends AsymmetricMatcher<Array<unknown>> {
   }
 }
 
-class ObjectContaining extends AsymmetricMatcher<Object> {
-  constructor(sample: Object, inverse: boolean = false) {
+class ObjectContaining extends AsymmetricMatcher<Record<string, any>> {
+  constructor(sample: Record<string, any>, inverse: boolean = false) {
     super(sample);
     this.inverse = inverse;
   }
@@ -245,9 +245,9 @@ export const arrayContaining = (sample: Array<unknown>) =>
   new ArrayContaining(sample);
 export const arrayNotContaining = (sample: Array<unknown>) =>
   new ArrayContaining(sample, true);
-export const objectContaining = (sample: Object) =>
+export const objectContaining = (sample: Record<string, any>) =>
   new ObjectContaining(sample);
-export const objectNotContaining = (sample: Object) =>
+export const objectNotContaining = (sample: Record<string, any>) =>
   new ObjectContaining(sample, true);
 export const stringContaining = (expected: string) =>
   new StringContaining(expected);

diff --git a/packages/expect/src/types.ts b/packages/expect/src/types.ts
@@ -52,7 +52,7 @@ export type MatcherState = {
   };
 };
 
-export type AsymmetricMatcher = Object;
+export type AsymmetricMatcher = Record<string, any>;
 export type MatchersObject = {[id: string]: RawMatcherFn};
 export type Expect = {
   (expected: any): ExpectationObject;
@@ -71,7 +71,7 @@ export type Expect = {
   any(expectedObject: any): AsymmetricMatcher;
   anything(): AsymmetricMatcher;
   arrayContaining(sample: Array<any>): AsymmetricMatcher;
-  objectContaining(sample: Object): AsymmetricMatcher;
+  objectContaining(sample: Record<string, any>): AsymmetricMatcher;
   stringContaining(expected: string): AsymmetricMatcher;
   stringMatching(expected: string | RegExp): AsymmetricMatcher;
   [id: string]: AsymmetricMatcher;

diff --git a/packages/jest-circus/src/types.ts b/packages/jest-circus/src/types.ts
@@ -23,7 +23,7 @@ export type HookFn = (done?: DoneFn) => Promise<any> | null | undefined;
 export type AsyncFn = TestFn | HookFn;
 export type SharedHookType = 'afterAll' | 'beforeAll';
 export type HookType = SharedHookType | 'afterEach' | 'beforeEach';
-export type TestContext = Object;
+export type TestContext = Record<string, any>;
 export type Exception = any; // Since in JS anything can be thrown as an error.
 export type FormattedError = string; // String representation of error.
 export type Hook = {

diff --git a/packages/jest-config/src/ReporterValidationErrors.ts b/packages/jest-config/src/ReporterValidationErrors.ts
@@ -40,7 +40,7 @@ export function createArrayReporterError(
   arrayReporter: Config.ReporterConfig,
   reporterIndex: number,
   valueIndex: number,
-  value: string | Object,
+  value: string | Record<string, any>,
   expectedType: string,
   valueName: string,
 ) {

diff --git a/packages/jest-diff/src/index.ts b/packages/jest-diff/src/index.ts
@@ -112,7 +112,11 @@ function sortSet(set: Set<unknown>) {
   return new Set(Array.from(set.values()).sort());
 }
 
-function compareObjects(a: Object, b: Object, options?: JestDiffOptions) {
+function compareObjects(
+  a: Record<string, any>,
+  b: Record<string, any>,
+  options?: JestDiffOptions,
+) {
   let diffMessage;
   let hasThrown = false;
 

diff --git a/packages/jest-environment/src/index.ts b/packages/jest-environment/src/index.ts
@@ -49,7 +49,7 @@ export interface Jest {
    *
    * @deprecated Use `expect.extend` instead
    */
-  addMatchers(matchers: Object): void;
+  addMatchers(matchers: Record<string, any>): void;
   /**
    * Disables automatic mocking in the module loader.
    */

diff --git a/packages/jest-haste-map/src/index.ts b/packages/jest-haste-map/src/index.ts
@@ -1108,7 +1108,7 @@ class DuplicateError extends Error {
   }
 }
 
-function copy<T extends Object>(object: T): T {
+function copy<T extends Record<string, any>>(object: T): T {
   return Object.assign(Object.create(null), object);
 }
 

diff --git a/packages/jest-mock/src/index.ts b/packages/jest-mock/src/index.ts
@@ -385,7 +385,7 @@ class ModuleMockerClass {
     this._invocationCallCounter = 1;
   }
 
-  private _getSlots(object?: Object): Array<string> {
+  private _getSlots(object?: Record<string, any>): Array<string> {
     if (!object) {
       return [];
     }
@@ -480,7 +480,7 @@ class ModuleMockerClass {
   private _makeComponent<T, Y extends Array<unknown>>(
     metadata: JestMock.MockFunctionMetadata<T, Y, 'object'>,
     restore?: () => void,
-  ): Object;
+  ): Record<string, any>;
   private _makeComponent<T, Y extends Array<unknown>>(
     metadata: JestMock.MockFunctionMetadata<T, Y, 'array'>,
     restore?: () => void,
@@ -504,7 +504,13 @@ class ModuleMockerClass {
   private _makeComponent<T, Y extends Array<unknown>>(
     metadata: JestMock.MockFunctionMetadata<T, Y>,
     restore?: () => void,
-  ): Object | Array<unknown> | RegExp | T | undefined | Mock<T, Y> {
+  ):
+    | Record<string, any>
+    | Array<unknown>
+    | RegExp
+    | T
+    | undefined
+    | Mock<T, Y> {
     if (metadata.type === 'object') {
       return new this._environmentGlobal.Object();
     } else if (metadata.type === 'array') {
@@ -812,7 +818,7 @@ class ModuleMockerClass {
     callbacks: Array<Function>,
     refs: {
       [key: string]:
-        | Object
+        | Record<string, any>
         | Array<unknown>
         | RegExp
         | T

diff --git a/packages/jest-runtime/src/index.ts b/packages/jest-runtime/src/index.ts
@@ -988,7 +988,7 @@ class Runtime {
     };
 
     const jestObject: Jest = {
-      addMatchers: (matchers: Object) =>
+      addMatchers: (matchers: Record<string, any>) =>
         this._environment.global.jasmine.addMatchers(matchers),
       advanceTimersByTime: (msToRun: number) =>
         _getFakeTimers().advanceTimersByTime(msToRun),

diff --git a/packages/jest-source-map/src/__tests__/getCallsite.test.ts b/packages/jest-source-map/src/__tests__/getCallsite.test.ts
@@ -41,7 +41,7 @@ describe('getCallsite', () => {
     const sourceMapLine = 2;
     // @ts-ignore
     SourceMap.SourceMapConsumer = class {
-      originalPositionFor(params: Object) {
+      originalPositionFor(params: Record<string, any>) {
         expect(params).toMatchObject({
           column: expect.any(Number),
           line: expect.any(Number),

diff --git a/packages/jest-types/src/Config.ts b/packages/jest-types/src/Config.ts
@@ -21,7 +21,7 @@ export type HasteConfig = {
 
 export type ReporterConfig = [string, {[key: string]: unknown}];
 
-export type ConfigGlobals = Object;
+export type ConfigGlobals = Record<string, any>;
 
 export type DefaultOptions = {
   automock: boolean;
@@ -80,7 +80,7 @@ export type DefaultOptions = {
   skipFilter: boolean;
   snapshotSerializers: Array<Path>;
   testEnvironment: string;
-  testEnvironmentOptions: Object;
+  testEnvironmentOptions: Record<string, any>;
   testFailureExitCode: string | number;
   testLocationInResults: boolean;
   testMatch: Array<Glob>;
@@ -186,7 +186,7 @@ export type InitialOptions = {
   snapshotSerializers?: Array<Path>;
   errorOnDeprecated?: boolean;
   testEnvironment?: string;
-  testEnvironmentOptions?: Object;
+  testEnvironmentOptions?: Record<string, any>;
   testFailureExitCode?: string | number;
   testLocationInResults?: boolean;
   testMatch?: Array<Glob>;
@@ -210,7 +210,7 @@ export type InitialOptions = {
   watch?: boolean;
   watchAll?: boolean;
   watchman?: boolean;
-  watchPlugins?: Array<string | [string, Object]>;
+  watchPlugins?: Array<string | [string, Record<string, any>]>;
 };
 
 export type SnapshotUpdateState = 'all' | 'new' | 'none';
@@ -301,7 +301,7 @@ export type GlobalConfig = {
   watchPlugins:
     | Array<{
         path: string;
-        config: Object;
+        config: Record<string, any>;
       }>
     | null
     | undefined;
@@ -349,7 +349,7 @@ export type ProjectConfig = {
   snapshotResolver: Path | null | undefined;
   snapshotSerializers: Array<Path>;
   testEnvironment: string;
-  testEnvironmentOptions: Object;
+  testEnvironmentOptions: Record<string, any>;
   testMatch: Array<Glob>;
   testLocationInResults: boolean;
   testPathIgnorePatterns: Array<string>;

diff --git a/packages/jest-types/src/TestResult.ts b/packages/jest-types/src/TestResult.ts
@@ -164,7 +164,7 @@ export type CodeCoverageReporter = any;
 export type CodeCoverageFormatter = (
   coverage: CoverageMapData | null | undefined,
   reporter: CodeCoverageReporter,
-) => Object | null | undefined;
+) => Record<string, any> | null | undefined;
 
 export type UncheckedSnapshot = {
   filePath: string;

diff --git a/packages/jest-util/src/createProcessObject.ts b/packages/jest-util/src/createProcessObject.ts
@@ -19,7 +19,7 @@ function createProcessEnv(): NodeJS.ProcessEnv {
     return deepCyclicCopy(process.env);
   }
 
-  const proto: Object = Object.getPrototypeOf(process.env);
+  const proto: Record<string, any> = Object.getPrototypeOf(process.env);
   const real = Object.create(proto);
   const lookup: typeof process.env = {};
 

diff --git a/packages/jest-worker/src/index.ts b/packages/jest-worker/src/index.ts
@@ -18,7 +18,7 @@ function getExposedMethods(
 
   // If no methods list is given, try getting it by auto-requiring the module.
   if (!exposedMethods) {
-    const module: Function | Object = require(workerPath);
+    const module: Function | Record<string, any> = require(workerPath);
 
     exposedMethods = Object.keys(module).filter(
       // @ts-ignore: no index

diff --git a/packages/pretty-format/src/collections.ts b/packages/pretty-format/src/collections.ts
@@ -8,7 +8,7 @@
 
 import {Config, Printer, Refs} from './types';
 
-const getKeysOfEnumerableProperties = (object: Object) => {
+const getKeysOfEnumerableProperties = (object: Record<string, any>) => {
   const keys: Array<string | symbol> = Object.keys(object).sort();
 
   if (Object.getOwnPropertySymbols) {
@@ -168,7 +168,7 @@ export function printListItems(
  * without surrounding punctuation (for example, braces)
  */
 export function printObjectProperties(
-  val: Object,
+  val: Record<string, any>,
   config: Config,
   indentation: string,
   depth: number,

diff --git a/packages/pretty-format/src/plugins/ReactTestComponent.ts b/packages/pretty-format/src/plugins/ReactTestComponent.ts
@@ -8,9 +8,9 @@
 import {Config, Printer, NewPlugin, Refs} from '../types';
 
 export type ReactTestObject = {
-  $$typeof: Symbol;
+  $$typeof: symbol;
   type: string;
-  props?: Object;
+  props?: Record<string, any>;
   children?: null | Array<ReactTestChild>;
 };