chore: type all exported functions (#9548)

jestjs · Feb 10, 2020 · dd64176 · dd64176
1 parent 327b26b
commit dd64176
Show file tree

Hide file tree

Showing 11 changed files with 59 additions and 50 deletions.
diff --git a/packages/jest-circus/src/legacy-code-todo-rewrite/jestAdapter.ts b/packages/jest-circus/src/legacy-code-todo-rewrite/jestAdapter.ts
@@ -27,7 +27,9 @@ const jestAdapter = async (
   } = runtime.requireInternalModule(FRAMEWORK_INITIALIZER);
 
   runtime
-    .requireInternalModule(path.resolve(__dirname, './jestExpect.js'))
+    .requireInternalModule<typeof import('./jestExpect')>(
+      path.resolve(__dirname, './jestExpect.js'),
+    )
     .default({
       expand: globalConfig.expand,
     });

diff --git a/packages/jest-environment-jsdom/src/index.ts b/packages/jest-environment-jsdom/src/index.ts
@@ -99,9 +99,9 @@ class JSDOMEnvironment implements JestEnvironment {
     this.fakeTimersLolex = new LolexFakeTimers({config, global});
   }
 
-  async setup() {}
+  async setup(): Promise<void> {}
 
-  async teardown() {
+  async teardown(): Promise<void> {
     if (this.fakeTimers) {
       this.fakeTimers.dispose();
     }
@@ -124,7 +124,7 @@ class JSDOMEnvironment implements JestEnvironment {
     this.fakeTimersLolex = null;
   }
 
-  runScript(script: Script) {
+  runScript<T = unknown>(script: Script): T | null {
     if (this.dom) {
       return this.dom.runVMScript(script) as any;
     }

diff --git a/packages/jest-environment-node/src/index.ts b/packages/jest-environment-node/src/index.ts
@@ -93,9 +93,9 @@ class NodeEnvironment implements JestEnvironment {
     this.fakeTimersLolex = new LolexFakeTimers({config, global});
   }
 
-  async setup() {}
+  async setup(): Promise<void> {}
 
-  async teardown() {
+  async teardown(): Promise<void> {
     if (this.fakeTimers) {
       this.fakeTimers.dispose();
     }
@@ -109,14 +109,14 @@ class NodeEnvironment implements JestEnvironment {
 
   // TS infers the return type to be `any`, since that's what `runInContext`
   // returns.
-  runScript(script: Script) {
+  runScript<T = unknown>(script: Script): T | null {
     if (this.context) {
       return script.runInContext(this.context);
     }
     return null;
   }
 
-  getVmContext() {
+  getVmContext(): Context | null {
     return this.context;
   }
 }

diff --git a/packages/jest-haste-map/src/lib/FSEventsWatcher.ts b/packages/jest-haste-map/src/lib/FSEventsWatcher.ts
@@ -47,14 +47,14 @@ class FSEventsWatcher extends EventEmitter {
   public readonly fsEventsWatchStopper: () => Promise<void>;
   private _tracked: Set<string>;
 
-  static isSupported() {
+  static isSupported(): boolean {
     return fsevents !== null;
   }
 
   private static normalizeProxy(
     callback: (normalizedPath: string, stats: fs.Stats) => void,
   ) {
-    return (filepath: string, stats: fs.Stats) =>
+    return (filepath: string, stats: fs.Stats): void =>
       callback(path.normalize(filepath), stats);
   }
 
@@ -127,7 +127,7 @@ class FSEventsWatcher extends EventEmitter {
   /**
    * End watching.
    */
-  close(callback?: () => void) {
+  close(callback?: () => void): void {
     this.fsEventsWatchStopper().then(() => {
       this.removeAllListeners();
       if (typeof callback === 'function') {

diff --git a/packages/jest-jasmine2/src/index.ts b/packages/jest-jasmine2/src/index.ts
@@ -30,7 +30,9 @@ async function jasmine2(
   testPath: string,
 ): Promise<TestResult> {
   const reporter = new JasmineReporter(globalConfig, config, testPath);
-  const jasmineFactory = runtime.requireInternalModule(JASMINE);
+  const jasmineFactory = runtime.requireInternalModule<
+    typeof import('./jasmine/jasmineLight')
+  >(JASMINE);
   const jasmine = jasmineFactory.create({
     process,
     testPath,
@@ -120,7 +122,9 @@ async function jasmine2(
   env.addReporter(reporter);
 
   runtime
-    .requireInternalModule(path.resolve(__dirname, './jestExpect.js'))
+    .requireInternalModule<typeof import('./jestExpect')>(
+      path.resolve(__dirname, './jestExpect.js'),
+    )
     .default({
       expand: globalConfig.expand,
     });
@@ -141,7 +145,9 @@ async function jasmine2(
   }
 
   const snapshotState: SnapshotStateType = runtime
-    .requireInternalModule(path.resolve(__dirname, './setup_jest_globals.js'))
+    .requireInternalModule<typeof import('./setup_jest_globals')>(
+      path.resolve(__dirname, './setup_jest_globals.js'),
+    )
     .default({
       config,
       globalConfig,
@@ -158,7 +164,7 @@ async function jasmine2(
       const suiteMap =
         globalConfig.enabledTestsMap &&
         globalConfig.enabledTestsMap[spec.result.testPath];
-      return suiteMap && suiteMap[spec.result.fullName];
+      return (suiteMap && suiteMap[spec.result.fullName]) || false;
     };
   } else if (globalConfig.testNamePattern) {
     const testNameRegex = new RegExp(globalConfig.testNamePattern, 'i');

diff --git a/packages/jest-jasmine2/src/jasmine/Env.ts b/packages/jest-jasmine2/src/jasmine/Env.ts
@@ -61,7 +61,7 @@ export default function(j$: Jasmine) {
     randomTests: () => boolean;
     seed: (value: unknown) => unknown;
     execute: (
-      runnablesToRun: Array<string>,
+      runnablesToRun?: Array<string>,
       suiteTree?: Suite,
     ) => Promise<void>;
     fdescribe: (description: string, specDefinitions: Function) => Suite;

diff --git a/packages/jest-repl/src/cli/index.ts b/packages/jest-repl/src/cli/index.ts
@@ -18,7 +18,7 @@ const {version: VERSION} = require('../../package.json');
 
 const REPL_SCRIPT = require.resolve('./repl.js');
 
-export = function() {
+export = function(): void {
   const argv = <Config.Argv>yargs.usage(args.usage).options(args.options).argv;
 
   // @ts-ignore: fix this at some point

diff --git a/packages/jest-resolve/src/index.ts b/packages/jest-resolve/src/index.ts
@@ -82,7 +82,7 @@ class Resolver {
 
   static ModuleNotFoundError = ModuleNotFoundError;
 
-  static clearDefaultResolverCache() {
+  static clearDefaultResolverCache(): void {
     clearDefaultResolverCache();
   }
 
@@ -230,7 +230,7 @@ class Resolver {
     );
   }
 
-  getModulePath(from: Config.Path, moduleName: string) {
+  getModulePath(from: Config.Path, moduleName: string): Config.Path {
     if (moduleName[0] !== '.' || path.isAbsolute(moduleName)) {
       return moduleName;
     }

diff --git a/packages/jest-runner/src/runTest.ts b/packages/jest-runner/src/runTest.ts
@@ -184,7 +184,7 @@ async function runTestInternal(
 
   // For tests
   runtime
-    .requireInternalModule(
+    .requireInternalModule<typeof import('source-map-support')>(
       require.resolve('source-map-support'),
       'source-map-support',
     )

diff --git a/packages/jest-runtime/src/index.ts b/packages/jest-runtime/src/index.ts
@@ -281,20 +281,20 @@ class Runtime {
     });
   }
 
-  static runCLI(args?: Config.Argv, info?: Array<string>) {
+  static runCLI(args?: Config.Argv, info?: Array<string>): Promise<void> {
     return cliRun(args, info);
   }
 
   static getCLIOptions(): typeof cliOptions {
     return cliOptions;
   }
 
-  requireModule(
+  requireModule<T = unknown>(
     from: Config.Path,
     moduleName?: string,
     options?: InternalModuleOptions,
     isRequireActual?: boolean | null,
-  ) {
+  ): T {
     const moduleID = this._resolver.getModuleID(
       this._virtualMocks,
       from,
@@ -370,15 +370,15 @@ class Runtime {
     return localModule.exports;
   }
 
-  requireInternalModule(from: Config.Path, to?: string) {
+  requireInternalModule<T = unknown>(from: Config.Path, to?: string): T {
     return this.requireModule(from, to, {isInternalModule: true});
   }
 
-  requireActual(from: Config.Path, moduleName: string) {
+  requireActual<T = unknown>(from: Config.Path, moduleName: string): T {
     return this.requireModule(from, moduleName, undefined, true);
   }
 
-  requireMock(from: Config.Path, moduleName: string) {
+  requireMock<T = unknown>(from: Config.Path, moduleName: string): T {
     const moduleID = this._resolver.getModuleID(
       this._virtualMocks,
       from,
@@ -399,7 +399,7 @@ class Runtime {
     if (moduleID in this._mockFactories) {
       const module = this._mockFactories[moduleID]();
       mockRegistry.set(moduleID, module);
-      return module;
+      return module as T;
     }
 
     const manualMockOrStub = this._resolver.getMockModule(from, moduleName);
@@ -508,7 +508,7 @@ class Runtime {
     };
   }
 
-  requireModuleOrMock(from: Config.Path, moduleName: string) {
+  requireModuleOrMock(from: Config.Path, moduleName: string): unknown {
     try {
       if (this._shouldMock(from, moduleName)) {
         return this.requireMock(from, moduleName);
@@ -531,7 +531,7 @@ class Runtime {
     }
   }
 
-  isolateModules(fn: () => void) {
+  isolateModules(fn: () => void): void {
     if (this._isolatedModuleRegistry || this._isolatedMockRegistry) {
       throw new Error(
         'isolateModules cannot be nested inside another isolateModules.',
@@ -547,7 +547,7 @@ class Runtime {
     }
   }
 
-  resetModules() {
+  resetModules(): void {
     this._isolatedModuleRegistry = null;
     this._isolatedMockRegistry = null;
     this._mockRegistry.clear();
@@ -574,13 +574,13 @@ class Runtime {
     }
   }
 
-  async collectV8Coverage() {
+  async collectV8Coverage(): Promise<void> {
     this._v8CoverageInstrumenter = new CoverageInstrumenter();
 
     await this._v8CoverageInstrumenter.startInstrumenting();
   }
 
-  async stopCollectingV8Coverage() {
+  async stopCollectingV8Coverage(): Promise<void> {
     if (!this._v8CoverageInstrumenter) {
       throw new Error('You need to call `collectV8Coverage` first.');
     }
@@ -616,19 +616,20 @@ class Runtime {
       });
   }
 
-  getSourceMapInfo(coveredFiles: Set<string>) {
-    return Object.keys(this._sourceMapRegistry).reduce<{
-      [path: string]: string;
-    }>((result, sourcePath) => {
-      if (
-        coveredFiles.has(sourcePath) &&
-        this._needsCoverageMapped.has(sourcePath) &&
-        fs.existsSync(this._sourceMapRegistry[sourcePath])
-      ) {
-        result[sourcePath] = this._sourceMapRegistry[sourcePath];
-      }
-      return result;
-    }, {});
+  getSourceMapInfo(coveredFiles: Set<string>): Record<string, string> {
+    return Object.keys(this._sourceMapRegistry).reduce<Record<string, string>>(
+      (result, sourcePath) => {
+        if (
+          coveredFiles.has(sourcePath) &&
+          this._needsCoverageMapped.has(sourcePath) &&
+          fs.existsSync(this._sourceMapRegistry[sourcePath])
+        ) {
+          result[sourcePath] = this._sourceMapRegistry[sourcePath];
+        }
+        return result;
+      },
+      {},
+    );
   }
 
   getSourceMaps(): SourceMapRegistry {
@@ -640,7 +641,7 @@ class Runtime {
     moduleName: string,
     mockFactory: () => unknown,
     options?: {virtual?: boolean},
-  ) {
+  ): void {
     if (options && options.virtual) {
       const mockPath = this._resolver.getModulePath(from, moduleName);
       this._virtualMocks[mockPath] = true;
@@ -654,15 +655,15 @@ class Runtime {
     this._mockFactories[moduleID] = mockFactory;
   }
 
-  restoreAllMocks() {
+  restoreAllMocks(): void {
     this._moduleMocker.restoreAllMocks();
   }
 
-  resetAllMocks() {
+  resetAllMocks(): void {
     this._moduleMocker.resetAllMocks();
   }
 
-  clearAllMocks() {
+  clearAllMocks(): void {
     this._moduleMocker.clearAllMocks();
   }
 

diff --git a/packages/pretty-format/src/index.ts b/packages/pretty-format/src/index.ts
@@ -491,7 +491,7 @@ function createIndent(indent: number): string {
  * @param options Custom settings
  */
 function prettyFormat(
-  val: any,
+  val: unknown,
   options?: PrettyFormat.OptionsReceived,
 ): string {
   if (options) {