@catladder/cli 1.103.0 → 1.104.0

package/package.json

@@ -24,7 +24,7 @@
     "node": ">=12.0.0"
   },
   "devDependencies": {
-    "@catladder/pipeline": "1.103.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.103.0"
+  "version": "1.104.0"
 }

package/src/apps/catenv/catenv.ts

@@ -2,6 +2,7 @@ import { getProjectConfig } from "../../config/getProjectConfig";
 import { printVariables } from "./printVariables";
 import type { Choice } from "./types";
 import { writeDotEnvFiles } from "./writeDotEnvFiles";
+import { writeDTsFiles } from "./writeEnvDTs";
 
 export default async (choice?: Choice) => {
   const config = await getProjectConfig();
@@ -12,4 +13,6 @@ export default async (choice?: Choice) => {
   await printVariables(config, choice);
 
   await writeDotEnvFiles(config, choice);
+
+  await writeDTsFiles(config, choice);
 };

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")}
+    }
+  }
+}
+`;
+}