@catladder/cli 2.5.0 → 2.6.1

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "2.5.0",
+  "version": "2.6.1",
   "scripts": {
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix",

package/src/git/gitConfig.ts

@@ -0,0 +1,32 @@
+import { exec } from "child-process-promise";
+
+export type GitLocationScope = "global" | "local" | "system" | "worktree";
+export type GitConfigOptions = {
+  location?: GitLocationScope;
+  comment?: string;
+};
+
+const argsJoin = (args: (string | undefined)[]): string =>
+  args.filter(Boolean).join(" ");
+
+export async function gitConfigGet(
+  key: string,
+  { location }: Pick<GitConfigOptions, "location"> = {},
+) {
+  const { stdout } = await exec(
+    `git config get ${argsJoin([location ? `--${location}` : undefined])} ${key}`,
+  );
+  return stdout.trim();
+}
+
+export const gitConfigSet = (
+  key: string,
+  value: string,
+  { location, comment }: GitConfigOptions = {},
+) =>
+  exec(
+    `git config set ${argsJoin([
+      location ? `--${location}` : undefined,
+      comment ? `--comment=${comment}` : undefined,
+    ])} ${key} ${value}`,
+  );

package/src/git/gitProjectInformation.ts

@@ -0,0 +1,40 @@
+import { gitConfigGet } from "./gitConfig";
+import { exec } from "child-process-promise";
+
+/**
+ * Find the absolute path of the current git project root.
+ */
+export const getProjectRootPath = async (): Promise<string> => {
+  const { stdout } = await exec(`git rev-parse --show-toplevel`);
+  return stdout.trim();
+};
+
+/**
+ * Get the git remote hostname and project path from the git config.
+ */
+export const getGitRemoteHostAndPath = async (): Promise<{
+  gitRemoteHost: string;
+  gitRemotePath: string;
+}> => {
+  const remoteUrl = await gitConfigGet("remote.origin.url");
+  const remoteReg = /(https:\/\/|git@)([^:/]+)[:/]([^.]*)(\.git)?/;
+  const match = remoteUrl.match(remoteReg) ?? [];
+  const [, , gitRemoteHost, gitRemotePath] = match;
+  if (!gitRemoteHost?.length || !gitRemotePath?.length) {
+    throw new Error(
+      `Failed to parse git remote hostname and path from git configs remote.origin.url! ${remoteUrl}`,
+    );
+  }
+  return { gitRemoteHost, gitRemotePath };
+};
+
+export const gitProjectInformation = async () => {
+  const [{ gitRemoteHost, gitRemotePath }, projectRootPath] = await Promise.all(
+    [getGitRemoteHostAndPath(), getProjectRootPath()],
+  );
+  return {
+    gitRemoteHost,
+    gitRemotePath,
+    projectRootPath,
+  };
+};

package/src/git/index.ts

@@ -0,0 +1,2 @@
+export * from "./gitConfig";
+export * from "./gitProjectInformation";

package/src/utils/gitlab.ts

@@ -1,11 +1,11 @@
 import { getSecretVarName } from "@catladder/pipeline";
-import { exec } from "child-process-promise";
 import { has, isObject } from "lodash";
 import memoizee from "memoizee";
 import fetch from "node-fetch";
 import open from "open";
 import type { CommandInstance } from "vorpal";
 import { getPreference, hasPreference, setPreference } from "./preferences";
+import { getGitRemoteHostAndPath } from "../git/gitProjectInformation";
 
 const TOKEN_KEY = "gitlab-personal-access-token";
 
@@ -17,14 +17,17 @@ export const setupGitlabToken = async (vorpal: CommandInstance) => {
   vorpal.log("");
   vorpal.log("☝ we open up the settings page for you!");
   vorpal.log("");
-  const { shouldContinue } = await vorpal.prompt({
-    default: true,
-    message: "Ok",
-    name: "shouldContinue",
-    type: "prompt",
-  });
-
-  open("https://git.panter.ch/-/profile/personal_access_tokens");
+  const [{ shouldContinue }, { gitRemoteHost }] = await Promise.all([
+    vorpal.prompt({
+      default: true,
+      message: "Ok",
+      name: "shouldContinue",
+      type: "prompt",
+    }),
+    getGitRemoteHostAndPath(),
+  ]);
+
+  open(`https://${gitRemoteHost}/-/profile/personal_access_tokens`);
 
   vorpal.log("Please type in gitlab's personal access token");
 
@@ -58,11 +61,14 @@ export const doGitlabRequest = async <T = any>(
   data: any = undefined,
   method: Method = "GET",
 ): Promise<T> => {
-  const rootToken = await getGitlabToken(vorpal);
+  const [rootToken, { gitRemoteHost }] = await Promise.all([
+    getGitlabToken(vorpal),
+    getGitRemoteHostAndPath(),
+  ]);
 
   //const method = data ? (update ? "PUT" : "POST") : "GET";
 
-  const result = await fetch(`https://git.panter.ch/api/v4/${path}`, {
+  const result = await fetch(`https://${gitRemoteHost}/api/v4/${path}`, {
     method,
     headers: {
       "Content-Type": "application/json",
@@ -91,16 +97,10 @@ export const doGitlabRequest = async <T = any>(
 export const getProjectInfo = async (
   vorpal: CommandInstance | null,
 ): Promise<{ id: string; web_url: string }> => {
-  const gitRemoteOriginUrl = (
-    await exec("git config --get remote.origin.url")
-  ).stdout.trim();
-  const projectPath =
-    /(https:\/\/|git@)git\.panter\.ch[:/]([^.]*)(\.git)?/g.exec(
-      gitRemoteOriginUrl,
-    );
+  const { gitRemotePath } = await getGitRemoteHostAndPath();
   const project = await doGitlabRequest(
     vorpal,
-    `projects/${encodeURIComponent(projectPath[2])}`,
+    `projects/${encodeURIComponent(gitRemotePath)}`,
   );
   return project;
 };

package/src/utils/preferences.ts

@@ -0,0 +1,56 @@
+import { readFile, writeFile, mkdir } from "fs/promises";
+import { existsSync } from "fs";
+import { join, dirname } from "path";
+import { homedir } from "os";
+import { parse, stringify } from "yaml";
+
+const legacyPreferencesPath = join(homedir(), ".catladder/preferences.yml");
+const preferencesPath = join(homedir(), ".config/catladder/preferences.yml");
+
+const ensurePreferencesFile = async () => {
+  if (existsSync(preferencesPath)) {
+    return preferencesPath;
+  }
+  await mkdir(dirname(preferencesPath), { recursive: true, mode: 0o700 });
+  await writeFile(preferencesPath, "---\n{}", {
+    encoding: "utf-8",
+    mode: 0o600,
+  });
+  if (existsSync(legacyPreferencesPath)) {
+    return legacyPreferencesPath;
+  }
+  return preferencesPath;
+};
+
+const loadPreferences = async () => {
+  const currentLoadPath = await ensurePreferencesFile();
+  return readFile(currentLoadPath, { encoding: "utf-8" });
+};
+
+const getPreferences = async () => {
+  const yamlContent = await loadPreferences();
+  return (parse(yamlContent) ?? {}) as Record<string, string>;
+};
+
+export const hasPreference = async (key: string) => {
+  const preferences = await getPreferences();
+  return key in preferences;
+};
+export const getPreference = async (key: string) => {
+  const preferences = await getPreferences();
+  return preferences[key];
+};
+
+export const setPreference = async (key: string, value: string | number) => {
+  const preferences = await getPreferences();
+
+  const newPreferences = {
+    ...preferences,
+    [key]: value,
+  };
+
+  await writeFile(legacyPreferencesPath, stringify(newPreferences), {
+    encoding: "utf-8",
+    mode: 0o600,
+  });
+};

package/dist/cli/src/utils/preferences/index.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setPreference = exports.getPreference = exports.hasPreference = void 0;
-const fs_extra_1 = require("fs-extra");
-const os_1 = require("os");
-const yaml_1 = require("yaml");
-const directory = `${(0, os_1.homedir)()}/.catladder`;
-const file = `${directory}/preferences.yml`;
-const getPreferences = async () => {
-    var _a;
-    if (!(await (0, fs_extra_1.pathExists)(file))) {
-        await (0, fs_extra_1.createFile)(file);
-    }
-    return ((_a = (0, yaml_1.parse)(await (0, fs_extra_1.readFile)(file, { encoding: "utf-8" }))) !== null && _a !== void 0 ? _a : {});
-};
-const hasPreference = async (key) => {
-    const preferences = await getPreferences();
-    return key in preferences;
-};
-exports.hasPreference = hasPreference;
-const getPreference = async (key) => {
-    const preferences = await getPreferences();
-    return preferences[key];
-};
-exports.getPreference = getPreference;
-const setPreference = async (key, value) => {
-    const preferences = await getPreferences();
-    const newPreferences = {
-        ...preferences,
-        [key]: value,
-    };
-    await (0, fs_extra_1.writeFile)(file, (0, yaml_1.stringify)(newPreferences));
-};
-exports.setPreference = setPreference;
-//# sourceMappingURL=index.js.map

package/dist/cli/src/utils/preferences/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/utils/preferences/index.ts"],"names":[],"mappings":";;;AAAA,uCAAuE;AACvE,2BAA6B;AAE7B,+BAAwC;AACxC,MAAM,SAAS,GAAG,GAAG,IAAA,YAAO,GAAE,aAAa,CAAC;AAC5C,MAAM,IAAI,GAAG,GAAG,SAAS,kBAAkB,CAAC;AAE5C,MAAM,cAAc,GAAG,KAAK,IAAI,EAAE;;IAChC,IAAI,CAAC,CAAC,MAAM,IAAA,qBAAU,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAA,qBAAU,EAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IACD,OAAO,CAAC,MAAA,IAAA,YAAK,EAAC,MAAM,IAAA,mBAAQ,EAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,mCAAI,EAAE,CAG/D,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,aAAa,GAAG,KAAK,EAAE,GAAW,EAAE,EAAE;IACjD,MAAM,WAAW,GAAG,MAAM,cAAc,EAAE,CAAC;IAC3C,OAAO,GAAG,IAAI,WAAW,CAAC;AAC5B,CAAC,CAAC;AAHW,QAAA,aAAa,iBAGxB;AACK,MAAM,aAAa,GAAG,KAAK,EAAE,GAAW,EAAE,EAAE;IACjD,MAAM,WAAW,GAAG,MAAM,cAAc,EAAE,CAAC;IAC3C,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC,CAAC;AAHW,QAAA,aAAa,iBAGxB;AAEK,MAAM,aAAa,GAAG,KAAK,EAAE,GAAW,EAAE,KAAsB,EAAE,EAAE;IACzE,MAAM,WAAW,GAAG,MAAM,cAAc,EAAE,CAAC;IAE3C,MAAM,cAAc,GAAG;QACrB,GAAG,WAAW;QACd,CAAC,GAAG,CAAC,EAAE,KAAK;KACb,CAAC;IAEF,MAAM,IAAA,oBAAS,EAAC,IAAI,EAAE,IAAA,gBAAS,EAAC,cAAc,CAAC,CAAC,CAAC;AACnD,CAAC,CAAC;AATW,QAAA,aAAa,iBASxB"}

package/src/utils/preferences/index.ts

@@ -1,36 +0,0 @@
-import { createFile, pathExists, readFile, writeFile } from "fs-extra";
-import { homedir } from "os";
-
-import { parse, stringify } from "yaml";
-const directory = `${homedir()}/.catladder`;
-const file = `${directory}/preferences.yml`;
-
-const getPreferences = async () => {
-  if (!(await pathExists(file))) {
-    await createFile(file);
-  }
-  return (parse(await readFile(file, { encoding: "utf-8" })) ?? {}) as Record<
-    string,
-    string
-  >;
-};
-
-export const hasPreference = async (key: string) => {
-  const preferences = await getPreferences();
-  return key in preferences;
-};
-export const getPreference = async (key: string) => {
-  const preferences = await getPreferences();
-  return preferences[key];
-};
-
-export const setPreference = async (key: string, value: string | number) => {
-  const preferences = await getPreferences();
-
-  const newPreferences = {
-    ...preferences,
-    [key]: value,
-  };
-
-  await writeFile(file, stringify(newPreferences));
-};