@catladder/pipeline 3.18.0 → 3.19.0

package/src/catenv/index.ts

@@ -0,0 +1,14 @@
+import type { Config } from "../types";
+import { FileWriter } from "../utils/writeFiles";
+
+export type CatenvContext = {
+  config: Config;
+  fileWriter: FileWriter;
+};
+
+export const createCatenvContext = (config: Config): CatenvContext => {
+  return {
+    config,
+    fileWriter: FileWriter.create(config),
+  };
+};

package/src/catladder-gitlab.ts

@@ -1,10 +1,13 @@
 import { readConfig } from "./config";
 import { generatePipelineFiles } from "./pipeline/generatePipelineFiles";
+import { createCatenvContext } from "./catenv";
 
 readConfig().then(async (result) => {
   if (!result?.config) {
     throw new Error("no catladder config found");
   }
 
-  await generatePipelineFiles(result.config, "gitlab");
+  const context = createCatenvContext(result.config);
+
+  await generatePipelineFiles(context, "gitlab");
 });

package/src/index.ts

@@ -9,3 +9,4 @@ export * from "./deploy";
 export * from "./utils/writeFiles";
 export * from "./variables/VariableValue";
 export * from "./bash";
+export * from "./catenv";

package/src/pipeline/generatePipelineFiles.ts

@@ -1,9 +1,10 @@
 import { mkdir, rm } from "fs/promises";
 import { dirname } from "path";
 import type { Config, GitlabJobDef, PipelineType } from "../types";
-import { writeYamlfile } from "../utils/writeFiles";
+
 import { createMainPipeline } from "./createMainPipeline";
 import { sortGitLabJobDefProps } from "./gitlab/sortGitLabJobDefProps";
+import type { CatenvContext } from "../catenv";
 
 const CATLADDER_GENERATED_FOLDER = ".catladder-generated";
 
@@ -14,13 +15,13 @@ type YamlFile = {
   content: Record<string, unknown>;
 };
 export async function generatePipelineFiles<T extends PipelineType>(
-  config: Config,
+  context: CatenvContext,
   pipelineType: T,
 ) {
   if (pipelineType !== "gitlab") {
     throw new Error("Pipeline type not supported");
   }
-  const includes = await getGitlabPipelineIncludes(config);
+  const includes = await getGitlabPipelineIncludes(context.config);
 
   const mainFile: YamlFile = {
     path: ".gitlab-ci.yml",
@@ -37,7 +38,7 @@ export async function generatePipelineFiles<T extends PipelineType>(
   await Promise.all(
     files.map(async ({ path, content }) => {
       await mkdir(dirname(path), { recursive: true });
-      await writeYamlfile(path, content);
+      await context.fileWriter.writeYamlfile(path, content);
     }),
   );
 }

package/src/types/config.ts

@@ -6,6 +6,7 @@ import type { ComponentContext } from "./context";
 import type { PartialDeep } from "./utils";
 import type { PipelineType, WorkspaceBuildConfig } from "..";
 import type { AgentConfig } from "./agent";
+import type { Hooks } from "./hooks";
 
 export const ALL_PIPELINE_TRIGGERS = [
   "mainBranch",
@@ -231,4 +232,9 @@ export type Config<C extends ConfigProps = never> = {
    * additional vars only for the runner in all jobs.
    */
   runnerVariables?: Record<string, string>;
+
+  /**
+   * hook into catladder generation
+   */
+  hooks?: Hooks;
 };

package/src/types/hooks.ts

@@ -0,0 +1,29 @@
+export type FileHookContext = {
+  /**
+   * the filename of the file
+   */
+  filename: string;
+  /**
+   * the extension of the file
+   */
+  extension: string;
+  /**
+   * the path of the file
+   */
+  path: string;
+
+  /**
+   * the content of the file
+   */
+  content: string;
+};
+
+type MaybePromise<T> = T | Promise<T>;
+export type Hooks = {
+  /**
+   * transform the file before it is written. If undefined is returned, the file is not modified
+   */
+  transformFileBeforeWrite: (
+    fileHookContext: FileHookContext,
+  ) => MaybePromise<string | undefined>;
+};

package/src/utils/writeFiles.ts

@@ -1,35 +1,9 @@
 import { writeFile } from "fs/promises";
 import { stringify } from "yaml";
+import type { Config } from "../types";
 
-export const getAutoGeneratedHeader = (commentChar: string) => {
-  return [
-    "-------------------------------------------------",
-    `🐱 🔨 This file is generated by catladder`,
-    `🚨 Do not edit this file manually 🚨`,
-    "-------------------------------------------------",
-  ]
-    .map((line) => `${commentChar} ${line}`)
-    .join("\n")
-    .concat("\n");
-};
-
-export const writeGeneratedFile = async (
-  path: string,
-  content: string,
-  {
-    commentChar,
-  }: {
-    commentChar: string;
-  },
-) => {
-  await writeFile(
-    path,
-    // need to spread out the jobs, forgot why
-    [getAutoGeneratedHeader(commentChar), content].join("\n"),
-    {
-      encoding: "utf-8",
-    },
-  );
+type WriteFileOptions = {
+  commentChar: string;
 };
 
 type StringifyOptions = Exclude<
@@ -45,8 +19,58 @@ export const yamlStringifyOptions: StringifyOptions = {
   singleQuote: true,
 };
 
-export const writeYamlfile = async (path: string, data: any) => {
-  await writeGeneratedFile(path, stringify(data, yamlStringifyOptions), {
-    commentChar: "#",
-  });
-};
+export class FileWriter {
+  public static create(config: Config) {
+    return new FileWriter(config);
+  }
+
+  constructor(private readonly config: Config) {
+    this.config = config;
+  }
+
+  protected async writeTheFile(path: string, content: string) {
+    const transformedContent =
+      await this.config.hooks?.transformFileBeforeWrite({
+        filename: path,
+        content,
+        extension: path.split(".").pop() ?? "",
+        path,
+      });
+    await writeFile(path, transformedContent ?? content, {
+      encoding: "utf-8",
+    });
+  }
+
+  public async writeGeneratedFile(
+    path: string,
+    content: string,
+    options: WriteFileOptions,
+  ) {
+    await this.writeTheFile(
+      path,
+      [this.getAutoGeneratedHeader(options.commentChar), content].join("\n"),
+    );
+  }
+
+  public writeYamlfile(path: string, data: any) {
+    return this.writeGeneratedFile(
+      path,
+      stringify(data, yamlStringifyOptions),
+      {
+        commentChar: "#",
+      },
+    );
+  }
+
+  protected getAutoGeneratedHeader(commentChar: string) {
+    return [
+      "-------------------------------------------------",
+      `🐱 🔨 This file is generated by catladder`,
+      `🚨 Do not edit this file manually 🚨`,
+      "-------------------------------------------------",
+    ]
+      .map((line) => `${commentChar} ${line}`)
+      .join("\n")
+      .concat("\n");
+  }
+}