@catladder/cli 1.102.0 → 1.104.0

package/package.json

@@ -24,7 +24,7 @@
     "node": ">=12.0.0"
   },
   "devDependencies": {
-    "@catladder/pipeline": "1.102.0",
+    "@catladder/pipeline": "1.104.0",
     "@kubernetes/client-node": "^0.16.2",
     "@tsconfig/node14": "^1.0.1",
     "@types/common-tags": "^1.8.0",
@@ -57,5 +57,5 @@
     "typescript": "^4.5.4",
     "vorpal": "^1.12.0"
   },
-  "version": "1.102.0"
+  "version": "1.104.0"
 }

package/src/apps/catenv/catenv.ts

@@ -1,72 +1,18 @@
-import type { Config, ComponentConfig } from "@catladder/pipeline";
-import {
-  getEnvVarsResolved,
-  getProjectConfig,
-} from "../../config/getProjectConfig";
-import { getGitRoot } from "../../utils/projects";
-import { join } from "path";
-const getCurrentComponentName = async (
-  components: Record<string, ComponentConfig>
-) => {
-  const gitRoot = await getGitRoot();
-  const currentDir = process.cwd();
-  return Object.keys(components).find((c) =>
-    currentDir.startsWith(join(gitRoot, components[c].dir))
-  );
-};
-
-const sanitizeEnvVarName = (name: string) => name.replace(/[\s\-.]+/g, "_");
-
-const getAllVariablesToPrint = async (
-  config: Config,
-  choice?: {
-    env?: string;
-    componentName?: string;
-  }
-) => {
-  const env = choice?.env ?? "local";
-  const { components } = config;
-
-  const currentComponent =
-    choice?.componentName ?? (await getCurrentComponentName(components));
+import { getProjectConfig } from "../../config/getProjectConfig";
+import { printVariables } from "./printVariables";
+import type { Choice } from "./types";
+import { writeDotEnvFiles } from "./writeDotEnvFiles";
+import { writeDTsFiles } from "./writeEnvDTs";
 
-  let variables = {};
-  if (currentComponent) {
-    variables = await getEnvVarsResolved(null, env, currentComponent);
-  } else {
-    // when in a monorep and not in a subapp, merge all env vars.
-    // this is not 100% correct, but better than not exporting any vars at all
-    // so we also add prefixed variants
-    variables = await Object.keys(components).reduce(
-      async (acc, componentName) => {
-        const subappvars = await getEnvVarsResolved(null, env, componentName);
-        return {
-          ...(await acc),
-          ...subappvars,
-          // also add prefixed variants in case
-          ...Object.fromEntries(
-            Object.entries(subappvars).map(([key, value]) => [
-              `${sanitizeEnvVarName(componentName.toUpperCase())}_${key}`,
-              value,
-            ])
-          ),
-        };
-      },
-      {}
-    );
-  }
-  return variables;
-};
-export default async (choice?: { env?: string; componentName?: string }) => {
+export default async (choice?: Choice) => {
   const config = await getProjectConfig();
   if (!config) {
     return;
   }
-  const variables = await getAllVariablesToPrint(config, choice);
 
-  console.log(
-    Object.entries(variables)
-      .map(([key, value]) => `export ${key}='${value}'`)
-      .join("\n")
-  );
+  await printVariables(config, choice);
+
+  await writeDotEnvFiles(config, choice);
+
+  await writeDTsFiles(config, choice);
 };

package/src/apps/catenv/printVariables.ts

@@ -0,0 +1,51 @@
+import type { Config } from "@catladder/pipeline";
+import { getEnvVarsResolved } from "../../config/getProjectConfig";
+import type { Choice, Variables } from "./types";
+import {
+  getCurrentComponentAndEnvFromChoice,
+  makeKeyValueString,
+  sanitizeEnvVarName,
+} from "./utils";
+
+const getAllVariablesToPrint = async (config: Config, choice?: Choice) => {
+  const { env, currentComponent } = await getCurrentComponentAndEnvFromChoice(
+    config,
+    choice
+  );
+
+  let variables = {};
+  if (currentComponent) {
+    variables = await getEnvVarsResolved(null, env, currentComponent);
+  } else {
+    // when in a monorep and not in a subapp, merge all env vars.
+    // this is not 100% correct, but better than not exporting any vars at all
+    // so we also add prefixed variants
+    variables = await Object.keys(config.components).reduce(
+      async (acc, componentName) => {
+        const subappvars = await getEnvVarsResolved(null, env, componentName);
+        return {
+          ...(await acc),
+          ...subappvars,
+          // also add prefixed variants in case
+          ...Object.fromEntries(
+            Object.entries(subappvars).map(([key, value]) => [
+              `${sanitizeEnvVarName(componentName.toUpperCase())}_${key}`,
+              value,
+            ])
+          ),
+        };
+      },
+      {}
+    );
+  }
+  return variables;
+};
+
+export const printVariables = async (config: Config, choice?: Choice) => {
+  const variables = await getAllVariablesToPrint(config, choice);
+
+  console.log(makeExportKeyValuestring(variables));
+};
+
+const makeExportKeyValuestring = (variables: Variables) =>
+  makeKeyValueString(variables, "export ");

package/src/apps/catenv/types.ts

@@ -0,0 +1,6 @@
+export type Choice = {
+  env?: string;
+  componentName?: string;
+};
+
+export type Variables = Record<string, string>;

package/src/apps/catenv/utils.ts

@@ -0,0 +1,49 @@
+import type { Config } from "@catladder/pipeline";
+import { join } from "path";
+import { getGitRoot } from "../../utils/projects";
+import type { Choice, Variables } from "./types";
+export const getComponentFullPath = (
+  gitRoot: string,
+  config: Config,
+  componentName: string
+) => {
+  return join(gitRoot, config.components[componentName].dir);
+};
+const getCurrentComponentName = async (config: Config) => {
+  const gitRoot = await getGitRoot();
+  const currentDir = process.cwd();
+  return Object.keys(config.components).find((c) =>
+    currentDir.startsWith(getComponentFullPath(gitRoot, config, c))
+  );
+};
+
+export const getCurrentComponentAndEnvFromChoice = async (
+  config: Config,
+  choice?: Choice
+) => {
+  const env = choice?.env ?? "local";
+  const currentComponent =
+    choice?.componentName ?? (await getCurrentComponentName(config));
+
+  return {
+    currentComponent,
+    env,
+  };
+};
+
+export const makeKeyValueString = (variables: Variables, keyPrefix = "") =>
+  Object.entries(variables)
+    .map(([key, value]) => `${keyPrefix}${key}='${value}'`)
+    .join("\n");
+
+export const sanitizeMultiLine = (variables: Variables) => {
+  return Object.fromEntries(
+    Object.entries(variables).map(([key, value]) => [
+      key,
+      value.replaceAll("\n", "\\n"),
+    ])
+  );
+};
+
+export const sanitizeEnvVarName = (name: string) =>
+  name.replace(/[\s\-.]+/g, "_");

package/src/apps/catenv/writeDotEnvFiles.ts

@@ -0,0 +1,45 @@
+import type { Config } from "@catladder/pipeline";
+import { writeFile } from "fs-extra";
+import { join } from "path";
+import { getEnvVarsResolved } from "../../config/getProjectConfig";
+import { getGitRoot } from "../../utils/projects";
+import type { Choice } from "./types";
+import {
+  getComponentFullPath,
+  getCurrentComponentAndEnvFromChoice,
+  makeKeyValueString,
+  sanitizeMultiLine,
+} from "./utils";
+
+export const writeDotEnvFiles = async (config: Config, choice?: Choice) => {
+  const { env, currentComponent } = await getCurrentComponentAndEnvFromChoice(
+    config,
+    choice
+  );
+
+  // whether to print .dotenv is currentl configure on the "local" part of the env
+
+  const componentsWithEnabledDotEnvWrite = Object.entries(config.components)
+    .filter(([, component]) => component?.dotEnv)
+    .map(([componentName]) => componentName);
+
+  const componentsToActuallyWriteDotEnvNow = currentComponent
+    ? componentsWithEnabledDotEnvWrite.includes(currentComponent)
+      ? [currentComponent]
+      : []
+    : componentsWithEnabledDotEnvWrite;
+  const gitRoot = await getGitRoot();
+
+  for (const componentName of componentsToActuallyWriteDotEnvNow) {
+    const variables = await getEnvVarsResolved(null, env, componentName);
+    const componentDir = getComponentFullPath(gitRoot, config, componentName);
+    const filePath = join(componentDir, ".env");
+    // many .dotenv don't like multiline values, so we sanitize them here
+    const variablesSanitized = sanitizeMultiLine(variables);
+    await writeFile(
+      filePath,
+      "# automatically created by catladder. Do not modify!\n\n" +
+        makeKeyValueString(variablesSanitized)
+    );
+  }
+};

package/src/apps/catenv/writeEnvDTs.ts

@@ -0,0 +1,71 @@
+import type { Config } from "@catladder/pipeline";
+import { writeFile } from "fs-extra";
+import { join } from "path";
+import { getEnvironment } from "../../config/getProjectConfig";
+import { getGitRoot } from "../../utils/projects";
+import type { Choice } from "./types";
+import {
+  getComponentFullPath,
+  getCurrentComponentAndEnvFromChoice,
+} from "./utils";
+
+export const writeDTsFiles = async (config: Config, choice?: Choice) => {
+  const { env, currentComponent } = await getCurrentComponentAndEnvFromChoice(
+    config,
+    choice
+  );
+
+  const componentsWithEnabledEnvDTsWrite = Object.entries(config.components)
+    .filter(([, component]) => component?.envDTs)
+    .map(([componentName]) => componentName);
+
+  const componentsToActuallyWriteDotEnvNow = currentComponent
+    ? componentsWithEnabledEnvDTsWrite.includes(currentComponent)
+      ? [currentComponent]
+      : []
+    : componentsWithEnabledEnvDTsWrite;
+  const gitRoot = await getGitRoot();
+
+  for (const componentName of componentsToActuallyWriteDotEnvNow) {
+    const envNames = await getEnvsForDTs(env, componentName);
+    const envDTsContent = createEnvDTsContent(envNames);
+
+    const componentDir = getComponentFullPath(gitRoot, config, componentName);
+    const filePath = join(componentDir, "env.d.ts");
+    await writeFile(filePath, envDTsContent);
+  }
+};
+
+async function getEnvsForDTs(
+  env: string,
+  componentName: string
+): Promise<string[]> {
+  const environment = await getEnvironment(env, componentName);
+  const allEnvKeys = Object.keys(environment.envVars);
+  const hiddenEnvKeys = new Set(
+    environment.secretEnvVarKeys
+      .filter((s) => s.hidden)
+      .map((s) => s.key)
+      .concat(["_ALL_ENV_VAR_KEYS"])
+  );
+  const dTsEnvKeys = allEnvKeys.filter((k) => !hiddenEnvKeys.has(k));
+
+  return dTsEnvKeys;
+}
+
+function createEnvDTsContent(envNames: string[]) {
+  return `/* tslint:disable prettier/prettier */
+/* eslint-disable prettier/prettier */
+/* prettier-ignore */
+// automatically generated by catladder. Do not modify!
+export {}
+
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+${envNames.map((name) => `      ${name}: string`).join("\n")}
+    }
+  }
+}
+`;
+}

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "lib": ["es2020", "DOM"],
+    "lib": ["es2021", "DOM"],
     "module": "CommonJS",
     "declaration": true,
     "noImplicitAny": true,