chore: migrate jest-haste-map to TypeScript

jestjs · Feb 11, 2019 · 05a34ec · 05a34ec
1 parent b49075e
commit 05a34ec
Show file tree

Hide file tree

Showing 27 changed files with 345 additions and 298 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -25,6 +25,7 @@
 - `[jest-watcher]`: Migrate to TypeScript ([#7843](https://github.com/facebook/jest/pull/7843))
 - `[jest-mock]`: Migrate to TypeScript ([#7847](https://github.com/facebook/jest/pull/7847), [#7850](https://github.com/facebook/jest/pull/7850))
 - `[jest-worker]`: Migrate to TypeScript ([#7853](https://github.com/facebook/jest/pull/7853))
+- `[jest-haste-map]`: Migrate to TypeScript ([#7854](https://github.com/facebook/jest/pull/7854))
 
 ### Performance
 

diff --git a/packages/jest-cli/src/TestSequencer.js b/packages/jest-cli/src/TestSequencer.js
@@ -12,7 +12,6 @@ import type {Context} from 'types/Context';
 import type {Test} from 'types/TestRunner';
 
 import fs from 'fs';
-// $FlowFixMe: Missing ESM export
 import {getCacheFilePath} from 'jest-haste-map';
 
 const FAIL = 0;

diff --git a/packages/jest-haste-map/package.json b/packages/jest-haste-map/package.json
@@ -8,7 +8,9 @@
   },
   "license": "MIT",
   "main": "build/index.js",
+  "types": "build/index.d.ts",
   "dependencies": {
+    "@jest/types": "^24.1.0",
     "fb-watchman": "^2.0.0",
     "graceful-fs": "^4.1.15",
     "invariant": "^2.2.4",
@@ -23,6 +25,7 @@
     "@types/graceful-fs": "^4.1.2",
     "@types/invariant": "^2.2.29",
     "@types/micromatch": "^3.1.0",
+    "@types/node": "^10.12.24",
     "@types/sane": "^2.0.0"
   },
   "engines": {

diff --git a/packages/jest-haste-map/src/HasteFS.js → packages/jest-haste-map/src/HasteFS.ts b/packages/jest-haste-map/src/HasteFS.js → packages/jest-haste-map/src/HasteFS.ts
@@ -3,66 +3,63 @@
  *
  * 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 {Glob, Path} from 'types/Config';
-import type {FileData} from 'types/HasteMap';
-
+import micromatch from 'micromatch';
 import {replacePathSepForGlob} from 'jest-util';
+import {Config} from '@jest/types';
+import {FileData} from './types';
 import * as fastPath from './lib/fast_path';
-import micromatch from 'micromatch';
 import H from './constants';
 
 export default class HasteFS {
-  _rootDir: Path;
-  _files: FileData;
+  private readonly _rootDir: Config.Path;
+  private readonly _files: FileData;
 
-  constructor({rootDir, files}: {rootDir: Path, files: FileData}) {
+  constructor({rootDir, files}: {rootDir: Config.Path; files: FileData}) {
     this._rootDir = rootDir;
     this._files = files;
   }
 
-  getModuleName(file: Path): ?string {
+  getModuleName(file: Config.Path): string | null {
     const fileMetadata = this._getFileData(file);
     return (fileMetadata && fileMetadata[H.ID]) || null;
   }
 
-  getSize(file: Path): ?number {
+  getSize(file: Config.Path): number | null {
     const fileMetadata = this._getFileData(file);
     return (fileMetadata && fileMetadata[H.SIZE]) || null;
   }
 
-  getDependencies(file: Path): ?Array<string> {
+  getDependencies(file: Config.Path): Array<string> | null {
     const fileMetadata = this._getFileData(file);
     return (fileMetadata && fileMetadata[H.DEPENDENCIES]) || null;
   }
 
-  getSha1(file: Path): ?string {
+  getSha1(file: Config.Path): string | null {
     const fileMetadata = this._getFileData(file);
     return (fileMetadata && fileMetadata[H.SHA1]) || null;
   }
 
-  exists(file: Path): boolean {
+  exists(file: Config.Path): boolean {
     return this._getFileData(file) != null;
   }
 
-  getAllFiles(): Array<string> {
+  getAllFiles(): Array<Config.Path> {
     return Array.from(this.getAbsoluteFileIterator());
   }
 
-  getFileIterator(): Iterator<string> {
+  getFileIterator(): Iterable<Config.Path> {
     return this._files.keys();
   }
 
-  *getAbsoluteFileIterator(): Iterator<string> {
-    for (const file of this._files.keys()) {
+  *getAbsoluteFileIterator(): Iterable<Config.Path> {
+    for (const file of this.getFileIterator()) {
       yield fastPath.resolve(this._rootDir, file);
     }
   }
 
-  matchFiles(pattern: RegExp | string): Array<Path> {
+  matchFiles(pattern: RegExp | string): Array<Config.Path> {
     if (!(pattern instanceof RegExp)) {
       pattern = new RegExp(pattern);
     }
@@ -75,7 +72,10 @@ export default class HasteFS {
     return files;
   }
 
-  matchFilesWithGlob(globs: Array<Glob>, root: ?Path): Set<Path> {
+  matchFilesWithGlob(
+    globs: Array<Config.Glob>,
+    root: Config.Path | null,
+  ): Set<Config.Path> {
     const files = new Set();
     for (const file of this.getAbsoluteFileIterator()) {
       const filePath = root ? fastPath.relative(root, file) : file;
@@ -86,7 +86,7 @@ export default class HasteFS {
     return files;
   }
 
-  _getFileData(file: Path) {
+  private _getFileData(file: Config.Path) {
     const relativePath = fastPath.relative(this._rootDir, file);
     return this._files.get(relativePath);
   }

diff --git a/packages/jest-haste-map/src/ModuleMap.js → packages/jest-haste-map/src/ModuleMap.ts b/packages/jest-haste-map/src/ModuleMap.js → packages/jest-haste-map/src/ModuleMap.ts
@@ -3,52 +3,49 @@
  *
  * 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 {
+import {Config} from '@jest/types';
+import {
   DuplicatesSet,
   HTypeValue,
   ModuleMetaData,
   RawModuleMap,
   ModuleMapData,
   DuplicatesIndex,
   MockData,
-} from 'types/HasteMap';
+} from './types';
 
 import * as fastPath from './lib/fast_path';
 import H from './constants';
 
-const EMPTY_OBJ = {};
+const EMPTY_OBJ = {} as {[key: string]: any};
 const EMPTY_MAP = new Map();
 
-export opaque type SerializableModuleMap = {
+type ValueType<T> = T extends Map<T, infer V> ? V : T;
+
+export type SerializableModuleMap = {
   // There is no easier way to extract the type of the entries of a Map
-  duplicates: $Call<
-    typeof Array.from,
-    $Call<$PropertyType<DuplicatesIndex, 'entries'>>,
-  >,
-  map: $Call<typeof Array.from, $Call<$PropertyType<ModuleMapData, 'entries'>>>,
-  mocks: $Call<typeof Array.from, $Call<$PropertyType<MockData, 'entries'>>>,
-  rootDir: string,
+  duplicates: [string, ValueType<DuplicatesIndex>];
+  map: [string, ValueType<ModuleMapData>];
+  mocks: [string, ValueType<MockData>];
+  rootDir: Config.Path;
 };
 
 export default class ModuleMap {
-  _raw: RawModuleMap;
-  static DuplicateHasteCandidatesError: Class<DuplicateHasteCandidatesError>;
+  private readonly _raw: RawModuleMap;
+  static DuplicateHasteCandidatesError: DuplicateHasteCandidatesError;
 
   constructor(raw: RawModuleMap) {
     this._raw = raw;
   }
 
   getModule(
     name: string,
-    platform: ?string,
-    supportsNativePlatform: ?boolean,
-    type: ?HTypeValue,
-  ): ?Path {
+    platform: string | null,
+    supportsNativePlatform: boolean | null,
+    type: HTypeValue | null,
+  ): string | null {
     if (!type) {
       type = H.MODULE;
     }
@@ -66,13 +63,13 @@ export default class ModuleMap {
 
   getPackage(
     name: string,
-    platform: ?string,
-    supportsNativePlatform: ?boolean,
-  ): ?Path {
+    platform: string | null,
+    _: boolean | null,
+  ): string | null {
     return this.getModule(name, platform, null, H.PACKAGE);
   }
 
-  getMockModule(name: string): ?Path {
+  getMockModule(name: string): string | undefined {
     const mockPath =
       this._raw.mocks.get(name) || this._raw.mocks.get(name + '/index');
     return mockPath && fastPath.resolve(this._raw.rootDir, mockPath);
@@ -113,11 +110,11 @@ export default class ModuleMap {
    * extra sure. If metadata exists both in the `duplicates` object and the
    * `map`, this would be a bug.
    */
-  _getModuleMetadata(
+  private _getModuleMetadata(
     name: string,
-    platform: ?string,
+    platform: string | null,
     supportsNativePlatform: boolean,
-  ): ?ModuleMetaData {
+  ): ModuleMetaData | null {
     const map = this._raw.map.get(name) || EMPTY_OBJ;
     const dupMap = this._raw.duplicates.get(name) || EMPTY_MAP;
     if (platform != null) {
@@ -154,11 +151,11 @@ export default class ModuleMap {
     return null;
   }
 
-  _assertNoDuplicates(
+  private _assertNoDuplicates(
     name: string,
     platform: string,
     supportsNativePlatform: boolean,
-    relativePathSet: ?DuplicatesSet,
+    relativePathSet: DuplicatesSet | null,
   ) {
     if (relativePathSet == null) {
       return;
@@ -180,7 +177,7 @@ export default class ModuleMap {
     );
   }
 
-  static create(rootDir: Path) {
+  static create(rootDir: string) {
     return new ModuleMap({
       duplicates: new Map(),
       map: new Map(),
@@ -190,9 +187,9 @@ export default class ModuleMap {
   }
 }
 
-class DuplicateHasteCandidatesError extends Error {
+export class DuplicateHasteCandidatesError extends Error {
   hasteName: string;
-  platform: ?string;
+  platform: string | null;
   supportsNativePlatform: boolean;
   duplicatesSet: DuplicatesSet;
 

diff --git a/packages/jest-haste-map/src/__tests__/index.test.js b/packages/jest-haste-map/src/__tests__/index.test.js
@@ -6,10 +6,8 @@
  *
  */
 
-'use strict';
-
+import crypto from 'crypto';
 import {skipSuiteOnWindows} from '../../../../scripts/ConditionalTest';
-const crypto = require('crypto');
 
 function mockHashContents(contents) {
   return crypto
@@ -75,7 +73,7 @@ jest.mock('sane', () => ({
   WatchmanWatcher: mockWatcherConstructor,
 }));
 
-jest.mock('../lib/WatchmanWatcher.js', () => mockWatcherConstructor);
+jest.mock('../lib/WatchmanWatcher', () => mockWatcherConstructor);
 
 let mockChangedFiles;
 let mockFs;

diff --git a/packages/jest-haste-map/src/blacklist.js → packages/jest-haste-map/src/blacklist.ts b/packages/jest-haste-map/src/blacklist.js → packages/jest-haste-map/src/blacklist.ts
@@ -3,8 +3,6 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow
  */
 
 // This list is compiled after the MDN list of the most common MIME types (see

diff --git a/packages/jest-haste-map/src/constants.js → packages/jest-haste-map/src/constants.ts b/packages/jest-haste-map/src/constants.js → packages/jest-haste-map/src/constants.ts
@@ -3,8 +3,6 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow
  */
 /* eslint-disable sort-keys */
 
@@ -16,7 +14,10 @@
  * This constant key map allows to keep the map smaller without having to build
  * a custom serialization library.
  */
-export default {
+
+import {HType} from './types';
+
+const constants: HType = {
   /* file map attributes */
   ID: 0,
   MTIME: 1,
@@ -37,3 +38,5 @@ export default {
   GENERIC_PLATFORM: 'g',
   NATIVE_PLATFORM: 'native',
 };
+
+export default constants;