Rename memory/cache to full/layer

Author: weswigham

packages/typescript/src/api/async/api.ts

@@ -1439,8 +1439,8 @@ export class Program implements FormatDiagnosticsHost {
     }
 
     /**
-     * Emits files to the configured filesystem. Cache and host filesystems are
-     * written through; memory filesystems remain immutable and return emitted
+     * Emits files to the configured filesystem. Layer and host filesystems are
+     * written through; full filesystems remain immutable and return emitted
      * files in {@link EmitResult.fileSystem}.
      */
     async emit(emitOnly?: EmitOnly): Promise<EmitResult> {
@@ -1451,7 +1451,7 @@ export class Program implements FormatDiagnosticsHost {
         });
         const fileSystem = response.emittedFilesContents.length
             ? {
-                kind: "cache" as const,
+                kind: "layer" as const,
                 files: Object.fromEntries(response.emittedFiles.map((fileName, index) => [fileName, response.emittedFilesContents[index]])),
             }
             : undefined;

packages/typescript/src/api/async/types.ts

@@ -404,7 +404,7 @@ export interface EmitResult {
     readonly emitSkipped: boolean;
     readonly diagnostics: readonly Diagnostic[];
     readonly emittedFiles: readonly string[];
-    /** Emitted files captured as a cache layer suitable for {@link Snapshot.update}. */
+    /** Emitted files captured as a filesystem layer suitable for {@link Snapshot.update}. */
     readonly fileSystem?: RequestFileSystem | undefined;
 }
 

packages/typescript/src/api/fs.ts

@@ -38,15 +38,15 @@ export interface FileSystem {
 /** The callback names supported by the Go server for virtual FS delegation. */
 export const fsCallbackNames = ["readFile", "fileExists", "directoryExists", "getAccessibleEntries", "realpath", "writeFile"] as const;
 
-export interface CreateRequestFileSystemOptions {
-    /** Complete directory listings. Memory filesystems derive these from `files` when omitted. */
+export interface CreateFileSystemOptions {
+    /** Complete directory listings. Full filesystems derive these from `files` when omitted. */
     directories?: Record<string, RequestDirectoryEntries>;
     symlinks?: Record<string, RequestSymlink>;
     /** Files or directory trees hidden from an underlying snapshot or host filesystem. */
     removedPaths?: readonly string[];
 }
 
-export interface CreateMemoryFileSystemWithLibOptions extends CreateRequestFileSystemOptions {
+export interface CreateFileSystemWithLibOptions extends CreateFileSystemOptions {
     /** Default library directory used by a custom or non-embedded compiler executable. */
     defaultLibraryPath?: string;
 }
@@ -57,21 +57,21 @@ export interface CreateMemoryFileSystemWithLibOptions extends CreateRequestFileS
  */
 export type RequestFileEntries = readonly (readonly [id: DocumentIdentifier, content: string])[];
 
-/** Creates a total memory request filesystem, deriving directory listings when omitted. */
-export function createMemoryFileSystem(
+/** Creates a full request filesystem, deriving directory listings when omitted. */
+export function createFileSystem(
     files: RequestFileEntries,
-    options: CreateRequestFileSystemOptions = {},
+    options: CreateFileSystemOptions = {},
 ): RequestFileSystem {
-    return createRequestFileSystem("memory", files, options);
+    return createRequestFileSystem("full", files, options);
 }
 
 /**
- * Creates a total memory request filesystem with the compiler's default library
+ * Creates a full request filesystem with the compiler's default library
  * directory mounted read-only through the host filesystem.
  */
-export function createMemoryFileSystemWithLib(
+export function createFileSystemWithLib(
     files: RequestFileEntries,
-    options: CreateMemoryFileSystemWithLibOptions = {},
+    options: CreateFileSystemWithLibOptions = {},
 ): RequestFileSystem {
     const defaultLibraryPaths = options.defaultLibraryPath
         ? [normalizePath(options.defaultLibraryPath)]
@@ -89,25 +89,25 @@ export function createMemoryFileSystemWithLib(
     for (const defaultLibraryPath of defaultLibraryPaths) {
         symlinks[defaultLibraryPath] ??= { target: defaultLibraryPath, host: true };
     }
-    return createRequestFileSystem("memory", files, {
+    return createRequestFileSystem("full", files, {
         symlinks,
         ...(options.directories ? { directories: options.directories } : {}),
         ...(options.removedPaths?.length ? { removedPaths: options.removedPaths } : {}),
     });
 }
 
-/** Creates a read-through cache request filesystem, merging host directory listings when omitted. */
-export function createCacheFileSystem(
+/** Creates a request filesystem layer, merging base directory listings when omitted. */
+export function createFileSystemLayer(
     files: RequestFileEntries,
-    options: CreateRequestFileSystemOptions = {},
+    options: CreateFileSystemOptions = {},
 ): RequestFileSystem {
-    return createRequestFileSystem("cache", files, options);
+    return createRequestFileSystem("layer", files, options);
 }
 
 function createRequestFileSystem(
     kind: RequestFileSystem["kind"],
     files: RequestFileEntries,
-    options: CreateRequestFileSystemOptions,
+    options: CreateFileSystemOptions,
 ): RequestFileSystem {
     const normalizedFiles = new Map<string, string>();
     for (const [id, content] of files) {
@@ -118,7 +118,7 @@ function createRequestFileSystem(
         normalizedFiles.set(fileName, content);
     }
     const fileRecord = Object.fromEntries(normalizedFiles);
-    const directories = options.directories ?? (kind === "memory" ? deriveDirectoryListings(fileRecord) : undefined);
+    const directories = options.directories ?? (kind === "full" ? deriveDirectoryListings(fileRecord) : undefined);
     return {
         kind,
         files: fileRecord,

packages/typescript/src/api/proto.generated.ts

@@ -208,7 +208,7 @@ export interface UpdateSnapshotParams {
     fileChanges?: APIFileChanges;
     /**
      * FileSystem supplies file contents and directory listings for the new snapshot.
-     * A memory filesystem is canonical and total. A cache filesystem is checked
+     * A full filesystem is canonical and total. A filesystem layer is checked
      * before falling back to the host filesystem.
      */
     fileSystem?: RequestFileSystem;
@@ -865,7 +865,7 @@ export interface EmitResponse {
     emittedFiles: string[];
     /**
      * EmittedFilesContents contains contents parallel to EmittedFiles when the
-     * source snapshot uses a memory filesystem. It is empty for write-through emits.
+     * source snapshot uses a full filesystem. It is empty for write-through emits.
      */
     emittedFilesContents: string[];
 }
@@ -1228,7 +1228,7 @@ export interface APIFileChanges {
  * for a request that creates a snapshot.
  */
 export interface RequestFileSystem {
-    kind: "cache" | "memory";
+    kind: "full" | "layer";
     /** Files maps file names to their complete contents. */
     files: Record<string, string>;
     /** Directories maps directory names to complete listing results. */
@@ -1451,7 +1451,7 @@ export interface RequestSymlink {
     target: string;
     /**
      * Host routes the target through the host filesystem. This is the only way a
-     * memory filesystem can access paths not supplied in the request filesystem.
+     * full filesystem can access paths not supplied in the request filesystem.
      */
     host?: boolean;
 }

packages/typescript/src/api/sync/api.ts

@@ -2794,8 +2794,8 @@ export class Program implements FormatDiagnosticsHost {
     }
 
     /**
-     * Emits files to the configured filesystem. Cache and host filesystems are
-     * written through; memory filesystems remain immutable and return emitted
+     * Emits files to the configured filesystem. Layer and host filesystems are
+     * written through; full filesystems remain immutable and return emitted
      * files in {@link EmitResult.fileSystem}.
      */
     get emit(): {
@@ -2814,7 +2814,7 @@ export class Program implements FormatDiagnosticsHost {
                 });
                 const fileSystem = response.emittedFilesContents.length
                     ? {
-                        kind: "cache" as const,
+                        kind: "layer" as const,
                         files: Object.fromEntries(response.emittedFiles.map((fileName, index) => [fileName, response.emittedFilesContents[index]])),
                     }
                     : undefined;
@@ -2833,7 +2833,7 @@ export class Program implements FormatDiagnosticsHost {
                 });
                 const fileSystem = response.emittedFilesContents.length
                     ? {
-                        kind: "cache" as const,
+                        kind: "layer" as const,
                         files: Object.fromEntries(response.emittedFiles.map((fileName, index) => [fileName, response.emittedFilesContents[index]])),
                     }
                     : undefined;

packages/typescript/src/api/sync/types.ts

@@ -528,7 +528,7 @@ export interface EmitResult {
     readonly emitSkipped: boolean;
     readonly diagnostics: readonly Diagnostic[];
     readonly emittedFiles: readonly string[];
-    /** Emitted files captured as a cache layer suitable for {@link Snapshot.update}. */
+    /** Emitted files captured as a filesystem layer suitable for {@link Snapshot.update}. */
     readonly fileSystem?: RequestFileSystem | undefined;
 }