feat: add generate trace api

Author: DylanPiercey

.changeset/open-mails-lick.md

@@ -0,0 +1,6 @@
+---
+"@marko/language-server": minor
+"@marko/type-check": minor
+---
+
+Add generateTrace api.

packages/language-server/src/service/script/index.ts

@@ -55,6 +55,9 @@ const optionalModifierReg = /\boptional\b/;
 const deprecatedModifierReg = /\bdeprecated\b/;
 const colorModifierReg = /\bcolor\b/;
 const localInternalsPrefix = "__marko_internal_";
+const getCanonicalFileName = ts.sys.useCaseSensitiveFileNames
+  ? (fileName: string) => fileName
+  : (fileName: string) => fileName.toLocaleLowerCase();
 const requiredTSCompilerOptions: ts.CompilerOptions = {
   module: ts.ModuleKind.ESNext,
   moduleResolution: ts.ModuleResolutionKind.Bundler,
@@ -1010,8 +1013,4 @@ function getTSTriggerChar(char: string | undefined) {
     return char as ts.CompletionsTriggerCharacter;
 }
 
-function getCanonicalFileName(fileName: string) {
-  return ts.sys.useCaseSensitiveFileNames ? fileName : fileName.toLowerCase();
-}
-
 export { ScriptService as default };

packages/type-check/src/cli.ts

@@ -12,6 +12,7 @@ const args = arg(
   {
     "--project": String,
     "--display": String,
+    "--generateTrace": String,
     "--help": Boolean,
     "--version": Boolean,
     "-p": "--project",
@@ -72,6 +73,7 @@ For more information, visit ${color.blue(
   );
 } else {
   const {
+    "--generateTrace": generateTrace,
     "--display": display = process.env.CI
       ? Display.condensed
       : Display.codeframe,
@@ -86,7 +88,7 @@ For more information, visit ${color.blue(
   }
 
   checkDisplay(display);
-  run({ project, display });
+  run({ generateTrace, project, display });
 }
 
 function checkDisplay(

packages/type-check/src/run.ts

@@ -24,6 +24,7 @@ export interface Options {
   project?: string;
   display?: Display;
   emit?: boolean;
+  generateTrace?: string;
 }
 
 interface Report {
@@ -45,8 +46,8 @@ const isSourceMapExtensionReg = /\.map$/;
 const skipRemapExtensionsReg =
   /\.(?:[cm]?jsx?|json|marko|css|less|sass|scss|styl|stylus|pcss|postcss|sss|a?png|jpe?g|jfif|pipeg|pjp|gif|svg|ico|web[pm]|avif|mp4|ogg|mp3|wav|flac|aac|opus|woff2?|eot|[ot]tf|webmanifest|pdf|txt)$/;
 
-const extractCache = new WeakMap<
-  ts.SourceFile,
+const extractCache = new Map<
+  string,
   ReturnType<Processors.Processor["extract"]>
 >();
 const requiredTSCompilerOptions: ts.CompilerOptions = {
@@ -66,8 +67,55 @@ export default function run(opts: Options) {
       findRootConfigFile("jsconfig.json"),
   } = opts;
 
-  if (!configFile)
+  if (!configFile) {
     throw new Error("Could not find tsconfig.json or jsconfig.json");
+  }
+
+  if (opts.generateTrace) {
+    (ts as any).startTracing?.(
+      "build",
+      path.resolve(opts.generateTrace),
+      configFile,
+    );
+    const tracing = (ts as any).tracing;
+    if (!tracing) {
+      throw new Error("generateTrace not available in TypeScript compiler.");
+    }
+
+    const { push } = tracing;
+    tracing.push = (
+      phase: unknown,
+      name: unknown,
+      args?: unknown,
+      separateBeginAndEnd?: unknown,
+    ) => {
+      if (
+        args &&
+        typeof args === "object" &&
+        "pos" in args &&
+        typeof args.pos === "number" &&
+        "end" in args &&
+        typeof args.end === "number"
+      ) {
+        const fileName =
+          "path" in args
+            ? args.path
+            : "fileName" in args
+              ? args.fileName
+              : undefined;
+        if (typeof fileName === "string") {
+          const extracted = extractCache.get(getCanonicalFileName(fileName));
+          if (extracted) {
+            (args as any).generatedPos = args.pos;
+            (args as any).generatedEnd = args.end;
+            args.pos = extracted.sourceOffsetAt(args.pos);
+            args.end = extracted.sourceOffsetAt(args.end);
+          }
+        }
+      }
+      return push.call(tracing, phase, name, args, separateBeginAndEnd);
+    };
+  }
 
   const formatSettings = ts.getDefaultFormatCodeSettings(
     ts.sys.newLine,
@@ -332,7 +380,7 @@ export default function run(opts: Options) {
               .createHash("md5")
               .update(extractedCode)
               .digest("hex");
-            extractCache.set(sourceFile, extracted);
+            extractCache.set(getCanonicalFileName(fileName), extracted);
             return sourceFile;
           }
 
@@ -433,7 +481,7 @@ export default function run(opts: Options) {
               }
 
               const extracted = extractCache.get(
-                program.getSourceFile(sourceFile.fileName)!,
+                getCanonicalFileName(sourceFile.fileName),
               )!;
               const printContext: Processors.PrintContext = {
                 extracted,
@@ -542,7 +590,9 @@ function reportDiagnostic(report: Report, diag: ts.Diagnostic) {
     let loc: Location | void = undefined;
 
     if (diag.start !== undefined) {
-      const extracted = extractCache.get(diag.file);
+      const extracted = extractCache.get(
+        getCanonicalFileName(diag.file.fileName),
+      );
 
       if (extracted) {
         loc = extracted.sourceLocationAt(