Some tests coverage for --out and errors scenarios (#58652)

microsoft · May 24, 2024 · 7ad8f39 · 7ad8f39
1 parent d0ef028
commit 7ad8f39
Show file tree

Hide file tree

Showing 112 changed files with 21,418 additions and 3,912 deletions.
diff --git a/src/testRunner/tests.ts b/src/testRunner/tests.ts
@@ -122,6 +122,8 @@ export * from "./unittests/tsc/incremental.js";
 export * from "./unittests/tsc/libraryResolution.js";
 export * from "./unittests/tsc/listFilesOnly.js";
 export * from "./unittests/tsc/moduleResolution.js";
+export * from "./unittests/tsc/noEmit.js";
+export * from "./unittests/tsc/noEmitOnError.js";
 export * from "./unittests/tsc/projectReferences.js";
 export * from "./unittests/tsc/projectReferencesConfig.js";
 export * from "./unittests/tsc/redirect.js";
@@ -135,6 +137,7 @@ export * from "./unittests/tscWatch/incremental.js";
 export * from "./unittests/tscWatch/libraryResolution.js";
 export * from "./unittests/tscWatch/moduleResolution.js";
 export * from "./unittests/tscWatch/nodeNextWatch.js";
+export * from "./unittests/tscWatch/noEmitOnError.js";
 export * from "./unittests/tscWatch/programUpdates.js";
 export * from "./unittests/tscWatch/projectsWithReferences.js";
 export * from "./unittests/tscWatch/resolutionCache.js";

diff --git a/src/testRunner/unittests/helpers/declarationEmit.ts b/src/testRunner/unittests/helpers/declarationEmit.ts
@@ -0,0 +1,93 @@
+import { CompilerOptions } from "../../_namespaces/ts.js";
+import { dedent } from "../../_namespaces/Utils.js";
+import { FileSystem } from "../../_namespaces/vfs.js";
+import { jsonToReadableText } from "../helpers.js";
+import { libContent } from "./contents.js";
+import { loadProjectFromFiles } from "./vfs.js";
+
+export function getFsForDeclarationEmitWithErrors(options: CompilerOptions, incremental: true | undefined) {
+ return loadProjectFromFiles({
+ "/src/project/tsconfig.json": jsonToReadableText({
+ compilerOptions: {
+ module: "NodeNext",
+ moduleResolution: "NodeNext",
+ ...options,
+ incremental,
+ skipLibCheck: true,
+ skipDefaultLibCheck: true,
+ },
+ }),
+ "/src/project/index.ts": dedent`
+ import ky from 'ky';
+ export const api = ky.extend({});
+ `,
+ "/src/project/package.json": jsonToReadableText({
+ type: "module",
+ }),
+ "/src/project/node_modules/ky/distribution/index.d.ts": dedent`
+ type KyInstance = {
+ extend(options: Record<string,unknown>): KyInstance;
+ }
+ declare const ky: KyInstance;
+ export default ky;
+ `,
+ "/src/project/node_modules/ky/package.json": jsonToReadableText({
+ name: "ky",
+ type: "module",
+ main: "./distribution/index.js",
+ }),
+ "/lib/lib.esnext.full.d.ts": libContent,
+ });
+}
+
+export function getFsForDeclarationEmitWithErrorsWithOutFile(options: CompilerOptions, incremental: true | undefined) {
+ return loadProjectFromFiles({
+ "/src/project/tsconfig.json": jsonToReadableText({
+ compilerOptions: {
+ module: "amd",
+ ...options,
+ incremental,
+ skipLibCheck: true,
+ skipDefaultLibCheck: true,
+ outFile: "./outFile.js",
+ },
+ include: ["src"],
+ }),
+ "/src/project/src/index.ts": dedent`
+ import ky from 'ky';
+ export const api = ky.extend({});
+ `,
+ "/src/project/ky.d.ts": dedent`
+ type KyInstance = {
+ extend(options: Record<string,unknown>): KyInstance;
+ }
+ declare const ky: KyInstance;
+ export default ky;
+ `,
+ "/lib/lib.esnext.full.d.ts": libContent,
+ });
+}
+
+export function forEachDeclarationEmitWithErrorsScenario(
+ action: (
+ scenarioName: (scenario: string) => string,
+ fs: () => FileSystem,
+ ) => void,
+ withComposite: boolean,
+) {
+ for (const outFile of [false, true]) {
+ for (const incremental of [undefined, true] as const) {
+ action(
+ scenario => `${scenario}${outFile ? " outFile" : ""}${incremental ? " with incremental" : ""}`,
+ () =>
+ (outFile ? getFsForDeclarationEmitWithErrorsWithOutFile :
+ getFsForDeclarationEmitWithErrors)(
+ withComposite && incremental ?
+ { composite: true } :
+ { declaration: true },
+ incremental,
+ ),
+ );
+ }
+ }
+}
diff --git a/src/testRunner/unittests/helpers/noEmitOnError.ts b/src/testRunner/unittests/helpers/noEmitOnError.ts
@@ -4,17 +4,15 @@ import {
  FsContents,
  libContent,
 } from "./contents.js";
-import { loadProjectFromFiles } from "./vfs.js";
-import {
- createWatchedSystem,
- libFile,
-} from "./virtualFileSystemWithWatch.js";
+import { libFile } from "./virtualFileSystemWithWatch.js";
 
-export function getFsContentsForNoEmitOnError(): FsContents {
+function getFsContentsForNoEmitOnError(outFile: boolean, declaration: true | undefined, incremental: true | undefined): FsContents {
  return {
  "/user/username/projects/noEmitOnError/tsconfig.json": jsonToReadableText({
  compilerOptions: {
- outDir: "./dev-build",
+ ...outFile ? { outFile: "../dev-build.js", module: "amd" } : { outDir: "./dev-build" },
+ declaration,
+ incremental,
  noEmitOnError: true,
  },
  }),
@@ -37,21 +35,26 @@ export function getFsContentsForNoEmitOnError(): FsContents {
  };
 }
 
-export function getFsForNoEmitOnError() {
- return loadProjectFromFiles(
- getFsContentsForNoEmitOnError(),
- {
- cwd: "/user/username/projects/noEmitOnError",
- executingFilePath: libFile.path,
- },
- );
-}
-
-export function getSysForNoEmitOnError() {
- return createWatchedSystem(
- getFsContentsForNoEmitOnError(),
- {
- currentDirectory: "/user/username/projects/noEmitOnError",
- },
- );
+export function forEachNoEmitOnErrorScenario<T>(
+ loadFs: (contents: FsContents, currentDirectory: string, executingFilePath: string) => T,
+ action: (
+ scenarioName: (scenario: string) => string,
+ fs: () => T,
+ ) => void,
+) {
+ for (const outFile of [false, true]) {
+ for (const declaration of [undefined, true] as const) {
+ for (const incremental of [undefined, true] as const) {
+ action(
+ scenario => `${scenario}${outFile ? " outFile" : ""}${declaration ? " with declaration" : ""}${incremental ? " with incremental" : ""}`,
+ () =>
+ loadFs(
+ getFsContentsForNoEmitOnError(outFile, declaration, incremental),
+ "/user/username/projects/noEmitOnError",
+ libFile.path,
+ ),
+ );
+ }
+ }
+ }
 }
diff --git a/src/testRunner/unittests/tsbuild/configFileErrors.ts b/src/testRunner/unittests/tsbuild/configFileErrors.ts
@@ -43,57 +43,61 @@ describe("unittests:: tsbuild:: configFileErrors:: when tsconfig extends the mis
 });
 
 describe("unittests:: tsbuild:: configFileErrors:: reports syntax errors in config file", () => {
- verifyTsc({
- scenario: "configFileErrors",
- subScenario: "reports syntax errors in config file",
- fs: () =>
- loadProjectFromFiles({
- "/src/a.ts": "export function foo() { }",
- "/src/b.ts": "export function bar() { }",
- "/src/tsconfig.json": dedent`
+ function verify(outFile?: object) {
+ verifyTsc({
+ scenario: "configFileErrors",
+ subScenario: `reports syntax errors in config file${outFile ? " with outFile" : ""}`,
+ fs: () =>
+ loadProjectFromFiles({
+ "/src/a.ts": "export function foo() { }",
+ "/src/b.ts": "export function bar() { }",
+ "/src/tsconfig.json": dedent`
 {
  "compilerOptions": {
- "composite": true,
+ "composite": true,${outFile ? jsonToReadableText(outFile).replace(/[{}]/g, "") : ""}
  },
  "files": [
  "a.ts"
  "b.ts"
  ]
 }`,
- }),
- commandLineArgs: ["--b", "/src/tsconfig.json"],
- edits: [
- {
- edit: fs =>
- replaceText(
- fs,
- "/src/tsconfig.json",
- ",",
- `,
+  }),
+  commandLineArgs: ["--b", "/src/tsconfig.json"],
+  edits: [
+  {
+  edit: fs =>
+  replaceText(
+  fs,
+  "/src/tsconfig.json",
+  ",",
+  `,
  "declaration": true,`,
- ),
- caption: "reports syntax errors after change to config file",
- discrepancyExplanation: () => [
- "During incremental build, tsbuildinfo is not emitted, so declaration option is not present",
- "Clean build has declaration option in tsbuildinfo",
- ],
- },
- {
- edit: fs => appendText(fs, "/src/a.ts", "export function fooBar() { }"),
- caption: "reports syntax errors after change to ts file",
- },
- noChangeRun,
- {
- edit: fs =>
- fs.writeFileSync(
- "/src/tsconfig.json",
- jsonToReadableText({
- compilerOptions: { composite: true, declaration: true },
- files: ["a.ts", "b.ts"],
- }),
- ),
- caption: "builds after fixing config file errors",
- },
- ],
- });
+ ),
+ caption: "reports syntax errors after change to config file",
+ discrepancyExplanation: !outFile ? () => [
+ "During incremental build, tsbuildinfo is not emitted, so declaration option is not present",
+ "Clean build has declaration option in tsbuildinfo",
+ ] : undefined,
+ },
+ {
+ edit: fs => appendText(fs, "/src/a.ts", "export function fooBar() { }"),
+ caption: "reports syntax errors after change to ts file",
+ },
+ noChangeRun,
+ {
+ edit: fs =>
+ fs.writeFileSync(
+ "/src/tsconfig.json",
+ jsonToReadableText({
+ compilerOptions: { composite: true, declaration: true, ...outFile },
+ files: ["a.ts", "b.ts"],
+ }),
+ ),
+ caption: "builds after fixing config file errors",
+ },
+ ],
+ });
+ }
+ verify();
+ verify({ outFile: "../outFile.js", module: "amd" });
 });
diff --git a/src/testRunner/unittests/tsbuild/declarationEmit.ts b/src/testRunner/unittests/tsbuild/declarationEmit.ts
@@ -1,7 +1,7 @@
 import { dedent } from "../../_namespaces/Utils.js";
 import { FileSet } from "../../_namespaces/vfs.js";
 import { jsonToReadableText } from "../helpers.js";
-import { libContent } from "../helpers/contents.js";
+import { forEachDeclarationEmitWithErrorsScenario } from "../helpers/declarationEmit.js";
 import {
  noChangeOnlyRuns,
  verifyTsc,
@@ -126,43 +126,16 @@ export function fn4() {
  commandLineArgs: ["--b", "/src/packages/pkg2/tsconfig.json", "--verbose"],
  });
 
- verifyTsc({
- scenario: "declarationEmit",
- subScenario: "reports dts generation errors with incremental",
- commandLineArgs: ["-b", `/src/project`, "--explainFiles", "--listEmittedFiles", "--v"],
- fs: () =>
- loadProjectFromFiles({
- "/src/project/tsconfig.json": jsonToReadableText({
- compilerOptions: {
- module: "NodeNext",
- moduleResolution: "NodeNext",
- incremental: true,
- declaration: true,
- skipLibCheck: true,
- skipDefaultLibCheck: true,
- },
- }),
- "/src/project/index.ts": dedent`
- import ky from 'ky';
- export const api = ky.extend({});
- `,
- "/src/project/package.json": jsonToReadableText({
- type: "module",
- }),
- "/src/project/node_modules/ky/distribution/index.d.ts": dedent`
- type KyInstance = {
- extend(options: Record<string,unknown>): KyInstance;
- }
- declare const ky: KyInstance;
- export default ky;
- `,
- "/src/project/node_modules/ky/package.json": jsonToReadableText({
- name: "ky",
- type: "module",
- main: "./distribution/index.js",
- }),
- "/lib/lib.esnext.full.d.ts": libContent,
- }),
- edits: noChangeOnlyRuns,
- });
+ forEachDeclarationEmitWithErrorsScenario(
+ (scenario, fs) => {
+ verifyTsc({
+ scenario: "declarationEmit",
+ subScenario: scenario("reports dts generation errors"),
+ commandLineArgs: ["-b", `/src/project`, "--explainFiles", "--listEmittedFiles", "--v"],
+ fs,
+ edits: noChangeOnlyRuns,
+ });
+ },
+ /*withComposite*/ false,
+ );
 });
diff --git a/src/testRunner/unittests/tsbuild/noEmit.ts b/src/testRunner/unittests/tsbuild/noEmit.ts
@@ -6,15 +6,15 @@ import {
 import { loadProjectFromFiles } from "../helpers/vfs.js";
 
 describe("unittests:: tsbuild:: noEmit", () => {
- function verifyNoEmitWorker(subScenario: string, aTsContent: string, commandLineArgs: readonly string[]) {
+ function verifyNoEmitWorker(subScenario: string, aTsContent: string, commandLineArgs: readonly string[], options?: object) {
  verifyTsc({
  scenario: "noEmit",
  subScenario,
  fs: () =>
  loadProjectFromFiles({
  "/src/a.ts": aTsContent,
  "/src/tsconfig.json": jsonToReadableText({
- compilerOptions: { noEmit: true },
+ compilerOptions: { ...options, noEmit: true },
  }),
  }),
  commandLineArgs,
@@ -33,6 +33,8 @@ describe("unittests:: tsbuild:: noEmit", () => {
  function verifyNoEmit(subScenario: string, aTsContent: string) {
  verifyNoEmitWorker(subScenario, aTsContent, ["--b", "/src/tsconfig.json", "-v"]);
  verifyNoEmitWorker(`${subScenario} with incremental`, aTsContent, ["--b", "/src/tsconfig.json", "-v", "--incremental"]);
+ verifyNoEmitWorker(`${subScenario} with outFile`, aTsContent, ["--b", "/src/tsconfig.json", "-v"], { outFile: "../outFile.js" });
+ verifyNoEmitWorker(`${subScenario} with outFile with incremental`, aTsContent, ["--b", "/src/tsconfig.json", "-v", "--incremental"], { outFile: "../outFile.js" });
  }
 
  verifyNoEmit("syntax errors", `const a = "hello`);