@gitbeaker/cli 43.0.0 → 43.2.0

package/dist/index.mjs

@@ -7,31 +7,42 @@ import * as Gitbeaker from "@gitbeaker/rest";
 import API_MAP from "@gitbeaker/core/map.json" with { type: "json" };
 
 // src/utils.ts
-import { camelize, decamelize, depascalize } from "xcase";
-function param(value) {
-  let cleaned = value;
-  const exceptions = [
-    "GitLabCI",
-    "YML",
-    "GPG",
-    "SSH",
-    "IId",
-    "NPM",
-    "NuGet",
-    "DORA4",
-    "LDAP",
-    "CICD",
-    "SAML",
-    "SCIM",
-    "PyPI"
-  ];
-  exceptions.filter((e) => value.includes(e)).forEach((ex) => {
-    cleaned = cleaned.replace(ex, ex.charAt(0).toUpperCase() + ex.slice(1).toLowerCase());
+import { camelize, decamelize } from "xcase";
+var NORMALIZED_EXCEPTION_TERMS = [
+  "GitLabCI",
+  "YML",
+  "GPG",
+  "SSH",
+  "IId",
+  "NPM",
+  "NuGet",
+  "DORA4",
+  "LDAP",
+  "CICD",
+  "SAML",
+  "SCIM",
+  "PyPI"
+].reduce((prev, cur) => {
+  return { ...prev, [cur]: cur.charAt(0).toUpperCase() + cur.slice(1).toLowerCase() };
+}, {});
+function getCLISafeNormalizedTerm(term) {
+  if (term.length === 0) return term;
+  let normalized = term;
+  Object.entries(NORMALIZED_EXCEPTION_TERMS).filter(([k]) => term.includes(k)).forEach(([k, v]) => {
+    normalized = normalized.replace(k, v);
   });
-  const decamelized = decamelize(cleaned, "-");
-  return decamelized !== cleaned ? decamelized : depascalize(cleaned, "-");
+  normalized = normalized.charAt(0).toLowerCase() + normalized.slice(1);
+  return decamelize(normalized, "-");
 }
-function normalizeEnviromentVariables(env) {
+function getAPISafeNormalizedTerm(term) {
+  if (term.length === 0) return term;
+  let normalized = camelize(term.replace(/(gb|gl)-/g, ""), "-");
+  Object.entries(NORMALIZED_EXCEPTION_TERMS).filter(([, v]) => normalized.includes(v)).forEach(([k, v]) => {
+    normalized = normalized.replace(v, k);
+  });
+  return normalized;
+}
+function normalizeEnvVariables(env) {
   const normalized = {};
   const suffixes = [
     "TOKEN",
@@ -57,11 +68,12 @@ function buildArgumentObjects(globalConfig, method, rawArgs) {
   const initArgs = {};
   Object.entries(rawArgs).forEach(([argName, value]) => {
     if (ignoreOptions.includes(argName) || value == null) return;
-    const camelCased = camelize(argName.replace("gb-", "").replace("gl-", ""), "-");
-    if (globalConfig[argName.replace("gl-", "gb-")]) {
-      initArgs[camelCased] = value;
-    } else if (method.args.includes(camelCased)) coreArgs[camelCased] = value;
-    else optionalArgs[camelCased] = value;
+    const term = argName.replace("gl-", "gb-");
+    const normalized = getAPISafeNormalizedTerm(term);
+    if (globalConfig[term]) {
+      initArgs[normalized] = value;
+    } else if (method.args.includes(normalized)) coreArgs[normalized] = value;
+    else optionalArgs[normalized] = value;
   });
   return {
     initArgs,
@@ -82,7 +94,7 @@ function getDisplayConfig(globalConfig) {
   return display;
 }
 function getGlobalConfig(env = process.env) {
-  const normalEnv = normalizeEnviromentVariables(env);
+  const normalEnv = normalizeEnvVariables(env);
   return {
     "gb-token": {
       alias: "gl-token",
@@ -110,7 +122,7 @@ function getGlobalConfig(env = process.env) {
     },
     "gb-sudo": {
       alias: "gl-sudo",
-      desc: "[Sudo](https://docs.gitlab.com/ee/api/#sudo) query parameter",
+      desc: "Sudo query parameter - https://docs.gitlab.com/ee/api/#sudo",
       type: "string",
       defaultValue: normalEnv.GITBEAKER_SUDO
     },
@@ -128,13 +140,13 @@ function getGlobalConfig(env = process.env) {
     },
     "gb-profile-token": {
       alias: "gl-profile-token",
-      desc: "[Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html)",
+      desc: `Requests Profiles Token - https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html`,
       type: "string",
       defaultValue: normalEnv.GITBEAKER_PROFILE_TOKEN
     },
     "gb-profile-mode": {
       alias: "gl-profile-mode",
-      desc: "[Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html)",
+      desc: "Requests Profiles Token - https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html",
       type: "string",
       defaultValue: normalEnv.GITBEAKER_PROFILE_MODE
     }
@@ -148,10 +160,13 @@ function getExposedAPIs(map) {
 // src/cli.ts
 function setupAPIMethods(setupArgs, methodArgs) {
   methodArgs.forEach((name) => {
-    setupArgs.positional(`[--${param(name)}] <${param(name)}>`, {
-      group: "Required Options",
-      type: "string"
-    });
+    setupArgs.positional(
+      `[--${getCLISafeNormalizedTerm(name)}] <${getCLISafeNormalizedTerm(name)}>`,
+      {
+        group: "Required Options",
+        type: "string"
+      }
+    );
   });
   return setupArgs;
 }
@@ -171,9 +186,9 @@ function setupAPIs(setupArgs, apiName, methods) {
       ...v
     });
   });
-  for (let i = 1; i < methods.length; i += 1) {
+  for (let i = 0; i < methods.length; i += 1) {
     const method = methods[i];
-    setupArgs.command(param(method.name), {
+    setupArgs.command(getCLISafeNormalizedTerm(method.name), {
       setup: (setupMethodArgs) => setupAPIMethods(setupMethodArgs, method.args),
       run: (args, ctx) => runAPIMethod(ctx, args, apiName, method)
     });
@@ -206,7 +221,7 @@ cli.command("*", (argv, ctx) => {
 });
 var exposedAPIs = getExposedAPIs(API_MAP);
 Object.entries(exposedAPIs).forEach(([apiName, methods]) => {
-  cli.command(param(apiName), {
+  cli.command(getCLISafeNormalizedTerm(apiName), {
     desc: `The ${apiName} API`,
     setup: (setupArgs) => setupAPIs(setupArgs, apiName, methods)
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitbeaker/cli",
-  "version": "43.0.0",
+  "version": "43.2.0",
   "description": "CLI implementation of the GitLab API.",
   "license": "MIT",
   "engines": {
@@ -39,8 +39,8 @@
     "lint:fix": "yarn lint --fix"
   },
   "dependencies": {
-    "@gitbeaker/core": "^43.0.0",
-    "@gitbeaker/rest": "^43.0.0",
+    "@gitbeaker/core": "^43.2.0",
+    "@gitbeaker/rest": "^43.2.0",
     "chalk": "^5.4.1",
     "sywac": "^1.3.0",
     "xcase": "^2.0.1"
@@ -49,5 +49,5 @@
     "tsup": "^8.5.0",
     "typescript": "^5.8.3"
   },
-  "gitHead": "2ae1422a257c0dfe21da6bbfd0f9fd63ea510e85"
+  "gitHead": "a0c0b9d3a8b6eeb155ec0c6c3dbee45f7ab31692"
 }