refactor: replace sync fs calls with async fs/promises

Author: cryptodev-2s

scripts/generate-messenger-docs/discovery.ts

@@ -1,6 +1,4 @@
-/* eslint-disable n/no-sync */
-
-import * as fs from 'fs';
+import * as fs from 'fs/promises';
 import * as path from 'path';
 
 export const SKIP_DIRS = new Set([
@@ -16,20 +14,20 @@ export const SKIP_DIRS = new Set([
  * Recursively find all non-test TypeScript files in a directory.
  *
  * @param dir - The directory to search.
- * @returns An array of absolute file paths.
+ * @returns A promise that resolves to an array of absolute file paths.
  */
-export function findTsFiles(dir: string): string[] {
+export async function findTsFiles(dir: string): Promise<string[]> {
   const results: string[] = [];
 
-  function walk(directory: string): void {
-    for (const entry of fs.readdirSync(directory, { withFileTypes: true })) {
+  async function walk(directory: string): Promise<void> {
+    for (const entry of await fs.readdir(directory, { withFileTypes: true })) {
       const full = path.join(directory, entry.name);
       if (entry.isDirectory()) {
         // Skip test dirs, node_modules, dist
         if (SKIP_DIRS.has(entry.name)) {
           continue;
         }
-        walk(full);
+        await walk(full);
       } else if (
         entry.name.endsWith('.ts') &&
         !entry.name.endsWith('.test.ts') &&
@@ -42,7 +40,7 @@ export function findTsFiles(dir: string): string[] {
     }
   }
 
-  walk(dir);
+  await walk(dir);
   return results;
 }
 
@@ -51,25 +49,25 @@ export function findTsFiles(dir: string): string[] {
  * Skips nested `node_modules` subdirectories.
  *
  * @param dir - The directory to search.
- * @returns An array of absolute file paths.
+ * @returns A promise that resolves to an array of absolute file paths.
  */
-export function findDtsFiles(dir: string): string[] {
+export async function findDtsFiles(dir: string): Promise<string[]> {
   const results: string[] = [];
 
-  function walk(directory: string): void {
-    for (const entry of fs.readdirSync(directory, { withFileTypes: true })) {
+  async function walk(directory: string): Promise<void> {
+    for (const entry of await fs.readdir(directory, { withFileTypes: true })) {
       const full = path.join(directory, entry.name);
       if (entry.isDirectory()) {
         if (entry.name === 'node_modules') {
           continue;
         }
-        walk(full);
+        await walk(full);
       } else if (entry.name.endsWith('.d.cts')) {
         results.push(full);
       }
     }
   }
 
-  walk(dir);
+  await walk(dir);
   return results;
 }

scripts/generate-messenger-docs/extraction.ts

@@ -1,11 +1,24 @@
-/* eslint-disable n/no-sync */
-
-import * as fs from 'fs';
+import * as fs from 'fs/promises';
 import * as path from 'path';
 import * as ts from 'typescript';
 
 import type { MessengerItemDoc, MethodInfo } from './types';
 
+/**
+ * Check whether a file exists.
+ *
+ * @param filePath - The path to check.
+ * @returns A promise that resolves to true if the file exists.
+ */
+async function fileExists(filePath: string): Promise<boolean> {
+  try {
+    await fs.access(filePath);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
 /**
  * Extract string constants from top-level variable declarations in a source file.
  * Only looks at top-level `const x = 'string'` or `const x = 'string' as const`.
@@ -60,12 +73,12 @@ function extractStringConstants(
  *
  * @param sourceFile - The TypeScript source file to search.
  * @param filePath - The absolute path of the source file on disk.
- * @returns A map of constant name to resolved string value.
+ * @returns A promise that resolves to a map of constant name to resolved string value.
  */
-function resolveControllerName(
+async function resolveControllerName(
   sourceFile: ts.SourceFile,
   filePath: string,
-): Map<string, string> {
+): Promise<Map<string, string>> {
   const names = extractStringConstants(sourceFile);
 
   // Chase single-hop local imports (no further recursion):
@@ -98,11 +111,11 @@ function resolveControllerName(
       : [path.join(dir, `${spec}.ts`), path.join(dir, spec, 'index.ts')];
 
     for (const candidate of candidates) {
-      if (!fs.existsSync(candidate)) {
+      if (!(await fileExists(candidate))) {
         continue;
       }
 
-      const content = fs.readFileSync(candidate, 'utf8');
+      const content = await fs.readFile(candidate, 'utf8');
       const sf = ts.createSourceFile(
         candidate,
         content,
@@ -463,22 +476,22 @@ function getPropertyText(
  * Extract messenger action/event type definitions from a single TypeScript file.
  *
  * @param filePath - The absolute path to the TypeScript file.
- * @param relBase - Optional base path for computing relative source paths (defaults to ROOT).
- * @returns An array of extracted messenger item docs.
+ * @param relBase - Base path for computing relative source paths.
+ * @returns A promise that resolves to an array of extracted messenger item docs.
  */
-export function extractFromFile(
+export async function extractFromFile(
   filePath: string,
   relBase: string,
-): MessengerItemDoc[] {
-  const content = fs.readFileSync(filePath, 'utf8');
+): Promise<MessengerItemDoc[]> {
+  const content = await fs.readFile(filePath, 'utf8');
   const sourceFile = ts.createSourceFile(
     filePath,
     content,
     ts.ScriptTarget.Latest,
     true,
   );
 
-  const constants = resolveControllerName(sourceFile, filePath);
+  const constants = await resolveControllerName(sourceFile, filePath);
   const classMethods = collectClassMethods(sourceFile);
   const items: MessengerItemDoc[] = [];
   const relPath = path.relative(relBase, filePath);

scripts/generate-messenger-docs/index.ts

@@ -2,4 +2,7 @@
 
 import { main } from './main';
 
-main();
+main().catch((error) => {
+  console.error(error);
+  process.exitCode = 1;
+});

scripts/generate-messenger-docs/main.ts

@@ -1,6 +1,4 @@
-/* eslint-disable n/no-sync */
-
-import * as fs from 'fs';
+import * as fs from 'fs/promises';
 import * as path from 'path';
 
 import { findDtsFiles, findTsFiles } from './discovery';
@@ -31,10 +29,25 @@ function deduplicationScore(item: MessengerItemDoc): number {
   return jsDocScore + homeScore;
 }
 
+/**
+ * Check whether a path exists.
+ *
+ * @param targetPath - The path to check.
+ * @returns A promise that resolves to true if the path exists.
+ */
+async function pathExists(targetPath: string): Promise<boolean> {
+  try {
+    await fs.access(targetPath);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
 /**
  * Main entry point: scans packages, extracts messenger types, and generates docs.
  */
-export function main(): void {
+export async function main(): Promise<void> {
   // Parse --client flag
   const clientIdx = process.argv.indexOf('--client');
   const clientPath = clientIdx === -1 ? undefined : process.argv[clientIdx + 1];
@@ -49,13 +62,13 @@ export function main(): void {
     );
 
     const nmDir = path.join(clientPath as string, 'node_modules', '@metamask');
-    if (!fs.existsSync(nmDir)) {
+    if (!(await pathExists(nmDir))) {
       throw new Error(`${nmDir} does not exist.`);
     }
 
     // Find @metamask packages that contain "controller" or "service" in name
-    const pkgDirs = fs
-      .readdirSync(nmDir, { withFileTypes: true })
+    const entries = await fs.readdir(nmDir, { withFileTypes: true });
+    const pkgDirs = entries
       .filter(
         (dirent) =>
           dirent.isDirectory() &&
@@ -65,14 +78,14 @@ export function main(): void {
       .map((dirent) => path.join(nmDir, dirent.name, 'dist'));
 
     for (const distDir of pkgDirs) {
-      if (!fs.existsSync(distDir)) {
+      if (!(await pathExists(distDir))) {
         continue;
       }
 
-      const dtsFiles = findDtsFiles(distDir);
+      const dtsFiles = await findDtsFiles(distDir);
       for (const file of dtsFiles) {
         try {
-          const items = extractFromFile(file, clientPath as string);
+          const items = await extractFromFile(file, clientPath as string);
           allItems.push(...items);
         } catch (error) {
           console.warn(
@@ -85,20 +98,20 @@ export function main(): void {
     console.log('Scanning packages for Messenger action/event types...');
 
     const packagesDir = path.join(ROOT, 'packages');
-    const packageDirs = fs
-      .readdirSync(packagesDir, { withFileTypes: true })
+    const entries = await fs.readdir(packagesDir, { withFileTypes: true });
+    const packageDirs = entries
       .filter((dirent) => dirent.isDirectory())
       .map((dirent) => path.join(packagesDir, dirent.name, 'src'));
 
     for (const srcDir of packageDirs) {
-      if (!fs.existsSync(srcDir)) {
+      if (!(await pathExists(srcDir))) {
         continue;
       }
 
-      const tsFiles = findTsFiles(srcDir);
+      const tsFiles = await findTsFiles(srcDir);
       for (const file of tsFiles) {
         try {
-          const items = extractFromFile(file, ROOT);
+          const items = await extractFromFile(file, ROOT);
           allItems.push(...items);
         } catch (error) {
           console.warn(
@@ -169,39 +182,39 @@ export function main(): void {
   const docsDir = path.join(ROOT, 'docs-site', 'docs');
 
   // Clean existing generated docs
-  if (fs.existsSync(docsDir)) {
-    fs.rmSync(docsDir, { recursive: true });
+  if (await pathExists(docsDir)) {
+    await fs.rm(docsDir, { recursive: true });
   }
-  fs.mkdirSync(docsDir, { recursive: true });
+  await fs.mkdir(docsDir, { recursive: true });
 
   // Generate namespace pages
   for (const ns of namespaces) {
     const nsDir = path.join(docsDir, ns.namespace);
-    fs.mkdirSync(nsDir, { recursive: true });
+    await fs.mkdir(nsDir, { recursive: true });
 
     if (ns.actions.length > 0) {
-      fs.writeFileSync(
+      await fs.writeFile(
         path.join(nsDir, 'actions.md'),
         generateNamespacePage(ns, 'action', clientMode),
       );
     }
 
     if (ns.events.length > 0) {
-      fs.writeFileSync(
+      await fs.writeFile(
         path.join(nsDir, 'events.md'),
         generateNamespacePage(ns, 'event', clientMode),
       );
     }
   }
 
   // Generate index page
-  fs.writeFileSync(
+  await fs.writeFile(
     path.join(docsDir, 'index.md'),
     generateIndexPage(namespaces, clientName),
   );
 
   // Generate sidebars
-  fs.writeFileSync(
+  await fs.writeFile(
     path.join(ROOT, 'docs-site', 'sidebars.ts'),
     generateSidebars(namespaces),
   );