@rnx-kit/cli 0.9.53 → 0.9.57

package/src/start.ts

@@ -5,7 +5,6 @@ import {
   loadMetroConfig,
   startServer,
 } from "@rnx-kit/metro-service";
-import { findConfigFile, Service } from "@rnx-kit/typescript-service";
 import chalk from "chalk";
 import type { Reporter, ReportableEvent } from "metro";
 import type Server from "metro/src/Server";
@@ -14,7 +13,7 @@ import path from "path";
 import readline from "readline";
 import { getKitServerConfig } from "./serve/kit-config";
 import { customizeMetroConfig } from "./metro-config";
-import type { TSProjectInfo } from "./types";
+import type { TypeScriptValidationOptions } from "./types";
 
 export type CLIStartOptions = {
   host: string;
@@ -120,35 +119,17 @@ export async function rnxStart(
       : undefined),
   });
 
-  // prepare for typescript validation, if requested
-  let tsprojectInfo: TSProjectInfo | undefined;
-  if (serverConfig.typescriptValidation) {
-    const tsservice = new Service((message) => terminal.log(message));
-
-    const configFileName = findConfigFile(
-      metroConfig.projectRoot,
-      "tsconfig.json"
-    );
-    if (!configFileName) {
-      terminal.log(
-        chalk.yellow(
-          `Warning: cannot find tsconfig.json under project root '${metroConfig.projectRoot}' -- skipping TypeScript validation`
-        )
-      );
-    } else {
-      tsprojectInfo = {
-        service: tsservice,
-        configFileName,
-      };
-    }
-  }
-
   // customize the metro config to include plugins, presets, etc.
+  const typescriptValidationOptions: TypeScriptValidationOptions = {
+    print: (message: string): void => {
+      terminal.log(message);
+    },
+  };
   customizeMetroConfig(
     metroConfig,
     serverConfig.detectCyclicDependencies,
     serverConfig.detectDuplicateDependencies,
-    tsprojectInfo,
+    serverConfig.typescriptValidation ? typescriptValidationOptions : false,
     serverConfig.experimental_treeShake
   );
 

package/src/types.ts

@@ -1,6 +1,4 @@
-import type { Service } from "@rnx-kit/typescript-service";
-
-export type TSProjectInfo = {
-  service: Service;
-  configFileName: string;
+export type TypeScriptValidationOptions = {
+  print?: (message: string) => void;
+  throwOnError?: boolean;
 };

package/src/typescript/project-cache.ts

@@ -0,0 +1,182 @@
+import { findPackageDir } from "@rnx-kit/tools-node";
+import {
+  AllPlatforms,
+  platformExtensions,
+} from "@rnx-kit/tools-react-native/platform";
+import { changeHostToUseReactNativeResolver } from "@rnx-kit/typescript-react-native-resolver";
+import {
+  createDiagnosticWriter,
+  Project,
+  readConfigFile,
+} from "@rnx-kit/typescript-service";
+import path from "path";
+import ts from "typescript";
+
+export type ProjectInfo = {
+  tsproject: Project;
+  tssourceFiles: Set<string>;
+};
+
+/**
+ * Collection of TypeScript projects, separated by their target platform.
+ *
+ * Target platform is a react-native concept, not a TypeScript concept.
+ * However, each project is configured with react-native module resolution,
+ * which means the module file graph could vary by platform. And that means
+ * each platform could yield different type errors.
+ *
+ * For example, `import { f } from "./utils"` could load `./utils.android.ts`
+ * for Android and `./utils.ios.ts` iOS.
+ */
+export interface ProjectCache {
+  /**
+   * Discard all cached projects targeting a specific platform.
+   *
+   * @param platform Target platform
+   */
+  clearPlatform(platform: AllPlatforms): void;
+
+  /**
+   * Get info on the project which targets a specific platform and contains a specific
+   * source file. If the project is not cached, load it and add it to the cache.
+   *
+   * @param platform Target platform
+   * @param sourceFile Source file
+   * @returns Project targeting the given platform and containing the given source file
+   */
+  getProjectInfo(sourceFile: string, platform: AllPlatforms): ProjectInfo;
+}
+
+/**
+ * Create an empty cache for holding TypeScript projects.
+ *
+ * @param print Optional method for printing messages. When not set, messages are printed to the console.
+ * @returns Empty project cache
+ */
+export function createProjectCache(
+  print?: (message: string) => void
+): ProjectCache {
+  const documentRegistry = ts.createDocumentRegistry();
+  const diagnosticWriter = createDiagnosticWriter(print);
+
+  // Collection of projects organized by root directory, then by platform.
+  const projects: Record<
+    string,
+    Partial<Record<AllPlatforms, ProjectInfo>>
+  > = {};
+
+  function findProjectRoot(sourceFile: string): string {
+    // Search known root directories to see if the source file is in one of them.
+    for (const root of Object.keys(projects)) {
+      if (sourceFile.startsWith(root)) {
+        return root;
+      }
+    }
+
+    // Search the file system for the root of source file's package.
+    const root = findPackageDir(path.dirname(sourceFile));
+    if (!root) {
+      throw new Error(
+        `Cannot find project root for source file '${sourceFile}'`
+      );
+    }
+
+    return root;
+  }
+
+  function readTSConfig(root: string): ts.ParsedCommandLine {
+    const configFileName = path.join(root, "tsconfig.json");
+
+    const cmdLine = readConfigFile(configFileName);
+    if (!cmdLine) {
+      throw new Error(`Failed to load '${configFileName}'`);
+    } else if (cmdLine.errors.length > 0) {
+      const writer = createDiagnosticWriter();
+      cmdLine.errors.forEach((e) => writer.print(e));
+      throw new Error(`Failed to load '${configFileName}'`);
+    }
+
+    return cmdLine;
+  }
+
+  function createProjectInfo(
+    root: string,
+    platform: AllPlatforms
+  ): ProjectInfo {
+    // Load the TypeScript configuration file for this project.
+    const cmdLine = readTSConfig(root);
+
+    //  Trim down the list of source files found by TypeScript. This ensures
+    //  that only explicitly added files are loaded and parsed by TypeScript.
+    //  This is a perf optimization. We don't want to spend cycles on files
+    //  that won't be used, such as *.android.ts when bundling for ios.
+    //
+    //  The exception to this rule are .d.ts files. They hold global types,
+    //  modules and namespaces, and having them in the project is the only
+    //  way they can be loaded.
+
+    const tssourceFiles = new Set(cmdLine.fileNames);
+    cmdLine.fileNames = cmdLine.fileNames.filter((f) => f.endsWith(".d.ts"));
+
+    // Create a TypeScript project using the configuration file. Enhance the
+    // underlying TS language service with our react-native module resolver.
+    const enhanceLanguageServiceHost = (host: ts.LanguageServiceHost): void => {
+      const platformExtensionNames = platformExtensions(platform);
+      const disableReactNativePackageSubstitution = true;
+      const traceReactNativeModuleResolutionErrors = false;
+      const traceResolutionLog = undefined;
+      changeHostToUseReactNativeResolver({
+        host,
+        options: cmdLine.options,
+        platform,
+        platformExtensionNames,
+        disableReactNativePackageSubstitution,
+        traceReactNativeModuleResolutionErrors,
+        traceResolutionLog,
+      });
+    };
+    const tsproject = new Project(
+      documentRegistry,
+      diagnosticWriter,
+      cmdLine,
+      enhanceLanguageServiceHost
+    );
+
+    return {
+      tsproject,
+      tssourceFiles,
+    };
+  }
+
+  function getProjectInfo(
+    sourceFile: string,
+    platform: AllPlatforms
+  ): ProjectInfo {
+    const root = findProjectRoot(sourceFile);
+    projects[root] ||= {};
+
+    let info = projects[root][platform];
+    if (!info) {
+      info = createProjectInfo(root, platform);
+      projects[root][platform] = info;
+    }
+    return info;
+  }
+
+  function clearPlatform(platform: AllPlatforms): void {
+    Object.values(projects).forEach((projectsByPlatform) => {
+      const info = projectsByPlatform[platform];
+      if (info) {
+        if (info.tsproject) {
+          info.tsproject.dispose();
+        }
+        delete projectsByPlatform[platform];
+      }
+    });
+  }
+
+  return {
+    clearPlatform,
+    getProjectInfo,
+  };
+}