Add SolutionBuilderHostBase.getCustomTransformers to be used when emi…

…tting. (#44496) This allows not having to specify the transformers during normal watch scneario Builds on top of #43984
microsoft · Jun 16, 2021 · 6d8fd79 · 6d8fd79
1 parent 14231af
commit 6d8fd79
Show file tree

Hide file tree

Showing 6 changed files with 505 additions and 3 deletions.
diff --git a/src/compiler/tsbuildPublic.ts b/src/compiler/tsbuildPublic.ts
@@ -85,6 +85,7 @@ namespace ts {
          * writeFileCallback
          */
         writeFile?(path: string, data: string, writeByteOrderMark?: boolean): void;
+        getCustomTransformers?: (project: string) => CustomTransformers | undefined;
 
         getModifiedTime(fileName: string): Date | undefined;
         setModifiedTime(fileName: string, date: Date): void;
@@ -785,7 +786,7 @@ namespace ts {
                 emit: (targetSourceFile, writeFile, cancellationToken, emitOnlyDtsFiles, customTransformers) => {
                     if (targetSourceFile || emitOnlyDtsFiles) {
                         return withProgramOrUndefined(
-                            program => program.emit(targetSourceFile, writeFile, cancellationToken, emitOnlyDtsFiles, customTransformers)
+                            program => program.emit(targetSourceFile, writeFile, cancellationToken, emitOnlyDtsFiles, customTransformers || state.host.getCustomTransformers?.(project))
                         );
                     }
                     executeSteps(BuildStep.SemanticDiagnostics, cancellationToken);
@@ -921,7 +922,7 @@ namespace ts {
                 (name, text, writeByteOrderMark) => outputFiles.push({ name, text, writeByteOrderMark }),
                 cancellationToken,
                 /*emitOnlyDts*/ false,
-                customTransformers
+                customTransformers || state.host.getCustomTransformers?.(project)
             );
             // Don't emit .d.ts if there are decl file errors
             if (declDiagnostics) {
@@ -1060,7 +1061,7 @@ namespace ts {
                     const refName = resolveProjectName(state, ref.path);
                     return parseConfigFile(state, refName, toResolvedConfigFilePath(state, refName));
                 },
-                customTransformers
+                customTransformers || state.host.getCustomTransformers?.(project)
             );
 
             if (isString(outputFiles)) {

diff --git a/src/testRunner/tsconfig.json b/src/testRunner/tsconfig.json
@@ -137,6 +137,7 @@
         "unittests/tsbuild/transitiveReferences.ts",
         "unittests/tsbuild/watchEnvironment.ts",
         "unittests/tsbuild/watchMode.ts",
+        "unittests/tsbuildWatch/publicApi.ts",
         "unittests/tsc/composite.ts",
         "unittests/tsc/declarationEmit.ts",
         "unittests/tsc/incremental.ts",

diff --git a/src/testRunner/unittests/tsbuildWatch/publicApi.ts b/src/testRunner/unittests/tsbuildWatch/publicApi.ts
@@ -0,0 +1,115 @@
+namespace ts.tscWatch {
+    it("unittests:: tsbuildWatch:: watchMode:: Public API with custom transformers", () => {
+        const solution: File = {
+            path: `${projectRoot}/tsconfig.json`,
+            content: JSON.stringify({
+                references: [
+                    { path: "./shared/tsconfig.json" },
+                    { path: "./webpack/tsconfig.json" }
+                ],
+                files: []
+            })
+        };
+        const sharedConfig: File = {
+            path: `${projectRoot}/shared/tsconfig.json`,
+            content: JSON.stringify({
+                compilerOptions: { composite: true },
+            })
+        };
+        const sharedIndex: File = {
+            path: `${projectRoot}/shared/index.ts`,
+            content: `export function f1() { }
+export class c { }
+export enum e { }
+// leading
+export function f2() { } // trailing`
+        };
+        const webpackConfig: File = {
+            path: `${projectRoot}/webpack/tsconfig.json`,
+            content: JSON.stringify({
+                compilerOptions: { composite: true, },
+                references: [{ path: "../shared/tsconfig.json" }]
+            })
+        };
+        const webpackIndex: File = {
+            path: `${projectRoot}/webpack/index.ts`,
+            content: `export function f2() { }
+export class c2 { }
+export enum e2 { }
+// leading
+export function f22() { } // trailing`
+        };
+        const commandLineArgs = ["--b", "--w"];
+        const { sys, baseline, oldSnap } = createBaseline(createWatchedSystem([libFile, solution, sharedConfig, sharedIndex, webpackConfig, webpackIndex], { currentDirectory: projectRoot }));
+        const { cb, getPrograms } = commandLineCallbacks(sys);
+        const buildHost = createSolutionBuilderWithWatchHost(
+            sys,
+            /*createProgram*/ undefined,
+            createDiagnosticReporter(sys, /*pretty*/ true),
+            createBuilderStatusReporter(sys, /*pretty*/ true),
+            createWatchStatusReporter(sys, /*pretty*/ true)
+        );
+        buildHost.afterProgramEmitAndDiagnostics = cb;
+        buildHost.afterEmitBundle = cb;
+        buildHost.getCustomTransformers = getCustomTransformers;
+        const builder = createSolutionBuilderWithWatch(buildHost, [solution.path], { verbose: true });
+        builder.build();
+        runWatchBaseline({
+            scenario: "publicApi",
+            subScenario: "with custom transformers",
+            commandLineArgs,
+            sys,
+            baseline,
+            oldSnap,
+            getPrograms,
+            changes: [
+                {
+                    caption: "change to shared",
+                    change: sys => sys.prependFile(sharedIndex.path, "export function fooBar() {}"),
+                    timeouts: sys => {
+                        sys.checkTimeoutQueueLengthAndRun(1); // Shared
+                        sys.checkTimeoutQueueLengthAndRun(1); // webpack
+                        sys.checkTimeoutQueueLengthAndRun(1); // solution
+                        sys.checkTimeoutQueueLength(0);
+                    }
+                }
+            ],
+            watchOrSolution: builder
+        });
+
+        function getCustomTransformers(project: string): CustomTransformers {
+            const before: TransformerFactory<SourceFile> = context => {
+                return file => visitEachChild(file, visit, context);
+                function visit(node: Node): VisitResult<Node> {
+                    switch (node.kind) {
+                        case SyntaxKind.FunctionDeclaration:
+                            return visitFunction(node as FunctionDeclaration);
+                        default:
+                            return visitEachChild(node, visit, context);
+                    }
+                }
+                function visitFunction(node: FunctionDeclaration) {
+                    addSyntheticLeadingComment(node, SyntaxKind.MultiLineCommentTrivia, `@before${project}`, /*hasTrailingNewLine*/ true);
+                    return node;
+                }
+            };
+
+            const after: TransformerFactory<SourceFile> = context => {
+                return file => visitEachChild(file, visit, context);
+                function visit(node: Node): VisitResult<Node> {
+                    switch (node.kind) {
+                        case SyntaxKind.VariableStatement:
+                            return visitVariableStatement(node as VariableStatement);
+                        default:
+                            return visitEachChild(node, visit, context);
+                    }
+                }
+                function visitVariableStatement(node: VariableStatement) {
+                    addSyntheticLeadingComment(node, SyntaxKind.SingleLineCommentTrivia, `@after${project}`);
+                    return node;
+                }
+            };
+            return { before: [before], after: [after] };
+        }
+    });
+}
diff --git a/tests/baselines/reference/api/tsserverlibrary.d.ts b/tests/baselines/reference/api/tsserverlibrary.d.ts
@@ -5205,6 +5205,7 @@ declare namespace ts {
          * writeFileCallback
          */
         writeFile?(path: string, data: string, writeByteOrderMark?: boolean): void;
+        getCustomTransformers?: (project: string) => CustomTransformers | undefined;
         getModifiedTime(fileName: string): Date | undefined;
         setModifiedTime(fileName: string, date: Date): void;
         deleteFile(fileName: string): void;

diff --git a/tests/baselines/reference/api/typescript.d.ts b/tests/baselines/reference/api/typescript.d.ts
@@ -5205,6 +5205,7 @@ declare namespace ts {
          * writeFileCallback
          */
         writeFile?(path: string, data: string, writeByteOrderMark?: boolean): void;
+        getCustomTransformers?: (project: string) => CustomTransformers | undefined;
         getModifiedTime(fileName: string): Date | undefined;
         setModifiedTime(fileName: string, date: Date): void;
         deleteFile(fileName: string): void;