chore: migrate jest-resolve to TypeScript

CHANGELOG.md

@@ -31,6 +31,7 @@
 - `[jest-haste-map]`: Migrate to TypeScript ([#7854](https://github.com/facebook/jest/pull/7854))
 - `[docs]`: Fix image paths in SnapshotTesting.md for current and version 24 ([#7872](https://github.com/facebook/jest/pull/7872))
 - `[babel-jest]`: Migrate to TypeScript ([#7862](https://github.com/facebook/jest/pull/7862))
+- `[jest-resolve]`: Migrate to TypeScript ([#7871](https://github.com/facebook/jest/pull/7871))
 
 ### Performance
 

e2e/__tests__/__snapshots__/moduleNameMapper.test.js.snap

@@ -30,6 +30,6 @@ FAIL __tests__/index.js
       12 | module.exports = () => 'test';
       13 | 
 
-      at createNoMappedModuleFoundError (../../packages/jest-resolve/build/index.js:436:17)
+      at createNoMappedModuleFoundError (../../packages/jest-resolve/build/index.js:434:17)
       at Object.require (index.js:10:1)
 `;

e2e/__tests__/__snapshots__/resolveNoFileExtensions.test.js.snap

@@ -33,6 +33,6 @@ FAIL __tests__/test.js
         |                  ^
       4 | 
 
-      at Resolver.resolveModule (../../packages/jest-resolve/build/index.js:203:17)
+      at Resolver.resolveModule (../../packages/jest-resolve/build/index.js:201:17)
       at Object.require (index.js:3:18)
 `;

package.json

@@ -62,7 +62,7 @@
     "progress": "^2.0.0",
     "promise": "^8.0.2",
     "readable-stream": "^3.0.3",
-    "realpath-native": "^1.0.0",
+    "realpath-native": "^1.1.0",
     "resolve": "^1.4.0",
     "rimraf": "^2.6.2",
     "slash": "^2.0.0",

packages/jest-cli/package.json

@@ -35,7 +35,7 @@
     "p-each-series": "^1.0.0",
     "pirates": "^4.0.0",
     "prompts": "^2.0.1",
-    "realpath-native": "^1.0.0",
+    "realpath-native": "^1.1.0",
     "rimraf": "^2.5.4",
     "slash": "^2.0.0",
     "string-length": "^2.0.0",

packages/jest-config/package.json

@@ -23,7 +23,7 @@
     "jest-validate": "^24.0.0",
     "micromatch": "^3.1.10",
     "pretty-format": "^24.0.0",
-    "realpath-native": "^1.0.2"
+    "realpath-native": "^1.1.0"
   },
   "devDependencies":  {
     "@types/babel__core": "^7.0.4",

packages/jest-haste-map/src/ModuleMap.ts

@@ -41,9 +41,9 @@ export default class ModuleMap {
 
   getModule(
     name: string,
-    platform: string | null,
-    supportsNativePlatform: boolean | null,
-    type: HTypeValue | null,
+    platform?: string | null,
+    supportsNativePlatform?: boolean | null,
+    type?: HTypeValue | null,
   ): Config.Path | null {
     if (type == null) {
       type = H.MODULE;
@@ -62,7 +62,7 @@ export default class ModuleMap {
 
   getPackage(
     name: string,
-    platform: string | null,
+    platform: string | null | undefined,
     _supportsNativePlatform: boolean | null,
   ): Config.Path | null {
     return this.getModule(name, platform, null, H.PACKAGE);
@@ -111,7 +111,7 @@ export default class ModuleMap {
    */
   private _getModuleMetadata(
     name: string,
-    platform: string | null,
+    platform: string | null | undefined,
     supportsNativePlatform: boolean,
   ): ModuleMetaData | null {
     const map = this._raw.map.get(name) || EMPTY_OBJ;

packages/jest-resolve/package.json

@@ -8,15 +8,20 @@
   },
   "license": "MIT",
   "main": "build/index.js",
+  "types": "build/index.d.ts",
   "dependencies": {
+    "@jest/types": "^24.1.0",
     "browser-resolve": "^1.11.3",
     "chalk": "^2.0.1",
-    "realpath-native": "^1.0.0"
+    "realpath-native": "^1.1.0"
   },
   "devDependencies": {
     "@types/browser-resolve": "^0.0.5",
     "jest-haste-map": "^24.0.0"
   },
+  "peerDependencies": {
+    "jest-haste-map": "^24.0.0"
+  },
   "engines": {
     "node": ">= 6"
   },

packages/jest-resolve/src/__tests__/isBuiltinModule.test.js → packages/jest-resolve/src/__tests__/isBuiltinModule.test.ts

@@ -1,5 +1,4 @@
 // Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
-// @flow
 
 import isBuiltinModule from '../isBuiltinModule';
 

packages/jest-resolve/src/__tests__/resolve.test.js → packages/jest-resolve/src/__tests__/resolve.test.ts

@@ -6,16 +6,18 @@
  *
  */
 
-'use strict';
-
 import fs from 'fs';
 import path from 'path';
-import {ModuleMap} from 'jest-haste-map';
-// eslint-disable-next-line import/default
+import HasteMap from 'jest-haste-map';
 import Resolver from '../';
+// @ts-ignore: js file
 import userResolver from '../__mocks__/userResolver';
 import nodeModulesPaths from '../nodeModulesPaths';
 import defaultResolver from '../defaultResolver';
+import {ResolverConfig} from '../types';
+
+// @ts-ignore: types are wrong. not sure how...
+const {ModuleMap} = HasteMap;
 
 jest.mock('../__mocks__/userResolver');
 
@@ -28,21 +30,21 @@ describe('isCoreModule', () => {
     const moduleMap = ModuleMap.create('/');
     const resolver = new Resolver(moduleMap, {
       hasCoreModules: false,
-    });
+    } as ResolverConfig);
     const isCore = resolver.isCoreModule('assert');
     expect(isCore).toEqual(false);
   });
 
   it('returns true if `hasCoreModules` is true and `moduleName` is a core module.', () => {
     const moduleMap = ModuleMap.create('/');
-    const resolver = new Resolver(moduleMap, {});
+    const resolver = new Resolver(moduleMap, {} as ResolverConfig);
     const isCore = resolver.isCoreModule('assert');
     expect(isCore).toEqual(true);
   });
 
   it('returns false if `hasCoreModules` is true and `moduleName` is not a core module.', () => {
     const moduleMap = ModuleMap.create('/');
-    const resolver = new Resolver(moduleMap, {});
+    const resolver = new Resolver(moduleMap, {} as ResolverConfig);
     const isCore = resolver.isCoreModule('not-a-core-module');
     expect(isCore).toEqual(false);
   });
@@ -84,15 +86,15 @@ describe('findNodeModule', () => {
 });
 
 describe('resolveModule', () => {
-  let moduleMap;
+  let moduleMap: typeof ModuleMap;
   beforeEach(() => {
     moduleMap = ModuleMap.create('/');
   });
 
   it('is possible to resolve node modules', () => {
     const resolver = new Resolver(moduleMap, {
       extensions: ['.js'],
-    });
+    } as ResolverConfig);
     const src = require.resolve('../');
     const resolved = resolver.resolveModule(
       src,
@@ -104,7 +106,7 @@ describe('resolveModule', () => {
   it('is possible to resolve node modules with custom extensions', () => {
     const resolver = new Resolver(moduleMap, {
       extensions: ['.js', '.jsx'],
-    });
+    } as ResolverConfig);
     const src = require.resolve('../');
     const resolvedJsx = resolver.resolveModule(
       src,
@@ -119,7 +121,7 @@ describe('resolveModule', () => {
     const resolver = new Resolver(moduleMap, {
       extensions: ['.js', '.jsx'],
       platforms: ['native'],
-    });
+    } as ResolverConfig);
     const src = require.resolve('../');
     const resolvedJsx = resolver.resolveModule(
       src,
@@ -133,7 +135,7 @@ describe('resolveModule', () => {
   it('is possible to resolve node modules by resolving their realpath', () => {
     const resolver = new Resolver(moduleMap, {
       extensions: ['.js'],
-    });
+    } as ResolverConfig);
     const src = path.join(
       path.resolve(__dirname, '../../src/__mocks__/bar/node_modules/'),
       'foo/index.js',
@@ -147,7 +149,7 @@ describe('resolveModule', () => {
   it('is possible to specify custom resolve paths', () => {
     const resolver = new Resolver(moduleMap, {
       extensions: ['.js'],
-    });
+    } as ResolverConfig);
     const src = require.resolve('../');
     const resolved = resolver.resolveModule(src, 'mockJsDependency', {
       paths: [
@@ -173,7 +175,7 @@ describe('getMockModule', () => {
         },
       ],
       resolver: require.resolve('../__mocks__/userResolver'),
-    });
+    } as ResolverConfig);
     const src = require.resolve('../');
     resolver.getMockModule(src, 'dependentModule');
 
@@ -196,7 +198,7 @@ describe('nodeModulesPaths', () => {
 
 describe('Resolver.getModulePaths() -> nodeModulesPaths()', () => {
   const _path = path;
-  let moduleMap;
+  let moduleMap: typeof ModuleMap;
 
   beforeEach(() => {
     jest.resetModules();
@@ -208,7 +210,7 @@ describe('Resolver.getModulePaths() -> nodeModulesPaths()', () => {
     // This test suite won't work otherwise, since we cannot make assumptions
     // about the test environment when it comes to absolute paths.
     jest.doMock('realpath-native', () => ({
-      sync: dirInput => dirInput,
+      sync: (dirInput: string) => dirInput,
     }));
   });
 

packages/jest-resolve/src/defaultResolver.js → packages/jest-resolve/src/defaultResolver.ts

@@ -3,33 +3,29 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow
  */
 
-import type {Path} from 'types/Config';
-import type {ErrorWithCode} from 'types/Errors';
-
-import browserResolve from 'browser-resolve';
 import fs from 'fs';
 import path from 'path';
+import browserResolve from 'browser-resolve';
+import {Config} from '@jest/types';
 import isBuiltinModule from './isBuiltinModule';
 import nodeModulesPaths from './nodeModulesPaths';
 
-type ResolverOptions = {|
-  basedir: Path,
-  browser?: boolean,
-  defaultResolver: typeof defaultResolver,
-  extensions?: Array<string>,
-  moduleDirectory?: Array<string>,
-  paths?: ?Array<Path>,
-  rootDir: ?Path,
-|};
+type ResolverOptions = {
+  basedir: Config.Path;
+  browser?: boolean;
+  defaultResolver: typeof defaultResolver;
+  extensions?: Array<string>;
+  moduleDirectory?: Array<string>;
+  paths?: Array<Config.Path>;
+  rootDir?: Config.Path;
+};
 
 export default function defaultResolver(
-  path: Path,
+  path: Config.Path,
   options: ResolverOptions,
-): Path {
+): Config.Path {
   const resolve = options.browser ? browserResolve.sync : resolveSync;
 
   return resolve(path, {
@@ -44,7 +40,10 @@ export default function defaultResolver(
 
 const REGEX_RELATIVE_IMPORT = /^(?:\.\.?(?:\/|$)|\/|([A-Za-z]:)?[\\\/])/;
 
-function resolveSync(target: Path, options: ResolverOptions): Path {
+function resolveSync(
+  target: Config.Path,
+  options: ResolverOptions,
+): Config.Path {
   const basedir = options.basedir;
   const extensions = options.extensions || ['.js'];
   const paths = options.paths || [];
@@ -75,7 +74,7 @@ function resolveSync(target: Path, options: ResolverOptions): Path {
     return target;
   }
 
-  const err: ErrorWithCode = new Error(
+  const err: Error & {code?: string} = new Error(
     "Cannot find module '" + target + "' from '" + basedir + "'",
   );
   err.code = 'MODULE_NOT_FOUND';
@@ -84,7 +83,7 @@ function resolveSync(target: Path, options: ResolverOptions): Path {
   /*
    * contextual helper functions
    */
-  function tryResolve(name: Path): ?Path {
+  function tryResolve(name: Config.Path): Config.Path | undefined {
     const dir = path.dirname(name);
     let result;
     if (isDirectory(dir)) {
@@ -98,7 +97,7 @@ function resolveSync(target: Path, options: ResolverOptions): Path {
     return result;
   }
 
-  function resolveAsFile(name: Path): ?Path {
+  function resolveAsFile(name: Config.Path): Config.Path | undefined {
     if (isFile(name)) {
       return name;
     }
@@ -113,7 +112,7 @@ function resolveSync(target: Path, options: ResolverOptions): Path {
     return undefined;
   }
 
-  function resolveAsDirectory(name: Path): ?Path {
+  function resolveAsDirectory(name: Config.Path): Config.Path | undefined {
     if (!isDirectory(name)) {
       return undefined;
     }
@@ -140,7 +139,7 @@ function resolveSync(target: Path, options: ResolverOptions): Path {
 /*
  * helper functions
  */
-function isFile(file: Path): boolean {
+function isFile(file: Config.Path): boolean {
   let result;
 
   try {
@@ -156,7 +155,7 @@ function isFile(file: Path): boolean {
   return result;
 }
 
-function isDirectory(dir: Path): boolean {
+function isDirectory(dir: Config.Path): boolean {
   let result;
 
   try {
@@ -172,6 +171,6 @@ function isDirectory(dir: Path): boolean {
   return result;
 }
 
-function isCurrentDirectory(testPath: Path): boolean {
+function isCurrentDirectory(testPath: Config.Path): boolean {
   return path.resolve('.') === path.resolve(testPath);
 }