ttsc 0.26.1 → 0.27.0

package/shim/compiler/emit_sourcemap.go

@@ -5,12 +5,27 @@
 // tsgo's Program.Emit has no hook to inject a custom transformer, so ttsc's
 // driver assembles the per-file emit pipeline by hand (see GetSourceFilesToEmit
 // / GetScriptTransformers / GetOutputPathsFor). That hand-assembly must also
-// reproduce the source-map step the emitter would otherwise run: a bare
-// printer.Write with a nil generator drops the `.js.map` entirely. This file
-// ports internal/compiler/emitter.go's `printSourceFile` source-map branch so a
-// `sourceMap` / `inlineSourceMap` build that goes through a plugin transform
-// produces the same map (and `//# sourceMappingURL=` trailer) a plain build
-// does. Keep it in sync with that emitter source when the pin is bumped.
+// reproduce every step the emitter would otherwise run: building the printer's
+// options from the compiler options, the source-map branch a bare printer.Write
+// with a nil generator drops entirely, the `emitBOM` byte-order mark, and the
+// `WriteFileData` the emitter hands its writeFile callback. This file ports
+// internal/compiler/emitter.go's `emitJSFile` PrinterOptions construction and
+// the whole of its `printSourceFile` so a build that goes through a plugin
+// transform honors the same compiler options — and produces the same map (and
+// `//# sourceMappingURL=` trailer, and the same first bytes) — a plain build
+// does.
+//
+// Keep it in sync with that emitter source when the pin is bumped. Anything
+// `emitJSFile` sets and this file omits takes the Go zero value, which silently
+// turns the option off for every project that emits through a plugin transform,
+// and anything `printSourceFile` does around the printer that this file omits
+// is missing from the plugin lane's output even when the option set matches.
+// `printer_options_field_set_matches_pinned_emitter_test.go` fails when the pin
+// changes the PrinterOptions field set,
+// `write_file_data_field_set_matches_pinned_emitter_test.go` fails when it
+// changes the WriteFileData field set, and
+// `emit_plugin_transform_matches_plain_emit_for_printer_options_test.go` fails
+// when a forwarded option stops matching the plain emit.
 package compiler
 
 import (
@@ -25,24 +40,43 @@ import (
 
 // PrintedFile is the rendered output of one source file in the plugin-transform
 // emit path. JS is the JavaScript text, already carrying a trailing
-// `//# sourceMappingURL=` comment when a map was produced. MapText/MapPath are
-// the external source-map file and its path; both are empty when no external map
-// is written (source maps disabled, or an inline map encoded into the JS).
+// `//# sourceMappingURL=` comment when a map was produced and a leading UTF-8
+// byte order mark when `emitBOM` is on. MapText/MapPath are the external
+// source-map file and its path; both are empty when no external map is written
+// (source maps disabled, or an inline map encoded into the JS).
 type PrintedFile struct {
   JS      string
   MapText string
   MapPath string
+  // SourceMapUrlPos is the offset of the `//# sourceMappingURL=` trailer in JS,
+  // or -1 when no trailer was written — the value tsgo's emitter reports as
+  // WriteFileData.SourceMapUrlPos so a caller can locate and rewrite the
+  // trailer without re-scanning the text. Like the emitter's, it is the printer
+  // writer's text position, taken BEFORE the `emitBOM` mark is prepended, so a
+  // BOM build's offset is three bytes short of the trailer's position in the
+  // written file. That is the pinned emitter's own behavior
+  // (internal/compiler/emitter.go::printSourceFile computes sourceMapUrlPos
+  // from the writer and only then calls AddUTF8ByteOrderMark), and this lane
+  // exists to match it: "correcting" the offset here would make a plugin build
+  // disagree with the plain build of the same project.
+  SourceMapUrlPos int
 }
 
 // PrintFileWithSourceMap renders sourceFile through a printer built from options
 // and emitContext, optionally generating a source map, mirroring
-// emitter.printSourceFile for the single-file plugin-transform path. When
+// emitter.emitJSFile and emitter.printSourceFile for the single-file
+// plugin-transform path. The PrinterOptions below are emitJSFile's, field for
+// field: `removeComments`, `newLine`, `noEmitHelpers`, `sourceMap`,
+// `inlineSourceMap`, `inlineSources`, and `target`. When
 // `sourceMap`/`inlineSourceMap` is enabled (and the file is not JSON) it builds a
 // sourcemap.Generator, feeds it to the printer so positions are recorded,
-// appends the sourceMappingURL trailer, and returns the external map text/path
-// (or encodes the map inline). host supplies the same directory/casing context
-// tsgo's emitter reads. With source maps off it is byte-for-byte the prior
-// bare-printer behavior.
+// appends the sourceMappingURL trailer, records its offset, and returns the
+// external map text/path (or encodes the map inline). `emitBOM` prepends the
+// UTF-8 byte order mark to the JavaScript afterwards, exactly where
+// printSourceFile does it — outside PrinterOptions, which is why forwarding the
+// whole options struct never reached it. The external map is written without a
+// mark, matching the emitter's own `writeText(sourceMapFilePath, ..., nil)`.
+// host supplies the same directory/casing context tsgo's emitter reads.
 func PrintFileWithSourceMap(
   emitContext *innerprinter.EmitContext,
   node *innerast.Node,
@@ -53,10 +87,13 @@ func PrintFileWithSourceMap(
   sourceMapFilePath string,
 ) PrintedFile {
   printer := innerprinter.NewPrinter(innerprinter.PrinterOptions{
+    RemoveComments:  options.RemoveComments.IsTrue(),
     NewLine:         options.NewLine,
+    NoEmitHelpers:   options.NoEmitHelpers.IsTrue(),
     SourceMap:       options.SourceMap.IsTrue(),
     InlineSourceMap: options.InlineSourceMap.IsTrue(),
     InlineSources:   options.InlineSources.IsTrue(),
+    Target:          options.Target,
   }, innerprinter.PrintHandlers{}, emitContext)
   writer := innerprinter.NewTextWriter(options.NewLine.GetNewLineCharacter(), 0)
 
@@ -78,7 +115,7 @@ func PrintFileWithSourceMap(
 
   printer.Write(node, sourceFile, writer, generator)
 
-  result := PrintedFile{}
+  result := PrintedFile{SourceMapUrlPos: -1}
   if generator != nil {
     url := sourceMappingURL(options, generator, host, jsFilePath, sourceMapFilePath, sourceFile)
     if len(url) > 0 {
@@ -89,6 +126,7 @@ func PrintFileWithSourceMap(
           writer.RawWrite("\n")
         }
       }
+      result.SourceMapUrlPos = writer.GetTextPos()
       writer.WriteComment("//# sourceMappingURL=")
       writer.WriteComment(url)
     }
@@ -100,6 +138,9 @@ func PrintFileWithSourceMap(
     writer.WriteLine()
   }
   result.JS = writer.String()
+  if options.EmitBOM.IsTrue() {
+    result.JS = innerstringutil.AddUTF8ByteOrderMark(result.JS)
+  }
   return result
 }
 

package/shim/compiler/incremental.go

@@ -1,13 +1,20 @@
 // gen_shims:hand-maintained
 //
-// Reference-graph parts of tsgo's own incremental engine (`tsc --incremental`
-// semantics), linked from internal/execute/incremental so ttsc's transform
-// envelopes can carry the same language-semantic input bound the compiler
-// itself uses for invalidation: per-file direct resolved references and the
-// files that contribute to the global scope.
+// Parts of tsgo's own incremental engine (`tsc --incremental` semantics),
+// exposed from internal/execute/incremental for the two things a ttsc host
+// needs from it:
+//
+//   - the reference graph, so transform envelopes can carry the same
+//     language-semantic input bound the compiler itself uses for invalidation:
+//     per-file direct resolved references and the files that contribute to the
+//     global scope;
+//   - the build-information emit, so a host that constructs its Program
+//     in-process still writes the `.tsbuildinfo` an `incremental` or
+//     `composite` project asked for.
 package compiler
 
 import (
+  "context"
   _ "unsafe"
 
   innerast "github.com/microsoft/typescript-go/internal/ast"
@@ -15,11 +22,41 @@ import (
   innercompiler "github.com/microsoft/typescript-go/internal/compiler"
   "github.com/microsoft/typescript-go/internal/tspath"
 
-  // The linknamed symbols below live in the incremental package; the blank
-  // import compiles it into every shim consumer so the references resolve.
-  _ "github.com/microsoft/typescript-go/internal/execute/incremental"
+  // Imported for EmitFreshWithBuildInfo below, and for the linknamed symbols
+  // further down: compiling the package into every shim consumer is what makes
+  // those references resolve.
+  "github.com/microsoft/typescript-go/internal/execute/incremental"
 )
 
+// EmitFreshWithBuildInfo runs a full emit through tsgo's own incremental
+// program, so an `incremental` or `composite` project gets the `.tsbuildinfo`
+// tsgo would have written, in the exact format and location
+// `outputpaths.GetBuildInfoFileName` resolves from the compiler options.
+//
+// This is the emit half of `tsc.go::performIncrementalCompilation`, which the
+// tsgo CLI takes whenever `CompilerOptions.IsIncremental()`. A host that builds
+// its Program in-process (ttsc's driver, and therefore every plugin sidecar
+// emitting through it) never reaches that CLI path, so without this the build
+// information is silently dropped even though the options parsed cleanly.
+//
+// "Fresh" is the load-bearing word: no previous snapshot is supplied, so
+// `programToSnapshot` marks every file changed and this emits the whole program
+// exactly as `Program.Emit` does, then writes the build info. A ttsc plugin's
+// output is not a pure function of the source text a build info records — it
+// also depends on the plugin binary, its config file, and its contributors —
+// so reusing a previous snapshot to skip a file would serve stale transformed
+// output. Producing the record is sound; consuming it needs plugin identity in
+// the invalidation key first.
+func EmitFreshWithBuildInfo(ctx context.Context, program *Program, options EmitOptions) *EmitResult {
+  incrementalProgram := incremental.NewProgram(
+    program,
+    nil,
+    incremental.CreateHost(program.Host()),
+    false,
+  )
+  return incrementalProgram.Emit(ctx, options)
+}
+
 //go:linkname incrementalGetReferencedFiles github.com/microsoft/typescript-go/internal/execute/incremental.getReferencedFiles
 func incrementalGetReferencedFiles(program *innercompiler.Program, file *innerast.SourceFile) *collections.Set[tspath.Path]
 

package/src/TtscCompiler.ts

@@ -6,7 +6,10 @@ import { resolveProjectConfig } from "./compiler/internal/project/resolveProject
 import { resolveBinary } from "./compiler/internal/resolveBinary";
 import { createProcessDiagnostic } from "./compiler/internal/runBuild";
 import { transformProjectInMemory } from "./compiler/internal/transformProjectInMemory";
-import { assertSafeExplicitCacheDirectory } from "./internal/assertSafeExplicitCacheDirectory";
+import {
+  type SafeCacheCleanupTarget,
+  resolveSafeCacheCleanupTargets,
+} from "./internal/resolveSafeCacheCleanupTargets";
 import { resolveCleanTargets } from "./plugin/internal/buildSourcePlugin";
 import { loadProjectPlugins } from "./plugin/internal/loadProjectPlugins";
 import type { ITtscCompilerContext } from "./structures/ITtscCompilerContext";
@@ -86,15 +89,16 @@ export class TtscCompiler {
   /**
    * Remove compiled cache artifacts for this compiler instance.
    *
-   * Removes the resolved cache root (which holds both the plugin binaries and,
-   * when ttsc-owned, the Go build cache), a ttsc-owned Go build cache that
-   * lives outside that root (`TTSC_GO_CACHE_DIR`), and the two legacy
-   * project-local caches. A user-provided `GOCACHE` is never removed. The cache
+   * Removes an explicit `cacheDir` wholesale. Otherwise removes the plugin
+   * binary subdirectory, a safely identified ttsc-owned Go build cache
+   * (including an external `TTSC_GO_CACHE_DIR`), and the two legacy
+   * project-local caches. A user-provided `GOCACHE` is never removed. Every
+   * resolved deletion target is validated before the first removal. The cache
    * location comes from this instance's `cacheDir` and environment
    * (`TTSC_CACHE_DIR` / `TTSC_GO_CACHE_DIR`), defaulting to
-   * `<workspaceRoot>/node_modules/.cache/ttsc`. An explicit cache directory
-   * that equals or contains the project, or names a filesystem root, is
-   * rejected before any directory is removed.
+   * `<workspaceRoot>/node_modules/.cache/ttsc`. Any resolved cache target that
+   * equals or contains the project, or names a filesystem root, is rejected
+   * before any directory is removed.
    *
    * @returns Cache directories that were removed.
    */
@@ -105,31 +109,35 @@ export class TtscCompiler {
       path.join(projectRoot, ".ttsc"),
     ];
     const explicitCacheDir = this.resolveCacheDir();
+    let targets: string[];
     if (explicitCacheDir !== undefined) {
-      assertSafeExplicitCacheDirectory(projectRoot, explicitCacheDir);
       // An explicit constructor `cacheDir` names the cache directory for this
       // instance — exactly like `ttsc clean --cache-dir X` on the CLI — so
       // remove it wholesale plus the legacy project-local caches. This keeps
       // the programmatic and CLI clean contracts identical for an explicit
       // cache dir.
-      return removeExistingDirectories([explicitCacheDir, ...legacyTargets]);
-    }
-    // Default / `context.env.TTSC_CACHE_DIR`: resolve the cache root and the Go
-    // build cache (`TTSC_GO_CACHE_DIR`) from this instance's effective
-    // environment — the same `{ ...process.env, ...context.env }` that
-    // prepare()/compile()/transform() build with — then remove only the
-    // ttsc-owned subdirectories, so a possibly-shared root is never deleted and
-    // a user-provided `GOCACHE` is never touched. Using the effective env (not
-    // ambient `process.env`) makes clean() remove exactly the artifacts this
-    // instance owns, including a `TTSC_GO_CACHE_DIR` supplied only in
-    // `context.env`.
-    return removeExistingDirectories(
-      resolveCleanTargets(
+      targets = [explicitCacheDir, ...legacyTargets];
+    } else {
+      // Default / `context.env.TTSC_CACHE_DIR`: resolve the cache root and the Go
+      // build cache (`TTSC_GO_CACHE_DIR`) from this instance's effective
+      // environment — the same `{ ...process.env, ...context.env }` that
+      // prepare()/compile()/transform() build with — then remove only the
+      // ttsc-owned subdirectories, so a possibly-shared root is never deleted and
+      // a user-provided `GOCACHE` is never touched. Using the effective env (not
+      // ambient `process.env`) makes clean() remove exactly the artifacts this
+      // instance owns, including a `TTSC_GO_CACHE_DIR` supplied only in
+      // `context.env`.
+      targets = resolveCleanTargets(
         projectRoot,
         this.resolvePluginCacheDir(),
         this.resolveEffectiveEnv(),
-      ),
-    );
+      );
+    }
+    // Validate the complete deletion set before removing the first directory.
+    // This includes an environment-selected TTSC_GO_CACHE_DIR and project-local
+    // legacy locations, not only an explicit constructor cacheDir.
+    const safeTargets = resolveSafeCacheCleanupTargets(projectRoot, targets);
+    return removeExistingDirectories(safeTargets);
   }
 
   /**
@@ -234,24 +242,29 @@ export class TtscCompiler {
    * The effective environment for this instance's source-plugin builds and
    * clean targets: `context.env` merged over `process.env`, matching the
    * documented {@link ITtscCompilerContext.env} contract that child compiler,
-   * native-plugin, and native-host processes already receive. Returned as a
-   * fresh object so callers never mutate the shared `process.env`; when no
-   * `context.env` was supplied this is a plain copy of `process.env`, so CLI /
-   * default behavior is unchanged.
+   * native-plugin, native-host, and isolated descriptor processes already
+   * receive. Returned as a fresh object so callers never mutate the shared
+   * `process.env`; when no `context.env` was supplied this is a plain copy of
+   * `process.env`, so CLI / default behavior is unchanged.
    */
   private resolveEffectiveEnv(): NodeJS.ProcessEnv {
     return { ...process.env, ...this.context.env };
   }
 }
 
-function removeExistingDirectories(directories: readonly string[]): string[] {
+function removeExistingDirectories(
+  directories: readonly SafeCacheCleanupTarget[],
+): string[] {
   const removed: string[] = [];
-  for (const directory of [...new Set(directories)]) {
-    if (!fs.existsSync(directory)) {
+  const visited = new Set<string>();
+  for (const directory of directories) {
+    if (visited.has(directory.path)) continue;
+    visited.add(directory.path);
+    if (!directory.exists || !fs.existsSync(directory.path)) {
       continue;
     }
-    fs.rmSync(directory, { recursive: true, force: true });
-    removed.push(directory);
+    fs.rmSync(directory.path, { recursive: true, force: true });
+    removed.push(directory.requestedPath);
   }
   return removed;
 }
@@ -265,6 +278,9 @@ interface ProjectTransformation {
   dependencies?: Record<string, string[]>;
   dependenciesComplete?: string[];
   graph?: ITtscCompilerTransformation.IReferenceGraph;
+  hostInputHashes?: Record<string, string | null>;
+  hostInputRealpaths?: Record<string, string | null>;
+  hostInputs?: string[];
   result: TtscBuildResult;
   typescript: Record<string, string>;
   volatile?: string[];
@@ -382,6 +398,9 @@ function toCompilerTransformation(
     dependencies,
     dependenciesComplete,
     graph,
+    hostInputHashes,
+    hostInputRealpaths,
+    hostInputs,
     result,
     typescript,
     volatile,
@@ -390,6 +409,9 @@ function toCompilerTransformation(
     ...(dependencies === undefined ? {} : { dependencies }),
     ...(dependenciesComplete === undefined ? {} : { dependenciesComplete }),
     ...(graph === undefined ? {} : { graph }),
+    ...(hostInputHashes === undefined ? {} : { hostInputHashes }),
+    ...(hostInputRealpaths === undefined ? {} : { hostInputRealpaths }),
+    ...(hostInputs === undefined ? {} : { hostInputs }),
     ...(volatile === undefined ? {} : { volatile }),
   };
   if (result.status === 0 && !hasErrorDiagnostics(result.diagnostics)) {

package/src/compiler/internal/captureProcessOutput.ts

@@ -1,7 +1,8 @@
 import fs from "node:fs";
-import os from "node:os";
 import path from "node:path";
 
+import { createCanonicalTempDirectory } from "../../internal/createCanonicalTempDirectory";
+
 export interface CapturedProcessOutput {
   /** Close the descriptors and remove the backing files. */
   dispose(): void;
@@ -32,7 +33,7 @@ export interface CapturedProcessOutput {
  * bytes.
  */
 export function captureProcessOutput(): CapturedProcessOutput {
-  const directory = fs.mkdtempSync(path.join(os.tmpdir(), "ttsc-spawn-"));
+  const directory = createCanonicalTempDirectory("ttsc-spawn-");
   const stdoutPath = path.join(directory, "stdout");
   const stderrPath = path.join(directory, "stderr");
   const stdoutFd = fs.openSync(stdoutPath, "w+");

package/src/compiler/internal/compileProjectInMemory.ts

@@ -1,7 +1,7 @@
 import fs from "node:fs";
-import os from "node:os";
 import path from "node:path";
 
+import { createCanonicalTempDirectory } from "../../internal/createCanonicalTempDirectory";
 import { hasProjectPluginEntries } from "../../plugin/internal/loadProjectPlugins";
 import type { ITtscCompilerContext } from "../../structures/ITtscCompilerContext";
 import type { ITtscCompilerDiagnostic } from "../../structures/ITtscCompilerDiagnostic";
@@ -11,6 +11,7 @@ import { buildNativeCompiler } from "./buildNativeCompiler";
 import { isOutsideRelativePath, packageRootDir } from "./paths";
 import { readProjectConfig } from "./project/readProjectConfig";
 import { runBuild } from "./runBuild";
+import { inheritedSidecarEnv } from "./sharedHostHelpers";
 import { outputText, spawnNative } from "./spawnNative";
 
 /**
@@ -50,7 +51,7 @@ export function compileProjectInMemory(options: ITtscCompilerContext): {
     ["api-compile", "--cwd", project.root, "--tsconfig", tsconfig],
     {
       cwd: project.root,
-      env: { ...process.env, ...options.env },
+      env: inheritedSidecarEnv(options.env),
     },
   );
   if (res.error) {
@@ -110,7 +111,7 @@ function compileProjectWithPlugins(
   output: Record<string, string>;
   result: TtscBuildResult;
 } {
-  const tempRoot = fs.mkdtempSync(path.join(os.tmpdir(), "ttsc-api-output-"));
+  const tempRoot = createCanonicalTempDirectory("ttsc-api-output-");
   const tempOutDir = path.join(tempRoot, "out");
   try {
     const result = runBuild({
@@ -119,6 +120,13 @@ function compileProjectWithPlugins(
       emit: true,
       forceListEmittedFiles: true,
       outDir: tempOutDir,
+      // The temp directory is an `outDir` this lane injected so the emit can be
+      // read back as strings; the project need not declare one at all. tsgo
+      // answers an inferred common source directory with TS5011 as soon as any
+      // `outDir` is in play, so pin the root it would infer. The keys
+      // `outputKeyMapper` builds are unchanged by it — that root is exactly the
+      // layout tsgo already lays the emit out against (issue #1172).
+      pinInferredRootDir: true,
       quiet: true,
       resolvedProject: project,
       structuredDiagnostics: true,

package/src/compiler/internal/resolveEmittedJavaScript.ts

@@ -20,6 +20,8 @@ import { isOutsideRelativePath } from "./paths";
  * Returns `null` when no matching output file is found on disk.
  */
 export function resolveEmittedJavaScript(options: {
+  /** Skip trailing-stem recovery when exact source ownership is required. */
+  allowStemFallback?: boolean;
   /** Pre-computed list of emitted paths; when absent `outDir` is scanned. */
   emittedFiles?: readonly string[];
   outDir: string;
@@ -45,6 +47,10 @@ export function resolveEmittedJavaScript(options: {
     }
   }
 
+  if (options.allowStemFallback === false) {
+    return null;
+  }
+
   // Score the pre-computed emit list first (cheap). When it yields nothing —
   // because the list is incomplete (a native transform host such as typia emits
   // without printing the `--listEmittedFiles` lines) or because the emit landed