@catladder/cli 0.0.0-refactor-cli-add-improved-git-utilities-224e6ee7 → 0.0.0-refactor-cli-add-improved-git-utilities-583a3a54

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "0.0.0-refactor-cli-add-improved-git-utilities-224e6ee7",
+  "version": "0.0.0-refactor-cli-add-improved-git-utilities-583a3a54",
   "scripts": {
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix",

package/src/gitlab/apiClient.ts

@@ -15,6 +15,6 @@ export const gitlabApiClient = async ({
   }
   return new Gitlab({
     token,
-    host: gitRemoteHost,
+    host: `https://${gitRemoteHost}`,
   });
 };

package/src/gitlab/getGitlabProjectInfo.ts

@@ -0,0 +1,25 @@
+import type { ProjectSchema } from "@gitbeaker/rest";
+import { getGitRemoteHostAndPath } from "../git/getGitRemoteHostAndPath";
+import { gitlabApiClient } from "./apiClient";
+import {
+  upsertProjectPerferences,
+  getProjectPreferences,
+} from "../utils/projectPreferences";
+
+export const getGitlabProjectInfo = async (): Promise<ProjectSchema> => {
+  const api = await gitlabApiClient();
+  const { gitRemotePath } = await getGitRemoteHostAndPath();
+  const projectInfo = await api.Projects.show(gitRemotePath);
+  // write unawaited intentionally
+  upsertProjectPerferences({ gitlabProjectId: projectInfo.id });
+  return projectInfo;
+};
+
+export const getGitlabProjectId = async (): Promise<number> => {
+  const { gitlabProjectId } = await getProjectPreferences();
+  if (gitlabProjectId) {
+    return gitlabProjectId;
+  }
+  const projectInfo = await getGitlabProjectInfo();
+  return projectInfo.id;
+};

package/src/utils/preferences.ts

@@ -1,9 +1,11 @@
-import { createFile, pathExists, readFile, writeFile } from "fs-extra";
+import { writeFile, readFile, mkdir } from "fs/promises";
+import { existsSync } from "fs";
 import { homedir } from "os";
-
 import { parse, stringify } from "yaml";
-const directory = `${homedir()}/.catladder`;
-const file = `${directory}/preferences.yml`;
+import { join } from "path";
+
+const directory = join(homedir(), ".catladder");
+const file = join(directory, "preferences.yml");
 
 export type CatladderCliPreferences = {
   "gitlab-personal-access-token": string | null;
@@ -15,7 +17,7 @@ const perfKeys = [
   "gitlab-personal-access-token",
   "googleAuthUserNumber",
   "gitlabTokens",
-] as const;
+] as const satisfies readonly PreferenceKey[];
 
 const fallbackValues = {
   "gitlab-personal-access-token": null,
@@ -23,23 +25,47 @@ const fallbackValues = {
   googleAuthUserNumber: null,
 } satisfies CatladderCliPreferences;
 
-export const getPreferences = async (): Promise<CatladderCliPreferences> => {
-  if (!(await pathExists(file))) {
-    await createFile(file);
-  }
-  const fileString = await readFile(file, { encoding: "utf-8" });
-  const fileParsed = parse(fileString || "---\nnull") ?? {};
-  return perfKeys.reduce(
+const perferencesWithParsed = (
+  parsed: Partial<CatladderCliPreferences>,
+): CatladderCliPreferences =>
+  perfKeys.reduce(
     (acc, key) =>
-      Object.assign(acc, { [key]: fileParsed[key] ?? fallbackValues[key] }),
+      Object.assign(acc, { [key]: parsed[key] ?? fallbackValues[key] }),
     {} as CatladderCliPreferences,
   );
+
+const encoding = "utf-8";
+
+const readPreferences = () => readFile(file, { encoding });
+
+const writePreferences = (preferences: CatladderCliPreferences) =>
+  writeFile(file, stringify(preferences), { encoding, mode: 0o600 });
+
+const ensureDir = async () =>
+  existsSync(directory)
+    ? directory
+    : mkdir(directory, { recursive: true, mode: 0o700 });
+
+const ensureFile = async () => {
+  if (existsSync(file)) {
+    return file;
+  }
+  await ensureDir();
+  return writePreferences(perferencesWithParsed({}));
+};
+
+export const getPreferences = async (): Promise<CatladderCliPreferences> => {
+  await ensureFile();
+  const fileString = await readPreferences();
+  const fileParsed = parse(fileString || "---\nnull") ?? {};
+  return perferencesWithParsed(fileParsed);
 };
 
 export const hasPreference = async (key: PreferenceKey) => {
   const preferences = await getPreferences();
   return preferences[key] !== null && preferences[key] !== undefined;
 };
+
 export const getPreference = async <K extends PreferenceKey>(
   key: K,
 ): Promise<CatladderCliPreferences[K] | null> => {
@@ -55,11 +81,5 @@ export const setPreference = async (
   value: CatladderCliPreferences[typeof key],
 ) => {
   const preferences = await getPreferences();
-
-  const newPreferences = {
-    ...preferences,
-    [key]: value,
-  };
-
-  await writeFile(file, stringify(newPreferences));
+  return writePreferences({ ...preferences, [key]: value });
 };

package/src/utils/projectPreferences.ts

@@ -0,0 +1,81 @@
+import { writeFile, readFile, mkdir } from "fs/promises";
+import { existsSync } from "fs";
+import { join } from "path";
+import { getProjectRootPath } from "../git";
+
+const directory = ".catladder";
+const file = "preferences.json";
+
+export type CatladderCliProjectPreferences = {
+  gitlabProjectId?: number | null;
+  gitlabHttpUrlToRepo?: string | null;
+};
+type ProjectPreferenceKey = keyof CatladderCliProjectPreferences;
+const perfKeys = [
+  "gitlabProjectId",
+  "gitlabHttpUrlToRepo",
+] as const satisfies readonly ProjectPreferenceKey[];
+const fallbackValues = {
+  gitlabProjectId: null,
+  gitlabHttpUrlToRepo: null,
+} satisfies CatladderCliProjectPreferences;
+
+const perferencesWithParsed = (
+  parsed: Partial<CatladderCliProjectPreferences>,
+): CatladderCliProjectPreferences =>
+  perfKeys.reduce(
+    (acc, key) =>
+      Object.assign(acc, { [key]: parsed[key] ?? fallbackValues[key] ?? null }),
+    {} as CatladderCliProjectPreferences,
+  );
+
+const encoding = "utf-8";
+
+const readPreferences = (filePath: string) => readFile(filePath, { encoding });
+
+const writePreferences = (
+  filePath: string,
+  preferences: CatladderCliProjectPreferences,
+) =>
+  writeFile(filePath, JSON.stringify(preferences, null, 2), {
+    encoding,
+    mode: 0o600,
+  });
+
+const ensureDir = async (dirPath: string) =>
+  existsSync(dirPath)
+    ? dirPath
+    : mkdir(dirPath, { recursive: true, mode: 0o700 });
+
+const ensureFile = async (givenFilePath?: string) => {
+  if (givenFilePath?.length && existsSync(givenFilePath)) {
+    return givenFilePath;
+  }
+  const rootPath = await getProjectRootPath();
+  const dirPath = join(rootPath, directory);
+  const filePath = join(dirPath, file);
+  if (existsSync(filePath)) {
+    return filePath;
+  }
+  await ensureDir(dirPath);
+  await writePreferences(filePath, perferencesWithParsed({}));
+  return filePath;
+};
+
+export const getProjectPreferences = async (
+  givenFilePath?: string,
+): Promise<CatladderCliProjectPreferences> => {
+  const filePath = await ensureFile(givenFilePath);
+  const fileString = await readPreferences(filePath);
+  const fileParsed = JSON.parse(fileString || "null") ?? {};
+  return perferencesWithParsed(fileParsed);
+};
+
+export const upsertProjectPerferences = async (
+  newPerfs: Partial<CatladderCliProjectPreferences> = {},
+  givenFilePath?: string,
+) => {
+  const filePath = await ensureFile(givenFilePath);
+  const currentPerfs = await getProjectPreferences(filePath);
+  return writePreferences(filePath, { ...currentPerfs, ...newPerfs });
+};