@catladder/cli 0.0.0-refactore-catenv-command-validates-argument-78d05852 → 0.0.0-reference-database-url-1befbbee

package/src/apps/catenv/writeEnvDTs.ts

@@ -1,5 +1,4 @@
-import type { Config } from "@catladder/pipeline";
-import { writeFile } from "fs-extra";
+import { writeGeneratedFile, type Config } from "@catladder/pipeline";
 import { join } from "path";
 import { getEnvironment } from "../../config/getProjectConfig";
 import { getGitRoot } from "../../utils/projects";
@@ -12,11 +11,11 @@ import {
 export const writeDTsFiles = async (config: Config, choice?: Choice) => {
   const { env, currentComponent } = await getCurrentComponentAndEnvFromChoice(
     config,
-    choice
+    choice,
   );
 
   const componentsWithEnabledEnvDTsWrite = Object.entries(config.components)
-    .filter(([, component]) => component?.envDTs)
+    .filter(([, component]) => component?.envDTs ?? true)
     .map(([componentName]) => componentName);
 
   const componentsToActuallyWriteEnvDts = currentComponent
@@ -32,13 +31,15 @@ export const writeDTsFiles = async (config: Config, choice?: Choice) => {
 
     const componentDir = getComponentFullPath(gitRoot, config, componentName);
     const filePath = join(componentDir, "env.d.ts");
-    await writeFile(filePath, envDTsContent);
+    await writeGeneratedFile(filePath, envDTsContent, {
+      commentChar: "//",
+    });
   }
 };
 
 async function getEnvsForDTs(
   env: string,
-  componentName: string
+  componentName: string,
 ): Promise<string[]> {
   const environment = await getEnvironment(env, componentName);
   const allEnvKeys = Object.keys(environment.envVars);
@@ -46,7 +47,7 @@ async function getEnvsForDTs(
     environment.secretEnvVarKeys
       .filter((s) => s.hidden)
       .map((s) => s.key)
-      .concat(["_ALL_ENV_VAR_KEYS"])
+      .concat(["_ALL_ENV_VAR_KEYS"]),
   );
   const dTsEnvKeys = allEnvKeys.filter((k) => !hiddenEnvKeys.has(k));
 
@@ -57,7 +58,7 @@ 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 {

package/src/apps/cli/cli.ts

@@ -10,11 +10,14 @@ import theStuffThatReallyMatters from "./commands/theStuffThatReallyMatters";
 
 import { verify } from "./verify";
 import { showProjectBanner } from "./commands/project/utils/showProjectBanner";
+import { boxWithAsci } from "../../utils/boxWithAscii";
 
 export default async () => {
   const vorpal = new Vorpal();
 
-  const welcomeMessage = `catladder 2022 😻 version ${packageInfos.version}`;
+  const welcomeMessage = boxWithAsci(
+    `catladder 😻 v${packageInfos.version} ✨`,
+  );
 
   vorpal
     .delimiter("catladder $") // emoji messes with cursor :-( https://github.com/dthree/vorpal/issues/332

package/src/apps/cli/commands/cloudSQL/commandRestoreDb.ts

@@ -7,7 +7,7 @@ export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "cloud-sql-restore-db",
-      "restore a db from one source to another target"
+      "restore a db from one source to another target",
     )
     .action(async function restoreDb() {
       const { sourceInstance } = await this.prompt({

package/src/apps/cli/commands/cloudSQL/index.ts

@@ -1,5 +1,4 @@
 import type Vorpal from "vorpal";
-//import commandInitProject from "./commandInitProject.old";
 
 import commandRestoreDb from "./commandRestoreDb";
 

package/src/apps/cli/commands/general/index.ts

@@ -3,7 +3,6 @@ import type Vorpal from "vorpal";
 import { getk8sApi } from "../../../../k8sApi";
 import { getCurrentContext } from "../../../../utils/cluster";
 import { logError } from "../../../../utils/log";
-import { syncBitwarden } from "../../../../utils/passwordstore";
 import {
   getAllRunningPortForwards,
   stopPortForward,
@@ -18,7 +17,7 @@ const getAllNamespaces = memoizee(
     const res = await k8sApi.listNamespace();
     return res.body.items;
   },
-  { maxAge: 30000, promise: true }
+  { maxAge: 30000, promise: true },
 );
 
 export const getAllNamespacesNames = async () => {
@@ -47,11 +46,6 @@ export default async (vorpal: Vorpal) => {
       this.log(res.body.items.map((n) => n.metadata.name).join("\n"));
     });
 
-  vorpal.command("bw-sync", "force sync bitwarden").action(async function () {
-    await syncBitwarden(true);
-    this.log("done");
-  });
-
   vorpal
     .command("kube-list-pods <namespace>", "list all pods of namespace")
     .autocomplete(namespaceAutoCompletion)
@@ -71,7 +65,7 @@ export default async (vorpal: Vorpal) => {
   vorpal
     .command(
       "kube-get-shell <namespace>",
-      "get a shell to a pod in the environment"
+      "get a shell to a pod in the environment",
     )
     .autocomplete(namespaceAutoCompletion)
     .action(async function ({ namespace }) {

package/src/apps/cli/commands/general/namespaceAutoCompletion.ts

@@ -3,5 +3,5 @@ export const namespaceAutoCompletion = {
   async data() {
     const namespaces = await getAllNamespacesNames();
     return namespaces;
-  }
+  },
 };

package/src/apps/cli/commands/mongodb/projectMongoDestroyMember.ts

@@ -10,22 +10,22 @@ import { getMongoDbPodsWithReplInfo } from "./utils";
 const removeFinalizer = async (
   namespace: string,
   type: "pod" | "pv" | "pvc",
-  name: string
+  name: string,
 ) =>
   exec(
-    `kubectl patch --namespace ${namespace} ${type} ${name} -p '{"metadata":{"finalizers":null}}'`
+    `kubectl patch --namespace ${namespace} ${type} ${name} -p '{"metadata":{"finalizers":null}}'`,
   );
 
 const deleteResource = async (
   namespace: string,
   type: "pod" | "pv" | "pvc",
-  name: string
+  name: string,
 ) => exec(`kubectl delete --namespace ${namespace} ${type} ${name}`);
 
 const removeFinalizerAndDelete = async (
   namespace: string,
   type: "pod" | "pv" | "pvc",
-  name: string
+  name: string,
 ) => {
   return Promise.all([
     removeFinalizer(namespace, type, name),
@@ -36,29 +36,29 @@ export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-mongo-destroy-member <envComponent>",
-      "DESTROY a member of a replicaset in order to reinitialize it"
+      "DESTROY a member of a replicaset in order to reinitialize it",
     )
     .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
       await ensureCluster.call(this, envComponent);
       this.log(
-        "this command tries to delete a (secondary) member of the replicaset, it's persistent volume claim (pvc) and the volume"
+        "this command tries to delete a (secondary) member of the replicaset, it's persistent volume claim (pvc) and the volume",
       );
       this.log("");
       this.log(
-        "this is useful, if you update the stateful set with new volume configuration (different size or storage class)"
+        "this is useful, if you update the stateful set with new volume configuration (different size or storage class)",
       );
       this.log("");
       this.log(
-        "Kubernetes will usually recreate the missing member with the updated config and mongodb will start synchronizing the new member."
+        "Kubernetes will usually recreate the missing member with the updated config and mongodb will start synchronizing the new member.",
       );
       this.log("");
       this.log(
-        "This works without downtime, but should be done when load on the db is low. Also it has not been tested with large dbs (> 10gi)"
+        "This works without downtime, but should be done when load on the db is low. Also it has not been tested with large dbs (> 10gi)",
       );
       this.log("");
       this.log(
-        "Deleting the volume and claim often stuck, just wait or cancel and restart."
+        "Deleting the volume and claim often stuck, just wait or cancel and restart.",
       );
       this.log("");
       const { understood } = await this.prompt({
@@ -96,7 +96,7 @@ export default async (vorpal: Vorpal) =>
       ).podName;
 
       const thePvc = pvcs.find(
-        (pvc) => pvc.metadata.name === `datadir-${podName}`
+        (pvc) => pvc.metadata.name === `datadir-${podName}`,
       );
       if (!thePvc) {
         logError(this, `sorry, no pvc found for ${podName}`);

package/src/apps/cli/commands/mongodb/projectMongoGetShell.ts

@@ -12,15 +12,14 @@ export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-mongo-get-shell <envComponent>",
-      "get a shell to a mongodb in the environment"
+      "get a shell to a mongodb in the environment",
     )
     .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
       await ensureCluster.call(this, envComponent);
       const namespace = await getProjectNamespace(envComponent);
-      const podNames = await getProjectMongodbAllPodsSortedWithLabel(
-        envComponent
-      );
+      const podNames =
+        await getProjectMongodbAllPodsSortedWithLabel(envComponent);
       if (podNames.length === 0) {
         logError(this, "sorry, no pods found");
         return;

package/src/apps/cli/commands/mongodb/projectMongoPortForward.ts

@@ -15,15 +15,14 @@ export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-mongo-port-forward <envComponent>",
-      "port foward to a mongodb"
+      "port foward to a mongodb",
     )
     .autocomplete(await envAndComponents())
     .action(async function ({ envComponent }) {
       await ensureCluster.call(this, envComponent);
       const namespace = await getProjectNamespace(envComponent);
-      const podNames = await getProjectMongodbAllPodsSortedWithLabel(
-        envComponent
-      );
+      const podNames =
+        await getProjectMongodbAllPodsSortedWithLabel(envComponent);
       if (podNames.length === 0) {
         logError(this, "sorry, no pods found");
         return;

package/src/apps/cli/commands/mongodb/utils/index.ts

@@ -7,7 +7,7 @@ const filterMongoDbs = (podNames: string[]) =>
     (name) =>
       name.includes("mongodb") &&
       !name.includes("mongodb-backup") &&
-      !name.includes("arbiter")
+      !name.includes("arbiter"),
   );
 
 export const getProjectMongodbAllPods = async (envComponent: string) =>
@@ -32,7 +32,7 @@ export const getMongodbShell = async (namespace: string, podName: string) => {
 export const executeMongodbCommand = async (
   namespace: string,
   podName: string,
-  mongoCommand: string
+  mongoCommand: string,
 ) => {
   const fullCommand = `kubectl exec -it ${podName} --namespace ${namespace} -- mongo --quiet --eval "JSON.stringify(${mongoCommand})"`;
   const { stdout } = await exec(fullCommand, {
@@ -50,7 +50,7 @@ export const podIsMaster = async (namespace: string, podName: string) => {
     const result = await executeMongodbCommand(
       namespace,
       podName,
-      "db.isMaster()"
+      "db.isMaster()",
     );
 
     return result.ismaster;
@@ -66,28 +66,26 @@ export const getMongoDbPodsWithReplInfo = async (envComponent: string) => {
   const namespace = await getProjectNamespace(envComponent);
   return (
     await Promise.all(
-      (
-        await getProjectMongodbAllPods(envComponent)
-      ).map(async (podName) => ({
+      (await getProjectMongodbAllPods(envComponent)).map(async (podName) => ({
         podName,
         componentName: podName.replace(/-mongodb-replicaset-[0-9]+/, ""),
         isMaster: await podIsMaster(namespace, podName),
-      }))
+      })),
     )
   ).sort((podA, podB) => (podA.isMaster ? (podB.isMaster ? 0 : -1) : 1));
 };
 
 export const getProjectMongodbAllPodsSortedWithLabel = async (
-  envComponent: string
+  envComponent: string,
 ) => {
   const pods = await getMongoDbPodsWithReplInfo(envComponent);
   const maxComponentNameLength = Math.max(
-    ...pods.map((c) => c.componentName.length)
+    ...pods.map((c) => c.componentName.length),
   );
   return pods.map(({ podName, isMaster, componentName }) => ({
     value: podName,
     name: `[ ${componentName}${spaces(
-      maxComponentNameLength - componentName.length
+      maxComponentNameLength - componentName.length,
     )} ${isMaster ? "  PRIMARY  " : " secondary "}] ${podName}`,
   }));
 };

package/src/apps/cli/commands/project/cloudSql/commandProjectRestoreDb.ts

@@ -14,7 +14,7 @@ export default async (vorpal: Vorpal) =>
   vorpal
     .command(
       "project-cloud-sql-restore-db",
-      "restores a project db from one source to another target"
+      "restores a project db from one source to another target",
     )
     .action(async function restoreDb() {
       const envs = await envAndComponents();
@@ -31,13 +31,13 @@ export default async (vorpal: Vorpal) =>
 
       const sourceContext = await getPipelineContextByChoice(
         sourceEnv,
-        sourceComponent
+        sourceComponent,
       );
 
       const sourceEnvVars = await getEnvVarsResolved(
         this,
-        sourceContext.environment.shortName,
-        sourceContext.componentName
+        sourceContext.env,
+        sourceContext.name,
       );
 
       let sourceProxy: CloudSqlBackgroundProxy;
@@ -65,7 +65,9 @@ export default async (vorpal: Vorpal) =>
           hosts: [],
         });
 
-        const parsersResult = parser.parse(sourceEnvVars.DATABASE_URL);
+        const parsersResult = parser.parse(
+          sourceEnvVars.DATABASE_URL.toString(),
+        );
         sourcePort = parsersResult.hosts?.[0]?.port;
         sourceUsername = parsersResult.username;
         sourcePassword = parsersResult.password;
@@ -73,13 +75,14 @@ export default async (vorpal: Vorpal) =>
       } else {
         sourcePort = 54399;
         sourceProxy = await startCloudSqlProxyInBackground({
-          instanceName: sourceEnvVars.CLOUD_SQL_INSTANCE_CONNECTION_NAME,
+          instanceName:
+            sourceEnvVars.CLOUD_SQL_INSTANCE_CONNECTION_NAME.toString(),
           localPort: sourcePort,
         });
 
-        sourceUsername = sourceEnvVars.DB_USER;
-        sourcePassword = sourceEnvVars.DB_PASSWORD;
-        sourceDbName = sourceEnvVars.DB_NAME;
+        sourceUsername = sourceEnvVars.DB_USER.toString();
+        sourcePassword = sourceEnvVars.DB_PASSWORD.toString();
+        sourceDbName = sourceEnvVars.DB_NAME?.toString();
       }
 
       const { targetEnvAndComponent } = await this.prompt({
@@ -94,13 +97,13 @@ export default async (vorpal: Vorpal) =>
 
       const targetContext = await getPipelineContextByChoice(
         targetEnv,
-        targetComponent
+        targetComponent,
       );
 
       const targetEnvVars = await getEnvVarsResolved(
         this,
-        targetContext.environment.shortName,
-        targetContext.componentName
+        targetContext.env,
+        targetContext.name,
       );
 
       if (targetEnv === "local") {
@@ -109,7 +112,9 @@ export default async (vorpal: Vorpal) =>
           hosts: [],
         });
 
-        const parsersResult = parser.parse(targetEnvVars.DATABASE_URL);
+        const parsersResult = parser.parse(
+          targetEnvVars.DATABASE_URL.toString(),
+        );
 
         targetPort = parsersResult.hosts?.[0]?.port;
         targetUsername = parsersResult.username;
@@ -118,13 +123,14 @@ export default async (vorpal: Vorpal) =>
       } else {
         targetPort = 54499;
         targetProxy = await startCloudSqlProxyInBackground({
-          instanceName: targetEnvVars.CLOUD_SQL_INSTANCE_CONNECTION_NAME,
+          instanceName:
+            targetEnvVars.CLOUD_SQL_INSTANCE_CONNECTION_NAME.toString(),
           localPort: targetPort,
         });
 
-        targetUsername = targetEnvVars.DB_USER;
-        targetPassword = targetEnvVars.DB_PASSWORD;
-        targetDbName = targetEnvVars.DB_NAME;
+        targetUsername = targetEnvVars.DB_USER.toString();
+        targetPassword = targetEnvVars.DB_PASSWORD.toString();
+        targetDbName = targetEnvVars.DB_NAME.toString();
       }
 
       const { shouldContinue } = await this.prompt({
@@ -141,7 +147,7 @@ export default async (vorpal: Vorpal) =>
 
       if (targetContext.environment.envType === "prod") {
         this.log(
-          `\n🚨 You are overriding a production environment. Please type in ${targetEnvVars.CLOUD_SQL_INSTANCE_CONNECTION_NAME} to continue\n\n`
+          `\n🚨 You are overriding a production environment. Please type in ${targetEnvVars.CLOUD_SQL_INSTANCE_CONNECTION_NAME} to continue\n\n`,
         );
         const { confirmInstance } = await this.prompt({
           type: "input",