@catladder/cli 3.17.1 → 3.19.0

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "3.17.1",
+  "version": "3.19.0",
   "scripts": {
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix",

package/src/apps/catenv/catenv.ts

@@ -3,7 +3,11 @@ import { printVariables } from "./printVariables";
 import type { Choice } from "./types";
 import { writeDotEnvFiles } from "./writeDotEnvFiles";
 import { writeDTsFiles } from "./writeEnvDTs";
-import { generatePipelineFiles } from "@catladder/pipeline";
+import {
+  FileWriter,
+  createCatenvContext,
+  generatePipelineFiles,
+} from "@catladder/pipeline";
 
 export default async (choice?: Choice) => {
   const config = await getProjectConfig();
@@ -11,12 +15,14 @@ export default async (choice?: Choice) => {
     return;
   }
 
+  const context = createCatenvContext(config);
+
   await Promise.all([
-    generatePipelineFiles(config, config.pipelineType ?? "gitlab"),
-    writeDotEnvFiles(config, choice),
+    generatePipelineFiles(context, config.pipelineType ?? "gitlab"),
+    writeDotEnvFiles(context, choice),
 
-    writeDTsFiles(config, choice),
+    writeDTsFiles(context, choice),
 
-    printVariables(config, choice),
+    printVariables(context, choice),
   ]);
 };

package/src/apps/catenv/printVariables.ts

@@ -1,4 +1,4 @@
-import type { Config } from "@catladder/pipeline";
+import type { CatenvContext, Config } from "@catladder/pipeline";
 import { getEnvVarsResolved } from "../../config/getProjectConfig";
 import type { Choice } from "./types";
 import {
@@ -48,8 +48,11 @@ const getAllVariablesToPrint = async (config: Config, choice?: Choice) => {
   }
 };
 
-export const printVariables = async (config: Config, choice?: Choice) => {
-  const variables = await getAllVariablesToPrint(config, choice);
+export const printVariables = async (
+  context: CatenvContext,
+  choice?: Choice,
+) => {
+  const variables = await getAllVariablesToPrint(context.config, choice);
 
   console.log(makeExportKeyValuestring(variables));
 };

package/src/apps/catenv/writeDotEnvFiles.ts

@@ -1,4 +1,3 @@
-import { writeGeneratedFile, type Config } from "@catladder/pipeline";
 import { join } from "path";
 import { getEnvVarsResolved } from "../../config/getProjectConfig";
 import { getGitRoot } from "../../utils/projects";
@@ -8,14 +7,20 @@ import {
   getCurrentComponentAndEnvFromChoice,
   makeKeyValueString,
 } from "./utils";
+import type { CatenvContext } from "@catladder/pipeline";
 
-export const writeDotEnvFiles = async (config: Config, choice?: Choice) => {
+export const writeDotEnvFiles = async (
+  context: CatenvContext,
+  choice?: Choice,
+) => {
   const { env, currentComponent } = await getCurrentComponentAndEnvFromChoice(
-    config,
+    context.config,
     choice,
   );
 
-  const componentsWithEnabledDotEnvWrite = Object.entries(config.components)
+  const componentsWithEnabledDotEnvWrite = Object.entries(
+    context.config.components,
+  )
     .filter(([, component]) => component?.dotEnv ?? true) // when set to true or "local"
     .map(([componentName]) => componentName);
 
@@ -29,11 +34,19 @@ export const writeDotEnvFiles = async (config: Config, choice?: Choice) => {
   for (const componentName of componentsToActuallyWriteDotEnvNow) {
     const variables = await getEnvVarsResolved(null, env, componentName);
     delete variables["_ALL_ENV_VAR_KEYS"];
-    const componentDir = getComponentFullPath(gitRoot, config, componentName);
+    const componentDir = getComponentFullPath(
+      gitRoot,
+      context.config,
+      componentName,
+    );
     const filePath = join(componentDir, ".env");
 
-    await writeGeneratedFile(filePath, makeKeyValueString(variables), {
-      commentChar: "#",
-    });
+    await context.fileWriter.writeGeneratedFile(
+      filePath,
+      makeKeyValueString(variables),
+      {
+        commentChar: "#",
+      },
+    );
   }
 };

package/src/apps/catenv/writeEnvDTs.ts

@@ -1,4 +1,4 @@
-import { writeGeneratedFile, type Config } from "@catladder/pipeline";
+import type { CatenvContext } from "@catladder/pipeline";
 import { join } from "path";
 import { getEnvironment } from "../../config/getProjectConfig";
 import { getGitRoot } from "../../utils/projects";
@@ -8,13 +8,18 @@ import {
   getCurrentComponentAndEnvFromChoice,
 } from "./utils";
 
-export const writeDTsFiles = async (config: Config, choice?: Choice) => {
+export const writeDTsFiles = async (
+  context: CatenvContext,
+  choice?: Choice,
+) => {
   const { env, currentComponent } = await getCurrentComponentAndEnvFromChoice(
-    config,
+    context.config,
     choice,
   );
 
-  const componentsWithEnabledEnvDTsWrite = Object.entries(config.components)
+  const componentsWithEnabledEnvDTsWrite = Object.entries(
+    context.config.components,
+  )
     .filter(([, component]) => component?.envDTs ?? true)
     .map(([componentName]) => componentName);
 
@@ -29,9 +34,13 @@ export const writeDTsFiles = async (config: Config, choice?: Choice) => {
     const envNames = await getEnvsForDTs(env, componentName);
     const envDTsContent = createEnvDTsContent(envNames);
 
-    const componentDir = getComponentFullPath(gitRoot, config, componentName);
+    const componentDir = getComponentFullPath(
+      gitRoot,
+      context.config,
+      componentName,
+    );
     const filePath = join(componentDir, "env.d.ts");
-    await writeGeneratedFile(filePath, envDTsContent, {
+    await context.fileWriter.writeGeneratedFile(filePath, envDTsContent, {
       commentChar: "//",
     });
   }

package/src/apps/cli/commands/project/setup/index.ts

@@ -4,6 +4,7 @@ import { setupAccessTokens } from "./setupAccessTokens";
 import { setupContext } from "./setupContext";
 import { setupTopic } from "./setupTopic";
 import { setupAgents } from "./setupAgents";
+import { logSection } from "./logSection";
 
 export const setupProject = async (
   instance: CommandInstance,
@@ -14,12 +15,16 @@ export const setupProject = async (
   allContext.forEach((context) => {
     instance.log(` - ${context.name}:${context.env}`);
   });
+
+  await logSection(instance, "base setup", async () => {
+    await setupAccessTokens(instance);
+    await setupTopic(instance);
+    await setupAgents(instance);
+  });
   for (const context of allContext) {
     await setupContext(instance, context);
   }
-  await setupAccessTokens(instance);
-  await setupTopic(instance);
-  await setupAgents(instance);
+
   instance.log("");
   instance.log("gitlab is ready! 🥂");
   instance.log("\n");

package/src/apps/cli/commands/project/setup/logSection.ts

@@ -0,0 +1,22 @@
+import type { CommandInstance } from "vorpal";
+
+export const logSection = async (
+  instance: CommandInstance,
+  title: string,
+  work: () => Promise<void>,
+) => {
+  instance.log("");
+  instance.log(
+    "==================================================================================",
+  );
+  instance.log("🐱 🔧 " + title + "...");
+  instance.log("");
+  await work();
+  instance.log("");
+  instance.log("✅    " + title + " done!");
+  instance.log("");
+  instance.log(
+    "==================================================================================",
+  );
+  instance.log("");
+};

package/src/apps/cli/commands/project/setup/setupContext.ts

@@ -4,29 +4,24 @@ import type { CommandInstance } from "vorpal";
 import { setupCloudRun } from "./setupCloudRun";
 
 import { setupKubernetes } from "./setupKubernetes";
+import { logSection } from "./logSection";
 
 export const setupContext = async (
   instance: CommandInstance,
   context: ComponentContext,
 ) => {
-  instance.log("");
-  instance.log(
-    "==================================================================================",
-  );
-
-  instance.log("🐱 🔧 setting up " + context.env + ":" + context.name + "...");
-  instance.log("");
-  if (isOfDeployType(context.deploy?.config, "google-cloudrun")) {
-    await setupCloudRun(instance, context);
-  }
-
-  const deployConfig = context.deploy?.config;
-  if (isOfDeployType(deployConfig, "kubernetes")) {
-    await setupKubernetes(instance, context);
-  }
+  await logSection(
+    instance,
+    "setting up " + context.env + ":" + context.name,
+    async () => {
+      if (isOfDeployType(context.deploy?.config, "google-cloudrun")) {
+        await setupCloudRun(instance, context);
+      }
 
-  instance.log("");
-  instance.log("✅ " + context.env + ":" + context.name + " done!");
-
-  instance.log("");
+      const deployConfig = context.deploy?.config;
+      if (isOfDeployType(deployConfig, "kubernetes")) {
+        await setupKubernetes(instance, context);
+      }
+    },
+  );
 };