Write buildInfo irrespective of incremental if invoked from tsc --b

Author: sheetalkamat

src/compiler/builder.ts

@@ -56,6 +56,7 @@ import {
     HostForComputeHash,
     isArray,
     isDeclarationFileName,
+    isIncrementalCompilation,
     isJsonSourceFile,
     isNumber,
     isString,
@@ -376,7 +377,7 @@ function createBuilderProgramState(
     }
     else {
         // We arent using old state, so atleast emit buildInfo with current information
-        state.buildInfoEmitPending = true;
+        state.buildInfoEmitPending = isIncrementalCompilation(compilerOptions);
     }
 
     // Update changed files and copy semantic diagnostics if we can
@@ -1190,6 +1191,9 @@ function getBuildInfo(state: BuilderProgramStateWithDefinedProgram): BuildInfo {
     const fileNames: string[] = [];
     const fileNameToFileId = new Map<string, ProgramBuildInfoFileId>();
     const rootFileNames = new Set(state.program.getRootFileNames().map(f => toPath(f, currentDirectory, state.program.getCanonicalFileName)));
+
+    if (!isIncrementalCompilation(state.compilerOptions)) return createBuildInfo(/*program*/ undefined);
+
     const root: ProgramBuildInfoRoot[] = [];
     if (state.compilerOptions.outFile) {
         // Copy all fileInfo, version and impliedFormat

src/compiler/diagnosticMessages.json

@@ -4617,6 +4617,10 @@
         "category": "Error",
         "code": 5110
     },
+    "Option 'tsBuildInfoFile' cannot be specified without specifying option 'incremental' or 'composite' or if not running 'tsc -b'.": {
+        "category": "Error",
+        "code": 5111
+    },
 
     "Generates a sourcemap for each corresponding '.d.ts' file.": {
         "category": "Message",

src/compiler/emitter.ts

@@ -480,7 +480,7 @@ export function forEachEmittedFile<T>(
 
 export function getTsBuildInfoEmitOutputFilePath(options: CompilerOptions) {
     const configFile = options.configFilePath;
-    if (!isIncrementalCompilation(options)) return undefined;
+    if (!canEmitTsBuildInfo(options)) return undefined;
     if (options.tsBuildInfoFile) return options.tsBuildInfoFile;
     const outPath = options.outFile;
     let buildInfoExtensionLess: string;
@@ -499,6 +499,11 @@ export function getTsBuildInfoEmitOutputFilePath(options: CompilerOptions) {
     return buildInfoExtensionLess + Extension.TsBuildInfo;
 }
 
+/** @internal */
+export function canEmitTsBuildInfo(options: CompilerOptions) {
+    return isIncrementalCompilation(options) || !!options.tscBuild;
+}
+
 /** @internal */
 export function getOutputPathsForBundle(options: CompilerOptions, forceDtsPaths: boolean): EmitFileNames {
     const outPath = options.outFile!;

src/compiler/program.ts

@@ -8,6 +8,7 @@ import {
     AsExpression,
     BuilderProgram,
     CancellationToken,
+    canEmitTsBuildInfo,
     canHaveDecorators,
     canHaveIllegalDecorators,
     chainDiagnosticMessages,
@@ -195,7 +196,6 @@ import {
     isImportEqualsDeclaration,
     isImportSpecifier,
     isImportTypeNode,
-    isIncrementalCompilation,
     isInJSFile,
     isJSDocImportTag,
     isLiteralImportTypeNode,
@@ -4324,8 +4324,8 @@ export function createProgram(rootNamesOrOptions: readonly string[] | CreateProg
 
         const outputFile = options.outFile;
         if (options.tsBuildInfoFile) {
-            if (!isIncrementalCompilation(options)) {
-                createDiagnosticForOptionName(Diagnostics.Option_0_cannot_be_specified_without_specifying_option_1_or_option_2, "tsBuildInfoFile", "incremental", "composite");
+            if (!canEmitTsBuildInfo(options)) {
+                createDiagnosticForOptionName(Diagnostics.Option_tsBuildInfoFile_cannot_be_specified_without_specifying_option_incremental_or_composite_or_if_not_running_tsc_b, "tsBuildInfoFile");
             }
         }
         else if (options.incremental && !outputFile && !options.configFilePath) {

src/compiler/tsbuildPublic.ts

@@ -7411,6 +7411,7 @@ export interface CompilerOptions {
     esModuleInterop?: boolean;
     /** @internal */ showConfig?: boolean;
     useDefineForClassFields?: boolean;
+    /** @internal */ tscBuild?: boolean;
 
     [option: string]: CompilerOptionsValue | TsConfigSourceFile | undefined;
 }

src/compiler/types.ts

@@ -206,6 +206,11 @@ export type ReadableProgramBuildInfo = ReadableProgramMultiFileEmitBuildInfo | R
 export function isReadableProgramBundleEmitBuildInfo(info: ReadableProgramBuildInfo | undefined): info is ReadableProgramBundleEmitBuildInfo {
     return !!info && !!info.options?.outFile;
 }
+
+export function isReadableProgramMultiFileEmitBuildInfo(info: ReadableProgramBuildInfo | undefined): info is ReadableProgramMultiFileEmitBuildInfo {
+    return !!info && !info.options?.outFile;
+}
+
 export type ReadableBuildInfo = Omit<ts.BuildInfo, "program"> & { program: ReadableProgramBuildInfo | undefined; size: number; };
 function generateBuildInfoProgramBaseline(sys: ts.System, buildInfoPath: string, buildInfo: ts.BuildInfo) {
     let program: ReadableProgramBuildInfo | undefined;

src/testRunner/unittests/helpers/baseline.ts

@@ -10,6 +10,7 @@ import {
     CommandLineProgram,
     generateSourceMapBaselineFiles,
     isReadableProgramBundleEmitBuildInfo,
+    isReadableProgramMultiFileEmitBuildInfo,
     ReadableBuildInfo,
     ReadableProgramBuildInfoFileInfo,
     ReadableProgramBundleEmitBuildInfo,
@@ -307,6 +308,7 @@ function verifyTscEditDiscrepancies({
                 `FileInfos:: File:: ${outputFile}`,
             );
             if (!isReadableProgramBundleEmitBuildInfo(incrementalReadableBuildInfo?.program)) {
+                // Should not be with --outFile
                 ts.Debug.assert(!isReadableProgramBundleEmitBuildInfo(cleanReadableBuildInfo?.program));
                 // Verify that incrementally pending affected file emit are in clean build since clean build can contain more files compared to incremental depending of noEmitOnError option
                 if (incrementalReadableBuildInfo?.program?.affectedFilesPendingEmit) {
@@ -337,7 +339,8 @@ function verifyTscEditDiscrepancies({
                 }
             }
             else {
-                ts.Debug.assert(isReadableProgramBundleEmitBuildInfo(cleanReadableBuildInfo?.program));
+                // Should not be without --outFile
+                ts.Debug.assert(!isReadableProgramMultiFileEmitBuildInfo(cleanReadableBuildInfo?.program));
                 // Verify that incrementally pending affected file emit are in clean build since clean build can contain more files compared to incremental depending of noEmitOnError option
                 if (incrementalReadableBuildInfo?.program?.pendingEmit) {
                     if (cleanReadableBuildInfo?.program?.pendingEmit === undefined) {

src/testRunner/unittests/helpers/tsc.ts

@@ -249,6 +249,10 @@ describe("unittests:: tsbuild:: outFile::", () => {
                 caption: "Make non incremental build with change in file that doesnt affect dts",
                 edit: fs => appendText(fs, "/src/first/first_PART1.ts", "console.log(s);"),
                 commandLineArgs: ["--b", "/src/third", "--verbose"],
+                discrepancyExplanation: () => [
+                    "Clean build is non incremental so it will have non incremental tsbuildInfo for third project",
+                    "The incremental build does not build third so will only update timestamps for third tsbuildInfo and hence its from incremental build before",
+                ],
             },
             {
                 caption: "Make incremental build with change in file that doesnt affect dts",

src/testRunner/unittests/tsbuild/outFile.ts

@@ -1,3 +1,4 @@
+import { noop } from "../../_namespaces/ts.js";
 import { dedent } from "../../_namespaces/Utils.js";
 import * as vfs from "../../_namespaces/vfs.js";
 import { jsonToReadableText } from "../helpers.js";
@@ -90,6 +91,57 @@ describe("unittests:: tsbuild:: with rootDir of project reference in parentDirec
         edits: noChangeOnlyRuns,
     });
 
+    verifyTsc({
+        scenario: "projectReferenceWithRootDirInParent",
+        subScenario: "reports error for same tsbuildinfo file without incremental",
+        fs: () => projFs,
+        commandLineArgs: ["--b", "/src/src/main", "--verbose"],
+        modifyFs: fs => {
+            fs.writeFileSync(
+                "/src/src/main/tsconfig.json",
+                jsonToReadableText({
+                    compilerOptions: { outDir: "../../dist/" },
+                    references: [{ path: "../other" }],
+                }),
+            );
+            fs.writeFileSync(
+                "/src/src/other/tsconfig.json",
+                jsonToReadableText({
+                    compilerOptions: { composite: true, outDir: "../../dist/" },
+                }),
+            );
+        },
+    });
+
+    verifyTsc({
+        scenario: "projectReferenceWithRootDirInParent",
+        subScenario: "reports error for same tsbuildinfo file without incremental with tsc",
+        fs: () => projFs,
+        commandLineArgs: ["--b", "/src/src/other", "--verbose"],
+        modifyFs: fs => {
+            fs.writeFileSync(
+                "/src/src/main/tsconfig.json",
+                jsonToReadableText({
+                    compilerOptions: { outDir: "../../dist/" },
+                    references: [{ path: "../other" }],
+                }),
+            );
+            fs.writeFileSync(
+                "/src/src/other/tsconfig.json",
+                jsonToReadableText({
+                    compilerOptions: { composite: true, outDir: "../../dist/" },
+                }),
+            );
+        },
+        edits: [
+            {
+                caption: "Running tsc on main",
+                edit: noop,
+                commandLineArgs: ["-p", "/src/src/main"],
+            },
+        ],
+    });
+
     verifyTsc({
         scenario: "projectReferenceWithRootDirInParent",
         subScenario: "reports no error when tsbuildinfo differ",

src/testRunner/unittests/tsbuild/referencesWithRootDirInParent.ts

@@ -1,7 +1,7 @@
-error TS5069: Option 'tsBuildInfoFile' cannot be specified without specifying option 'incremental' or option 'composite'.
+error TS5111: Option 'tsBuildInfoFile' cannot be specified without specifying option 'incremental' or 'composite' or if not running 'tsc -b'.
 
 
-!!! error TS5069: Option 'tsBuildInfoFile' cannot be specified without specifying option 'incremental' or option 'composite'.
+!!! error TS5111: Option 'tsBuildInfoFile' cannot be specified without specifying option 'incremental' or 'composite' or if not running 'tsc -b'.
 ==== optionsTsBuildInfoFileWithoutIncrementalAndComposite.ts (0 errors) ====
     const x = "Hello World";
 

tests/baselines/reference/optionsTsBuildInfoFileWithoutIncrementalAndComposite.errors.txt

@@ -36,7 +36,7 @@ Output::
 [HH:MM:SS AM] Projects in this build: 
     * src/project/tsconfig.json
 
-[[90mHH:MM:SS AM[0m] Project 'src/project/tsconfig.json' is out of date because output file 'src/project/src/main.js' does not exist
+[[90mHH:MM:SS AM[0m] Project 'src/project/tsconfig.json' is out of date because output file 'src/project/tsconfig.tsbuildinfo' does not exist
 
 [HH:MM:SS AM] Building project '/src/project/tsconfig.json'...
 
@@ -58,6 +58,15 @@ exports.x = void 0;
 exports.x = 10;
 
 
+//// [/src/project/tsconfig.tsbuildinfo]
+{"version":"FakeTSVersion"}
+
+//// [/src/project/tsconfig.tsbuildinfo.readable.baseline.txt]
+{
+  "version": "FakeTSVersion",
+  "size": 27
+}
+
 
 
 Change:: no-change-run
@@ -85,5 +94,6 @@ Output::
 exitCode:: ExitStatus.Success
 
 
+//// [/src/project/tsconfig.tsbuildinfo] unlink
 //// [/src/project/src/main.d.ts] unlink
 //// [/src/project/src/main.js] unlink

tests/baselines/reference/tsbuild/clean/tsx-with-dts-emit.js

@@ -54,6 +54,7 @@ Program root files: [
 ]
 Program options: {
   "incremental": true,
+  "tscBuild": true,
   "configFilePath": "/src/project/tsconfig.json"
 }
 Program structureReused: Not
@@ -233,6 +234,7 @@ Program root files: [
 Program options: {
   "incremental": true,
   "sourceMap": true,
+  "tscBuild": true,
   "configFilePath": "/src/project/tsconfig.json"
 }
 Program structureReused: Not
@@ -416,6 +418,7 @@ Program root files: [
 ]
 Program options: {
   "incremental": true,
+  "tscBuild": true,
   "configFilePath": "/src/project/tsconfig.json"
 }
 Program structureReused: Not
@@ -585,6 +588,7 @@ Program root files: [
 Program options: {
   "incremental": true,
   "declaration": true,
+  "tscBuild": true,
   "configFilePath": "/src/project/tsconfig.json"
 }
 Program structureReused: Not
@@ -746,6 +750,7 @@ Program options: {
   "incremental": true,
   "declaration": true,
   "declarationMap": true,
+  "tscBuild": true,
   "configFilePath": "/src/project/tsconfig.json"
 }
 Program structureReused: Not
@@ -937,6 +942,7 @@ Program root files: [
 ]
 Program options: {
   "incremental": true,
+  "tscBuild": true,
   "configFilePath": "/src/project/tsconfig.json"
 }
 Program structureReused: Not
@@ -1089,6 +1095,7 @@ Program options: {
   "incremental": true,
   "declaration": true,
   "declarationMap": true,
+  "tscBuild": true,
   "configFilePath": "/src/project/tsconfig.json"
 }
 Program structureReused: Not
@@ -1258,6 +1265,7 @@ Program root files: [
 Program options: {
   "incremental": true,
   "inlineSourceMap": true,
+  "tscBuild": true,
   "configFilePath": "/src/project/tsconfig.json"
 }
 Program structureReused: Not
@@ -1434,6 +1442,7 @@ Program root files: [
 Program options: {
   "incremental": true,
   "sourceMap": true,
+  "tscBuild": true,
   "configFilePath": "/src/project/tsconfig.json"
 }
 Program structureReused: Not
@@ -1615,6 +1624,7 @@ Program root files: [
 ]
 Program options: {
   "incremental": true,
+  "tscBuild": true,
   "configFilePath": "/src/project/tsconfig.json"
 }
 Program structureReused: Not
@@ -1789,6 +1799,7 @@ Program options: {
   "incremental": true,
   "declaration": true,
   "declarationMap": true,
+  "tscBuild": true,
   "configFilePath": "/src/project/tsconfig.json"
 }
 Program structureReused: Not