chore(types): auto-generate types for metro-file-map (#1611)

Summary:
As I began working to hand-fix some types, the formidable robhogan [pointed me](#1608 (comment)) in the direction of `generateTypeScriptDefinitions.js`, which has been used here to generate types for `metro-file-map`

Changelog:
[Fix]: Auto generate types for `metro-file-map`

Pull Request resolved: #1611

Test Plan: Automatically tested in CI, also peformed a good-ol eyeball check.

Reviewed By: vzaidman

Differential Revision: D90583383

Pulled By: robhogan

fbshipit-source-id: 626c8fc63407b6d9aa7cb18993ad1096455bd202

Author: nickhudkins

.eslintrc.js

@@ -60,5 +60,14 @@ module.exports = {
         'import/no-commonjs': 'off',
       },
     },
+    {
+      files: [
+        // Uses FileMapPlugin<any,any> as input type
+        'packages/metro-file-map/types/index.d.ts',
+      ],
+      rules: {
+        '@typescript-eslint/no-explicit-any': 'off',
+      },
+    },
   ],
 };

packages/metro-file-map/src/Watcher.js

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @format
  * @flow strict-local
+ * @format
  */
 
 import type {
@@ -51,7 +51,7 @@ type WatcherOptions = {
   extensions: ReadonlyArray<string>,
   forceNodeFilesystemAPI: boolean,
   healthCheckFilePrefix: string,
-  ignoreForCrawl: string => boolean,
+  ignoreForCrawl: (filePath: string) => boolean,
   ignorePatternForWatch: RegExp,
   previousState: CrawlerOptions['previousState'],
   perfLogger: ?PerfLogger,

packages/metro-file-map/src/__tests__/index-test.js

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @format
  * @flow
+ * @format
  * @oncall react_native
  */
 

packages/metro-file-map/src/cache/DiskCacheManager.js

@@ -150,7 +150,7 @@ export class DiskCacheManager implements CacheManager {
     }
   }
 
-  async end() {
+  async end(): Promise<void> {
     // Clear any timers
     if (this.#debounceTimeout) {
       clearTimeout(this.#debounceTimeout);

packages/metro-file-map/src/crawlers/watchman/planQuery.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ */
+
+type WatchmanQuery = {[key: string]: unknown};
+type WatchmanQuerySince = unknown;
+
+export declare function planQuery(
+  args: Readonly<{
+    since: WatchmanQuerySince;
+    directoryFilters: ReadonlyArray<string>;
+    extensions: ReadonlyArray<string>;
+    includeSha1: boolean;
+    includeSymlinks: boolean;
+  }>,
+): {
+  query: WatchmanQuery;
+  queryGenerator: string;
+};

packages/metro-file-map/src/flow-types.js

@@ -40,7 +40,7 @@ export type BuildResult = {
 export type CacheData = Readonly<{
   clocks: WatchmanClocks,
   fileSystemData: unknown,
-  plugins: ReadonlyMap<string, V8Serializable>,
+  plugins: ReadonlyMap<string, void | V8Serializable>,
 }>;
 
 export interface CacheManager {
@@ -85,7 +85,7 @@ export type CacheManagerFactoryOptions = Readonly<{
 export type CacheManagerWriteOptions = Readonly<{
   changedSinceCacheRead: boolean,
   eventSource: CacheManagerEventSource,
-  onWriteError: Error => void,
+  onWriteError: (error: Error) => void,
 }>;
 
 // A path that is
@@ -206,11 +206,11 @@ export type V8Serializable =
   | ReadonlyArray<V8Serializable>
   | ReadonlySet<V8Serializable>
   | ReadonlyMap<string, V8Serializable>
-  | {[key: string]: V8Serializable};
+  | Readonly<{[key: string]: V8Serializable}>;
 
 export interface FileMapPlugin<
-  SerializableState = V8Serializable,
-  PerFileData = void,
+  SerializableState: void | V8Serializable = void | V8Serializable,
+  PerFileData: void | V8Serializable = void | V8Serializable,
 > {
   +name: string;
   initialize(
@@ -427,7 +427,9 @@ export type HasteMapData = Map<string, HasteMapItem>;
 
 export type HasteMapItem = {
   [platform: string]: HasteMapItemMetadata,
+  /*:: // Hide from TypeScript
   __proto__: null,
+  */
 };
 export type HasteMapItemMetadata = [/* path */ string, /* type */ number];
 
@@ -465,8 +467,8 @@ export type ReadOnlyRawMockMap = Readonly<{
 
 export interface WatcherBackend {
   getPauseReason(): ?string;
-  onError((error: Error) => void): () => void;
-  onFileEvent((event: WatcherBackendChangeEvent) => void): () => void;
+  onError(listener: (error: Error) => void): () => void;
+  onFileEvent(listener: (event: WatcherBackendChangeEvent) => void): () => void;
   startWatching(): Promise<void>;
   stopWatching(): Promise<void>;
 }

packages/metro-file-map/src/lib/RootPathUtils.js

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @format
  * @flow strict
+ * @format
  */
 
 import invariant from 'invariant';

packages/metro-file-map/src/lib/TreeFS.js

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @format
  * @flow strict-local
+ * @format
  */
 
 import type {
@@ -42,6 +42,37 @@ type NormalizedSymlinkTarget = {
   startOfBasenameIdx: number,
 };
 
+type DeserializedSnapshotInput = {
+  rootDir: string,
+  fileSystemData: DirectoryNode,
+  processFile: ProcessFileFunction,
+};
+
+type TreeFSOptions = {
+  rootDir: Path,
+  files?: FileData,
+  processFile: ProcessFileFunction,
+};
+
+type MatchFilesOptions = Readonly<{
+  /* Filter relative paths against a pattern. */
+  filter?: ?RegExp,
+  /* `filter` is applied against absolute paths, vs rootDir-relative. (default: false) */
+  filterCompareAbsolute?: boolean,
+  /* `filter` is applied against posix-delimited paths, even on Windows. (default: false) */
+  filterComparePosix?: boolean,
+  /* Follow symlinks when enumerating paths. (default: false) */
+  follow?: boolean,
+  /* Should search for files recursively. (default: true) */
+  recursive?: boolean,
+  /* Match files under a given root, or null for all files */
+  rootDir?: ?Path,
+}>;
+
+type MetadataIteratorOptions = Readonly<{
+  includeSymlinks: boolean,
+  includeNodeModules: boolean,
+}>;
 /**
  * OVERVIEW:
  *
@@ -99,15 +130,8 @@ export default class TreeFS implements MutableFileSystem {
   +#rootDir: Path;
   #rootNode: DirectoryNode = new Map();
 
-  constructor({
-    rootDir,
-    files,
-    processFile,
-  }: {
-    rootDir: Path,
-    files?: FileData,
-    processFile: ProcessFileFunction,
-  }) {
+  constructor(opts: TreeFSOptions) {
+    const {rootDir, files, processFile} = opts;
     this.#rootDir = rootDir;
     this.#pathUtils = new RootPathUtils(rootDir);
     this.#processFile = processFile;
@@ -120,15 +144,8 @@ export default class TreeFS implements MutableFileSystem {
     return this.#cloneTree(this.#rootNode);
   }
 
-  static fromDeserializedSnapshot({
-    rootDir,
-    fileSystemData,
-    processFile,
-  }: {
-    rootDir: string,
-    fileSystemData: DirectoryNode,
-    processFile: ProcessFileFunction,
-  }): TreeFS {
+  static fromDeserializedSnapshot(args: DeserializedSnapshotInput): TreeFS {
+    const {rootDir, fileSystemData, processFile} = args;
     const tfs = new TreeFS({processFile, rootDir});
     tfs.#rootNode = fileSystemData;
     return tfs;
@@ -302,27 +319,15 @@ export default class TreeFS implements MutableFileSystem {
    * The query matches against normalized paths which start with `./`,
    * for example: `a/b.js` -> `./a/b.js`
    */
-  *matchFiles({
-    filter = null,
-    filterCompareAbsolute = false,
-    filterComparePosix = false,
-    follow = false,
-    recursive = true,
-    rootDir = null,
-  }: Readonly<{
-    /* Filter relative paths against a pattern. */
-    filter?: ?RegExp,
-    /* `filter` is applied against absolute paths, vs rootDir-relative. (default: false) */
-    filterCompareAbsolute?: boolean,
-    /* `filter` is applied against posix-delimited paths, even on Windows. (default: false) */
-    filterComparePosix?: boolean,
-    /* Follow symlinks when enumerating paths. (default: false) */
-    follow?: boolean,
-    /* Should search for files recursively. (default: true) */
-    recursive?: boolean,
-    /* Match files under a given root, or null for all files */
-    rootDir?: ?Path,
-  }>): Iterable<Path> {
+  *matchFiles(opts: MatchFilesOptions): Iterable<Path> {
+    const {
+      filter = null,
+      filterCompareAbsolute = false,
+      filterComparePosix = false,
+      follow = false,
+      recursive = true,
+      rootDir = null,
+    } = opts;
     const normalRoot = rootDir == null ? '' : this.#normalizePath(rootDir);
     const contextRootResult = this.#lookupByNormalPath(normalRoot);
     if (!contextRootResult.exists) {
@@ -993,12 +998,7 @@ export default class TreeFS implements MutableFileSystem {
     return null;
   }
 
-  *metadataIterator(
-    opts: Readonly<{
-      includeSymlinks: boolean,
-      includeNodeModules: boolean,
-    }>,
-  ): Iterator<{
+  *metadataIterator(opts: MetadataIteratorOptions): Iterator<{
     baseName: string,
     canonicalPath: string,
     metadata: FileMetadata,

packages/metro-file-map/src/lib/checkWatchmanCapabilities.js

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @format
  * @flow strict
+ * @format
  */
 
 import {execFile} from 'child_process';

packages/metro-file-map/src/lib/dependencyExtractor.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ */
+
+declare const dependencyExtractor: {
+  extract: (code: string) => Set<string>;
+};
+
+export = dependencyExtractor;