@gitbeaker/cli 35.8.0 → 35.8.1

package/dist/index.mjs

@@ -0,0 +1,200 @@
+#!/usr/bin/env node
+import Chalk from 'chalk';
+import Sywac from 'sywac';
+import { decamelize, depascalize, camelize } from 'xcase';
+import * as Gitbeaker from '@gitbeaker/rest';
+import API_MAP from '@gitbeaker/core/map.json' assert { type: 'json' };
+
+var commandStyle = Chalk.hex("#e34329").bold;
+var groupStyle = Chalk.hex("#fca325").bold;
+var usageStyle = Chalk.hex("#fc6e26").bold;
+var optionStyle = Chalk.white.bold;
+var descriptionStyle = Chalk.hex("#848484");
+var hintStyle = Chalk.hex("#6a5f88");
+function normalizeEnviromentVariables(env) {
+  const normalized = { ...env };
+  const suffixes = [
+    "TOKEN",
+    "OAUTH_TOKEN",
+    "JOB_TOKEN",
+    "HOST",
+    "SUDO",
+    "CAMELIZE",
+    "REQUEST_TIMEOUT",
+    "PROFILE_TOKEN",
+    "PROFILE_MODE"
+  ];
+  suffixes.forEach((s) => {
+    if (normalized[`GITLAB_${s}`] && !normalized[`GITBEAKER_${s}`]) {
+      normalized[`GITBEAKER_${s}`] = normalized[`GITLAB_${s}`];
+    }
+  });
+  return normalized;
+}
+function globalConfig(env = process.env) {
+  const normalEnv = normalizeEnviromentVariables(env);
+  return {
+    "gb-token": {
+      alias: "gl-token",
+      desc: "Your Gitlab Personal Token",
+      type: "string",
+      defaultValue: normalEnv.GITBEAKER_TOKEN
+    },
+    "gb-oauth-token": {
+      alias: "gl-oauth-token",
+      desc: "Your Gitlab OAuth Token",
+      type: "string",
+      defaultValue: normalEnv.GITBEAKER_OAUTH_TOKEN
+    },
+    "gb-job-token": {
+      alias: "gl-job-token",
+      desc: "Your Gitlab Job Token",
+      type: "string",
+      defaultValue: normalEnv.GITBEAKER_JOB_TOKEN
+    },
+    "gb-host": {
+      alias: "gl-host",
+      desc: "Your Gitlab API host (Defaults to https://www.gitlab.com)",
+      type: "string",
+      defaultValue: normalEnv.GITBEAKER_HOST
+    },
+    "gb-sudo": {
+      alias: "gl-sudo",
+      desc: "[Sudo](https://docs.gitlab.com/ee/api/#sudo) query parameter",
+      type: "string",
+      defaultValue: normalEnv.GITBEAKER_SUDO
+    },
+    "gb-camelize": {
+      alias: "gl-camelize",
+      desc: "Camelizes all response body keys",
+      type: "boolean",
+      defaultValue: normalEnv.GITBEAKER_CAMELIZE
+    },
+    "gb-request-timeout": {
+      alias: "gl-request-timeout",
+      desc: "Timeout for API requests. Measured in ms",
+      type: "number",
+      defaultValue: normalEnv.GITBEAKER_REQUEST_TIMEOUT && parseInt(normalEnv.GITBEAKER_REQUEST_TIMEOUT, 10)
+    },
+    "gb-profile-token": {
+      alias: "gl-profile-token",
+      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)",
+      type: "string",
+      defaultValue: normalEnv.GITBEAKER_PROFILE_MODE
+    }
+  };
+}
+var ignoreOptions = ["_", "$0", "v", "version", "h", "help", "g", "global-args"];
+function param(value) {
+  let cleaned = value;
+  const exceptions = [
+    "GitLabCI",
+    "YML",
+    "GPG",
+    "SSH",
+    "IId",
+    "NPM",
+    "NuGet",
+    "DORA4",
+    "LDAP",
+    "CICD"
+  ];
+  const ex = exceptions.find((e) => value.includes(e));
+  if (ex)
+    cleaned = cleaned.replace(ex, ex.charAt(0).toUpperCase() + ex.slice(1).toLowerCase());
+  const decamelized = decamelize(cleaned, "-");
+  return decamelized !== cleaned ? decamelized : depascalize(cleaned, "-");
+}
+function setupAPIMethods(setupArgs, methodArgs) {
+  methodArgs.forEach((name) => {
+    if (typeof name !== "string")
+      return;
+    setupArgs.positional(`[--${param(name)}] <${param(name)}>`, {
+      group: "Required Options",
+      type: "string"
+    });
+  });
+  return setupArgs;
+}
+function runAPIMethod(ctx, args, apiName, method) {
+  const coreArgs = {};
+  const optionalArgs = {};
+  const initArgs = {};
+  Object.entries(args).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 s = new Gitbeaker[apiName](initArgs);
+  return s[method.name](...Object.values(coreArgs), optionalArgs).then((r) => {
+    ctx.output = JSON.stringify(r, null, 3);
+  }).catch((e) => {
+    ctx.output = e;
+  });
+}
+function setupAPIs(setupArgs, apiName, methods) {
+  Object.entries(globalConfig()).forEach(([k, v]) => {
+    setupArgs.option(`${k} <value>`, {
+      group: "Base Options",
+      ...v
+    });
+  });
+  for (let i = 1; i < methods.length; i += 1) {
+    const method = methods[i];
+    setupArgs.command(param(method.name), {
+      setup: (setupMethodArgs) => setupAPIMethods(setupMethodArgs, method.args),
+      run: (args, ctx) => runAPIMethod(ctx, args, apiName, method)
+    });
+  }
+  return setupArgs;
+}
+var cli = Sywac.version("-v, --version").help("-h, --help").showHelpByDefault().epilogue("Copyright 2023").style({
+  usagePrefix: (s) => usageStyle(s),
+  group: (s) => groupStyle(s),
+  flags: (s) => optionStyle(s),
+  usageCommandPlaceholder: (s) => commandStyle(s),
+  usageOptionsPlaceholder: (s) => optionStyle(s),
+  desc: (s) => descriptionStyle(s),
+  hints: (s) => hintStyle(s)
+});
+cli.boolean("-g --global-args", {
+  desc: "Show global arguments currently set in the environment variables"
+});
+cli.command("*", (argv, ctx) => {
+  if (!argv.g)
+    return;
+  const display = {};
+  Object.entries(globalConfig()).forEach(([k, v]) => {
+    if (v.defaultValue == null)
+      return;
+    display[k] = {
+      alias: v.alias,
+      description: v.desc,
+      value: v.defaultValue
+    };
+  });
+  ctx.output = Object.keys(display).length === 0 ? "No global variables have been set!" : JSON.stringify(display, null, 3);
+});
+Object.entries(API_MAP).forEach(([apiName, methods]) => {
+  if (apiName === "Gitlab")
+    return;
+  cli.command(param(apiName), {
+    desc: `The ${apiName} API`,
+    setup: (setupArgs) => setupAPIs(setupArgs, apiName, methods)
+  });
+});
+
+// src/index.ts
+cli.parseAndExit();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gitbeaker/cli",
   "description": "Full NodeJS CLI implementation of the GitLab API.",
-  "version": "35.8.0",
+  "version": "35.8.1",
   "author": {
     "name": "Justin Dalrymple"
   },
@@ -12,8 +12,8 @@
     "url": "https://github.com/jdalrymple/gitbeaker/issues"
   },
   "dependencies": {
-    "@gitbeaker/core": "^35.8.0",
-    "@gitbeaker/node": "^35.8.0",
+    "@gitbeaker/core": "^35.8.1",
+    "@gitbeaker/node": "^35.8.1",
     "chalk": "4.1.2",
     "ora": "^6.0.0",
     "sywac": "^1.3.0",
@@ -53,6 +53,5 @@
     "build": "rollup -c",
     "test:integration": "TEST_ID=$(uuid) node --expose-gc ../../node_modules/.bin/jest --runInBand --logHeapUsage test/integration",
     "test:unit": "node --expose-gc ../../node_modules/.bin/jest --runInBand --logHeapUsage test/unit"
-  },
-  "gitHead": "f42202715f3b6d327bf63b20bffdea41d0d72009"
+  }
 }

package/LICENSE.md

@@ -1,22 +0,0 @@
-# The MIT License
-
-Copyright (c)
-**2020 Justin Dalrymple**
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.