@catladder/cli 0.0.0-new-cli-80ac360a → 0.0.0-new-cli-81ed6546

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "0.0.0-new-cli-80ac360a",
+  "version": "0.0.0-new-cli-81ed6546",
   "scripts": {
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix",
@@ -66,7 +66,6 @@
     "build:watch": "tsc-watch --onSuccess \"yarn dev:own-catenv\""
   },
   "bin": {
-    "catci": "./bin/catci",
     "catenv": "./bin/catenv",
     "catladder": "./bin/catladder"
   },
@@ -80,6 +79,7 @@
     "@babel/core": "^7.29.0",
     "@babel/plugin-syntax-typescript": "^7.28.6",
     "@gitbeaker/rest": "^39.28.0",
+    "@inquirer/prompts": "^8.4.3",
     "@kubernetes/client-node": "^0.16.2",
     "@tsconfig/node14": "^1.0.1",
     "@types/common-tags": "^1.8.4",
@@ -90,13 +90,13 @@
     "@types/request": "^2.48.12",
     "@types/tmp": "^0.2.3",
     "@types/update-notifier": "^2.5.0",
-    "@types/vorpal": "^1.12.0",
     "@types/websocket": "^0.0.40",
     "@types/yargs": "^17.0.33",
     "babel-plugin-transform-inline-environment-variables": "^0.4.4",
     "child-process-promise": "^2.2.1",
     "clipboardy": "^2.0.0",
     "command-exists-promise": "^2.0.2",
+    "commander": "^14.0.3",
     "common-tags": "^1.8.2",
     "connection-string-parser": "^1.0.4",
     "date-fns": "^3.6.0",
@@ -111,12 +111,9 @@
     "tsc-alias": "^1.8.16",
     "tsc-watch": "^7.2.0",
     "typescript": "^5.4.5",
-    "vorpal": "^1.12.0",
     "yaml": "^2.5.0"
   },
   "dependencies": {
-    "@inquirer/prompts": "^8.4.3",
-    "commander": "^14.0.3",
     "tsx": "^4.21.0"
   },
   "stableVersion": "0.0.0"

package/scripts/bundle

@@ -2,5 +2,3 @@
 ncc build dist/cli/src/catenv.js -o dist/bundles/catenv -e 'tsx/cjs/api' $( ((SHOULD_MINIFY == 1)) && printf %s '-m')
 
 ncc build dist/cli/src/cli.js -o dist/bundles/cli -e 'tsx/cjs/api' $( ((SHOULD_MINIFY == 1)) && printf %s '-m')
-
-ncc build dist/cli/src/catci.js -o dist/bundles/catci -e 'tsx/cjs/api' $( ((SHOULD_MINIFY == 1)) && printf %s '-m')

package/src/apps/catenv/catenv.ts

@@ -11,6 +11,7 @@ import {
 
 type Options = {
   verbose?: boolean;
+  printVariables?: boolean;
 };
 export default async (choice?: Choice, options?: Options) => {
   const config = await getProjectConfig();
@@ -28,7 +29,8 @@ export default async (choice?: Choice, options?: Options) => {
     writeDotEnvFiles(context, choice),
 
     writeDTsFiles(context, choice),
-
-    printVariables(context, choice),
+    options?.printVariables
+      ? printVariables(context, choice)
+      : Promise.resolve(),
   ]);
 };

package/src/apps/catenv/printVariables.ts

@@ -14,10 +14,6 @@ const getAllVariablesToPrint = async (config: Config, choice?: Choice) => {
   );
 
   if (currentComponent) {
-    // don't print vars if dotenv is enabled
-    if (config.components[currentComponent].dotEnv ?? true) {
-      return {};
-    }
     return await getEnvVarsResolved(null, env, currentComponent);
   } else {
     // when in a monorep and not in a subapp, merge all env vars.
@@ -25,10 +21,6 @@ const getAllVariablesToPrint = async (config: Config, choice?: Choice) => {
     // so we also add prefixed variants
     return await Object.keys(config.components).reduce(
       async (acc, componentName) => {
-        // don't print vars if dotenv is enabled
-        if (config.components[componentName].dotEnv ?? true) {
-          return await acc;
-        }
         const subappvars = await getEnvVarsResolved(null, env, componentName);
         delete subappvars["_ALL_ENV_VAR_KEYS"];
         return {

package/src/catenv.ts

@@ -1,24 +1,23 @@
+import { Command } from "commander";
 import catenv from "./apps/catenv/catenv";
-
 import { parseChoice } from "./config/parseChoice";
+import packageInfos from "./packageInfos";
 
-const args = process.argv.slice(2);
-
-const helpFlags = ["--help", "-h", "help"];
-if (args.some((arg) => helpFlags.includes(arg))) {
-  const docLink =
-    "https://git.panter.ch/catladder/catladder/-/blob/main/docs/1_VARS.md";
-  console.log(
-    `\nUsage: catenv [env|env:component] [-v|--verbose]\n\nEnv variable and catenv documentation:\n${docLink}`,
-  );
-  process.exit(0);
-}
+const program = new Command();
 
-const verbose = args.some((arg) => arg === "-v" || arg === "--verbose");
-// choise arg is deprecated and will be removed in the future
-const choiceArg = args.find((arg) => arg !== "-v" && arg !== "--verbose");
+program
+  .name("catenv")
+  .description("Environment variable and pipeline generation via direnv")
+  .version(packageInfos.version)
+  .argument("[envComponent]", "env or env:component")
+  .option("-v, --verbose", "verbose output")
+  .action((envComponent: string | undefined, opts: { verbose?: boolean }) => {
+    catenv(envComponent ? parseChoice(envComponent) : null, {
+      verbose: opts.verbose ?? false,
+    }).then(() => {
+      // we have to exit manually, because we have some file watches
+      process.exit();
+    });
+  });
 
-catenv(choiceArg ? parseChoice(choiceArg) : null, { verbose }).then(() => {
-  // we have to exit manually, because we have some file watches
-  process.exit();
-});
+program.parse();

package/src/commands/index.ts

@@ -41,6 +41,11 @@ export { commandMongoDestroyMember } from "./mongodb/commandMongoDestroyMember";
 // CloudSQL commands
 export { commandRestoreDb } from "./cloudSQL/commandRestoreDb";
 
+// Security commands
+export { commandSecurityAuditCiJob } from "./security/commandSecurityAuditCiJob";
+export { commandSecurityAuditEvaluate } from "./security/commandSecurityAuditEvaluate";
+export { commandSecurityAuditCreate } from "./security/commandSecurityAuditCreate";
+
 // Fun commands
 export { commandDadjoke } from "./fun/commandDadjoke";
 export { commandStarwars } from "./fun/commandStarwars";

package/src/commands/project/commandSecurityEvaluate.ts

@@ -2,7 +2,7 @@ import { defineCommand } from "../../core/defineCommand";
 import {
   evaluateSecurityAudit,
   makeSecurityAuditOverview,
-} from "../../apps/catci/commands/security/evaluateSecurityAudit";
+} from "../../security/evaluateSecurityAudit";
 import { getGitRoot } from "../../utils/projects";
 
 export const commandSecurityEvaluate = defineCommand({

package/src/commands/security/commandSecurityAuditCiJob.ts

@@ -0,0 +1,91 @@
+import { defineCommand } from "../../core/defineCommand";
+import { Gitlab } from "@gitbeaker/rest";
+import {
+  evaluateSecurityAudit,
+  makeSecurityAuditOverview,
+} from "../../security/evaluateSecurityAudit";
+import {
+  createSecurityAuditMergeRequest,
+  SECURITY_AUDIT_FILE_NAME,
+} from "../../security/createSecurityAuditMergeRequest";
+
+const GITLAB_HOST = "https://git.panter.ch";
+
+export const commandSecurityAuditCiJob = defineCommand({
+  name: "security-audit-ci-job",
+  description:
+    "Evaluates security audit document. Creates MR with template if missing.",
+  group: "security",
+  inputs: {
+    path: { type: "string", message: "path to project root", positional: true },
+    token: {
+      type: "string",
+      message: "GitLab token (api scope)",
+      positional: true,
+    },
+    mainBranch: {
+      type: "string",
+      message: "main branch name",
+      positional: true,
+    },
+    projectId: {
+      type: "string",
+      message: "GitLab project ID",
+      positional: true,
+    },
+    userId: {
+      type: "string",
+      message: "GitLab user ID (assignee)",
+      positional: true,
+    },
+  },
+  execute: async (ctx) => {
+    const path = await ctx.get("path");
+    const evaluation = await evaluateSecurityAudit({ path });
+
+    if (evaluation.isErr()) {
+      ctx.log("could not evaluate security audit document");
+      ctx.log("creating new merge request with security audit template...");
+
+      const token = await ctx.get("token");
+      const mainBranch = await ctx.get("mainBranch");
+      const projectId = await ctx.get("projectId");
+      const userId = await ctx.get("userId");
+
+      const api = new Gitlab({ host: GITLAB_HOST, token });
+
+      const mr = await createSecurityAuditMergeRequest({
+        api,
+        mainBranch,
+        projectId,
+        userId: parseInt(userId),
+      });
+
+      if (mr.isErr()) {
+        ctx.log(
+          `could not create merge request with security audit template: ${mr.error}`,
+        );
+        process.exitCode = 1;
+        return;
+      }
+
+      ctx.log("security audit merge request created successfully");
+      ctx.log(
+        `please finish the MR by updating SECURITY.md document: ${mr.value.web_url}`,
+      );
+      process.exitCode = 1;
+      return;
+    }
+
+    if (evaluation.value.score.answeredTopics === 0) {
+      ctx.log("audit document has no answered topics");
+      ctx.log(
+        `please answer security topics in ${SECURITY_AUDIT_FILE_NAME} by adding responsible people and check/cross in the table`,
+      );
+      process.exitCode = 1;
+      return;
+    }
+
+    ctx.log(makeSecurityAuditOverview(evaluation.value));
+  },
+});

package/src/commands/security/commandSecurityAuditCreate.ts

@@ -0,0 +1,58 @@
+import { defineCommand } from "../../core/defineCommand";
+import { Gitlab } from "@gitbeaker/rest";
+import { createSecurityAuditMergeRequest } from "../../security/createSecurityAuditMergeRequest";
+
+const GITLAB_HOST = "https://git.panter.ch";
+
+export const commandSecurityAuditCreate = defineCommand({
+  name: "security-audit-create",
+  description: "Creates a MR with the latest security audit template document",
+  group: "security",
+  inputs: {
+    token: {
+      type: "string",
+      message: "GitLab token (api scope)",
+      positional: true,
+    },
+    mainBranch: {
+      type: "string",
+      message: "main branch name",
+      positional: true,
+    },
+    projectId: {
+      type: "string",
+      message: "GitLab project ID",
+      positional: true,
+    },
+    userId: {
+      type: "string",
+      message: "GitLab user ID (assignee)",
+      positional: true,
+    },
+  },
+  execute: async (ctx) => {
+    const token = await ctx.get("token");
+    const mainBranch = await ctx.get("mainBranch");
+    const projectId = await ctx.get("projectId");
+    const userId = await ctx.get("userId");
+
+    const api = new Gitlab({ host: GITLAB_HOST, token });
+
+    const result = await createSecurityAuditMergeRequest({
+      api,
+      mainBranch,
+      projectId,
+      userId: parseInt(userId),
+    });
+
+    if (result.isErr()) {
+      ctx.log(`could not create security audit merge request: ${result.error}`);
+      process.exitCode = 1;
+    } else {
+      ctx.log("security audit merge request created successfully");
+      ctx.log(
+        `please finish the MR by updating SECURITY.md document: ${result.value.web_url}`,
+      );
+    }
+  },
+});

package/src/commands/security/commandSecurityAuditEvaluate.ts

@@ -0,0 +1,30 @@
+import { defineCommand } from "../../core/defineCommand";
+import {
+  evaluateSecurityAudit,
+  makeSecurityAuditOverview,
+} from "../../security/evaluateSecurityAudit";
+import { SECURITY_AUDIT_FILE_NAME } from "../../security/createSecurityAuditMergeRequest";
+
+export const commandSecurityAuditEvaluate = defineCommand({
+  name: "security-audit-evaluate",
+  description: "Evaluates security audit document in given path",
+  group: "security",
+  inputs: {
+    path: { type: "string", message: "path to project root", positional: true },
+  },
+  execute: async (ctx) => {
+    const path = await ctx.get("path");
+    ctx.log("evaluating security audit document...");
+
+    const result = await evaluateSecurityAudit({ path });
+    if (result.isErr()) {
+      ctx.log(`${result.error}`);
+      ctx.log(
+        `please make sure the security audit document ${SECURITY_AUDIT_FILE_NAME} is in the repository`,
+      );
+      process.exitCode = 1;
+    } else {
+      ctx.log(makeSecurityAuditOverview(result.value));
+    }
+  },
+});

package/bin/catci

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-// tslint:disable-next-line:no-var-requires
-require("../dist/bundles/catci/index.js");

package/bin/catci-dev

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-// tslint:disable-next-line:no-var-requires
-require("../dist/cli/src/catci.js");