@gitbeaker/cli 38.0.1 → 38.1.1

package/README.md

@@ -1,11 +1,51 @@
 <div align="center">
   <br>
-  <img alt="gitbeaker" src="https://github.com/jdalrymple/gitbeaker/blob/main/.github/ASSETS/header.svg">
+  <br>
+  <img alt="gitbeaker" src="../../.github/ASSETS/header.svg">
+  <br>
+  <br>
+  <br>
+</div>
+
+<div align="center">
+  <p>
+		<sup>
+			<a href="https://github.com/jdalrymple">My open source work is supported by the community</a>
+		</sup>
+	</p>
+  <br>
+	<sup>Special thanks to:</sup>
+	<br>
+	<br>
+
+  <a href="https://wearecws.com/">
+    <img src="https://wearecws.com/images/brand/cws-logo.svg" width="210">
+  </a>
+
+  <br>
+	<br>
+  <br>
+
+  <a href="https://axolo.co/gitlab-slack-integration/?ref=gitbeaker">
+  <div>
+    <img src="https://apichaos.s3.eu-west-3.amazonaws.com/logo_axolo.png" width="210" alt="Axolo Logo"/>
+    <br>
+    <br>
+  </div>
+  <b>Review merge requests in Slack to merge code faster</b>
+  <div>
+    <sub>Improve your code review process by creating an ephemeral channel per merge request.</sub>
+    <br>
+  </div>
+  </a>
+
+  <br>
+  <hr>
 </div>
-<br>
+
 <p align="center">
    <a href="https://gitlab.com/jdalrymple/gitbeaker/-/commits/main"><img alt="pipeline status" src="https://gitlab.com/jdalrymple/gitbeaker/badges/main/pipeline.svg?ignore_skipped=true" /></a>
-   <a href="https://gitlab.com/jdalrymple/gitbeaker/-/commits/main"><img alt="coverage report" src="https://gitlab.com/jdalrymple/gitbeaker/badges/main/coverage.svg?job=test:integration:cli" /></a>
+   <a href="https://gitlab.com/jdalrymple/gitbeaker/-/commits/main"><img alt="coverage report" src="https://gitlab.com/jdalrymple/gitbeaker/badges/main/coverage.svg?job=test:unit:cli" /></a>
   <a href="https://codeclimate.com/github/jdalrymple/gitbeaker">
     <img src="https://codeclimate.com/github/jdalrymple/gitbeaker/badges/gpa.svg" alt="Code Climate maintainability">
   </a>
@@ -32,6 +72,8 @@
 ## Table of Contents
 
 - [Usage](#usage)
+- [Testing](../../docs/TESTING.md)
+- [FAQ](../../FAQ.md)
 - [Contributors](#contributors)
 - [Changelog](./CHANGELOG.md)
 
@@ -187,6 +229,7 @@ This could be set globally or using a [.env](https://github.com/motdotla/dotenv#
       <td align="center" valign="top" width="3.84%"><a href="https://kyr.github.io/CV/"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/426462?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="Kyrylo Fedorov"/></td>
       <td align="center" valign="top" width="3.84%"><a href="https://github.com/claudio-vellage"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/28930612?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="Claudio Vellage"/></td>
       <td align="center" valign="top" width="3.84%"><a href="https://github.com/seb0uil"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/5122626?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="Seb0uil"/></td>
+      <td align="center" valign="top" width="3.84%"><a href="http://merorafael.info/"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/3404989?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="Rafael Mello"/></td>
     </tr>
 </p>
 

package/dist/index.mjs

@@ -1,18 +1,35 @@
 #!/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' };
+import { decamelize, depascalize, camelize } from 'xcase';
 
-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 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());
+  });
+  const decamelized = decamelize(cleaned, "-");
+  return decamelized !== cleaned ? decamelized : depascalize(cleaned, "-");
+}
 function normalizeEnviromentVariables(env) {
-  const normalized = { ...env };
+  const normalized = {};
   const suffixes = [
     "TOKEN",
     "OAUTH_TOKEN",
@@ -25,13 +42,49 @@ function normalizeEnviromentVariables(env) {
     "PROFILE_MODE"
   ];
   suffixes.forEach((s) => {
-    if (normalized[`GITLAB_${s}`] && !normalized[`GITBEAKER_${s}`]) {
-      normalized[`GITBEAKER_${s}`] = normalized[`GITLAB_${s}`];
-    }
+    if (env[`GITLAB_${s}`])
+      normalized[`GITBEAKER_${s}`] = env[`GITLAB_${s}`];
+    if (env[`GITBEAKER_${s}`])
+      normalized[`GITBEAKER_${s}`] = env[`GITBEAKER_${s}`];
   });
   return normalized;
 }
-function globalConfig(env = process.env) {
+function buildArgumentObjects(globalConfig, method, rawArgs) {
+  const ignoreOptions = ["_", "$0", "v", "version", "h", "help", "g", "global-args"];
+  const coreArgs = {};
+  const optionalArgs = {};
+  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;
+  });
+  return {
+    initArgs,
+    coreArgs,
+    optionalArgs
+  };
+}
+function getDisplayConfig(globalConfig) {
+  const display = {};
+  Object.entries(globalConfig).forEach(([k, v]) => {
+    if (v.defaultValue == null)
+      return;
+    display[k] = {
+      alias: v.alias,
+      description: v.desc,
+      value: v.defaultValue
+    };
+  });
+  return display;
+}
+function getGlobalConfig(env = process.env) {
   const normalEnv = normalizeEnviromentVariables(env);
   return {
     "gb-token": {
@@ -90,34 +143,14 @@ function globalConfig(env = process.env) {
     }
   };
 }
-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",
-    "SAML",
-    "SCIM",
-    "PyPI"
-  ];
-  exceptions.filter((e) => value.includes(e)).forEach((ex) => {
-    cleaned = cleaned.replace(ex, ex.charAt(0).toUpperCase() + ex.slice(1).toLowerCase());
-  });
-  const decamelized = decamelize(cleaned, "-");
-  return decamelized !== cleaned ? decamelized : depascalize(cleaned, "-");
+function getExposedAPIs(map) {
+  const { Gitlab, ...expose } = map;
+  return expose;
 }
+
+// src/cli.ts
 function setupAPIMethods(setupArgs, methodArgs) {
   methodArgs.forEach((name) => {
-    if (typeof name !== "string")
-      return;
     setupArgs.positional(`[--${param(name)}] <${param(name)}>`, {
       group: "Required Options",
       type: "string"
@@ -126,20 +159,8 @@ function setupAPIMethods(setupArgs, methodArgs) {
   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 globalConfig = getGlobalConfig();
+  const { initArgs, coreArgs, optionalArgs } = buildArgumentObjects(globalConfig, method, args);
   const s = new Gitbeaker[apiName](initArgs);
   return s[method.name](...Object.values(coreArgs), optionalArgs).then((r) => {
     ctx.output = JSON.stringify(r, null, 3);
@@ -148,7 +169,8 @@ function runAPIMethod(ctx, args, apiName, method) {
   });
 }
 function setupAPIs(setupArgs, apiName, methods) {
-  Object.entries(globalConfig()).forEach(([k, v]) => {
+  const globalConfig = getGlobalConfig();
+  Object.entries(globalConfig).forEach(([k, v]) => {
     setupArgs.option(`${k} <value>`, {
       group: "Base Options",
       ...v
@@ -163,14 +185,20 @@ function setupAPIs(setupArgs, apiName, methods) {
   }
   return setupArgs;
 }
+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");
 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)
+  usagePrefix: usageStyle,
+  group: groupStyle,
+  flags: optionStyle,
+  usageCommandPlaceholder: commandStyle,
+  usageOptionsPlaceholder: optionStyle,
+  desc: descriptionStyle,
+  hints: hintStyle
 });
 cli.boolean("-g --global-args", {
   desc: "Show global arguments currently set in the environment variables"
@@ -178,21 +206,12 @@ cli.boolean("-g --global-args", {
 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
-    };
-  });
+  const globalConfig = getGlobalConfig();
+  const display = getDisplayConfig(globalConfig);
   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;
+var exposedAPIs = getExposedAPIs(API_MAP);
+Object.entries(exposedAPIs).forEach(([apiName, methods]) => {
   cli.command(param(apiName), {
     desc: `The ${apiName} API`,
     setup: (setupArgs) => setupAPIs(setupArgs, apiName, methods)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitbeaker/cli",
-  "version": "38.0.1",
+  "version": "38.1.1",
   "description": "CLI implementation of the GitLab API.",
   "license": "MIT",
   "engines": {
@@ -32,7 +32,7 @@
   ],
   "scripts": {
     "build": "tsup src/index.ts --format esm --treeshake --target node18",
-    "test:integration": "jest --maxWorkers=50% test/integration",
+    "test:unit": "jest --maxWorkers=50% test/unit",
     "test:e2e": "jest --maxWorkers=50% test/e2e",
     "format:docs": "prettier '**/(*.json|.yml|.js|.md)' --ignore-path ../../.prettierignore",
     "format:docs:fix": "yarn format:docs --write",
@@ -47,8 +47,8 @@
     "release": "auto shipit"
   },
   "dependencies": {
-    "@gitbeaker/core": "^38.0.1",
-    "@gitbeaker/rest": "^38.0.1",
+    "@gitbeaker/core": "^38.1.1",
+    "@gitbeaker/rest": "^38.1.1",
     "chalk": "4.1.2",
     "sywac": "^1.3.0",
     "xcase": "^2.0.1"
@@ -57,5 +57,5 @@
     "tsup": "^6.7.0",
     "typescript": "^5.0.4"
   },
-  "gitHead": "8bb3ef8e1cef6bf85e52c32d9390829b5d92e97d"
+  "gitHead": "747a6a0e960524895b3fb852e5f51ca2d9f8d682"
 }