@catladder/pipeline 3.20.2 → 3.21.1

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "3.20.2",
+  "version": "3.21.1",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables",

package/src/types/hooks.ts

@@ -1,17 +1,22 @@
-export type FileHookContext = {
+export type BaseHookContext = {
   /**
    * the filename of the file
    */
   filename: string;
-  /**
-   * the extension of the file
-   */
-  extension: string;
   /**
    * the path of the file
    */
   path: string;
 
+  /**
+   * the extension of the file
+   */
+  extension: string;
+};
+export type YamlHookContext = BaseHookContext & {
+  data: any;
+};
+export type FileHookContext = BaseHookContext & {
   /**
    * the content of the file
    */
@@ -23,7 +28,14 @@ export type Hooks = {
   /**
    * transform the file before it is written. If undefined is returned, the file is not modified
    */
-  transformFileBeforeWrite: (
+  transformFileBeforeWrite?: (
     fileHookContext: FileHookContext,
   ) => MaybePromise<string | undefined>;
+
+  /**
+   * transform the yaml before it is written. If undefined is returned, the yaml is not modified
+   */
+  transformYamlBeforeWrite?: (
+    fileHookContext: YamlHookContext,
+  ) => MaybePromise<any | undefined>;
 };

package/src/utils/writeFiles.ts

@@ -1,6 +1,7 @@
 import { writeFile } from "fs/promises";
 import { stringify } from "yaml";
 import type { Config } from "../types";
+import type { BaseHookContext } from "../types/hooks";
 
 type WriteFileOptions = {
   commentChar: string;
@@ -30,17 +31,24 @@ export class FileWriter {
 
   protected async writeTheFile(path: string, content: string) {
     const transformedContent =
-      await this.config.hooks?.transformFileBeforeWrite({
-        filename: path,
+      await this.config.hooks?.transformFileBeforeWrite?.({
+        ...(await this.getBaseHookContext(path)),
         content,
-        extension: path.split(".").pop() ?? "",
-        path,
       });
     await writeFile(path, transformedContent ?? content, {
       encoding: "utf-8",
     });
   }
 
+  protected async getBaseHookContext(path: string): Promise<BaseHookContext> {
+    const filename = path.split("/").pop() ?? "";
+    return {
+      filename,
+      path,
+      extension: path.split(".").pop() ?? "",
+    };
+  }
+
   public async writeGeneratedFile(
     path: string,
     content: string,
@@ -52,10 +60,16 @@ export class FileWriter {
     );
   }
 
-  public writeYamlfile(path: string, data: any) {
+  public async writeYamlfile(path: string, data: any) {
+    const dataTransformed = await this.config.hooks?.transformYamlBeforeWrite?.(
+      {
+        ...(await this.getBaseHookContext(path)),
+        data,
+      },
+    );
     return this.writeGeneratedFile(
       path,
-      stringify(data, yamlStringifyOptions),
+      stringify(dataTransformed ?? data, yamlStringifyOptions),
       {
         commentChar: "#",
       },