feat(plugin): support after declarations

nestjs · Nov 28, 2020 · 9f5f107 · 9f5f107
1 parent 4bd55fe
commit 9f5f107
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 4 deletions.
diff --git a/lib/compiler/compiler.ts b/lib/compiler/compiler.ts
@@ -52,6 +52,9 @@ export class Compiler {
       : ((program as any) as ts.Program);
     const before = plugins.beforeHooks.map((hook) => hook(programRef));
     const after = plugins.afterHooks.map((hook) => hook(programRef));
+    const afterDeclarations = plugins.afterDeclarationsHooks.map((hook) =>
+      hook(programRef),
+    );
     const emitResult = program.emit(
       undefined,
       undefined,
@@ -60,7 +63,7 @@ export class Compiler {
       {
         before: before.concat(tsconfigPathsPlugin),
         after,
-        afterDeclarations: [],
+        afterDeclarations,
       },
     );
 

diff --git a/lib/compiler/defaults/webpack-defaults.ts b/lib/compiler/defaults/webpack-defaults.ts
@@ -35,6 +35,9 @@ export const webpackDefaultsFactory = (
               getCustomTransformers: (program: any) => ({
                 before: plugins.beforeHooks.map((hook) => hook(program)),
                 after: plugins.afterHooks.map((hook) => hook(program)),
+                afterDeclaratqions: plugins.afterDeclarationsHooks.map((hook) =>
+                  hook(program),
+                ),
               }),
             },
           },
@@ -92,6 +95,8 @@ export const webpackDefaultsFactory = (
 function isAnyPluginRegistered(plugins: MultiNestCompilerPlugins) {
   return (
     (plugins.afterHooks && plugins.afterHooks.length > 0) ||
-    (plugins.beforeHooks && plugins.beforeHooks.length > 0)
+    (plugins.beforeHooks && plugins.beforeHooks.length > 0) ||
+    (plugins.afterDeclarationsHooks &&
+      plugins.afterDeclarationsHooks.length > 0)
   );
 }
diff --git a/lib/compiler/plugins-loader.ts b/lib/compiler/plugins-loader.ts
@@ -16,11 +16,16 @@ interface PluginAndOptions {
 export interface NestCompilerPlugin {
   before?: (options?: Record<string, any>, program?: ts.Program) => Transformer;
   after?: (options?: Record<string, any>, program?: ts.Program) => Transformer;
+  afterDeclarations?: (
+    options?: Record<string, any>,
+    program?: ts.Program,
+  ) => Transformer;
 }
 
 export interface MultiNestCompilerPlugins {
   beforeHooks: Array<(program?: ts.Program) => Transformer>;
   afterHooks: Array<(program?: ts.Program) => Transformer>;
+  afterDeclarationsHooks: Array<(program?: ts.Program) => Transformer>;
 }
 
 export class PluginsLoader {
@@ -52,8 +57,9 @@ export class PluginsLoader {
     });
     const beforeHooks: MultiNestCompilerPlugins['afterHooks'] = [];
     const afterHooks: MultiNestCompilerPlugins['beforeHooks'] = [];
+    const afterDeclarationsHooks: MultiNestCompilerPlugins['afterDeclarationsHooks'] = [];
     pluginRefs.forEach((plugin, index) => {
-      if (!plugin.before && !plugin.after) {
+      if (!plugin.before && !plugin.after && !plugin.afterDeclarations) {
         throw new Error(CLI_ERRORS.WRONG_PLUGIN(pluginNames[index]));
       }
       const options = isObject(plugins[index])
@@ -62,10 +68,15 @@ export class PluginsLoader {
       plugin.before &&
         beforeHooks.push(plugin.before.bind(plugin.before, options));
       plugin.after && afterHooks.push(plugin.after.bind(plugin.after, options));
+      plugin.afterDeclarations &&
+        afterDeclarationsHooks.push(
+          plugin.afterDeclarations.bind(plugin.afterDeclarations, options),
+        );
     });
     return {
       beforeHooks,
       afterHooks,
+      afterDeclarationsHooks,
     };
   }
 }
diff --git a/lib/compiler/watch-compiler.ts b/lib/compiler/watch-compiler.ts
@@ -92,10 +92,16 @@ export class WatchCompiler {
         const after = plugins.afterHooks.map((hook) =>
           hook(program.getProgram()),
         );
+        const afterDeclarations = plugins.afterDeclarationsHooks.map((hook) =>
+          hook(program.getProgram()),
+        );
         before.unshift(tsconfigPathsPlugin);
 
         transforms.before = before.concat(transforms.before || []);
         transforms.after = after.concat(transforms.after || []);
+        transforms.afterDeclarations = afterDeclarations.concat(
+          transforms.afterDeclarations || [],
+        );
 
         return origProgramEmit(
           targetSourceFile,

diff --git a/lib/ui/errors.ts b/lib/ui/errors.ts
@@ -4,5 +4,5 @@ export const CLI_ERRORS = {
   MISSING_TYPESCRIPT: (path: string) =>
     `Could not find TypeScript configuration file "${path}". Please, ensure that you are running this command in the appropriate directory (inside Nest workspace).`,
   WRONG_PLUGIN: (name: string) =>
-    `The "${name}" plugin is not compatible with Nest CLI. Neither "after()" nor "before()" function have been provided.`,
+    `The "${name}" plugin is not compatible with Nest CLI. Neither "after()" nor "before()" nor "afterDeclarations()" function have been provided.`,
 };