config.ts

/* eslint-disable @typescript-eslint/camelcase */

import Git from "nodegit";

import { SpecifiableGitStackedRebaseOptions } from "./options";
import { getGitConfig__internal } from "./internal";

import { nativeConfigGet } from "./native-git/config";

export const configKeyPrefix = "stackedrebase" as const;

export type ConfigKeys = typeof configKeys;
export type ConfigKey = keyof ConfigKeys;

export const configKeys = {
	gpgSign: "commit.gpgSign",
	autoApplyIfNeeded: `${configKeyPrefix}.autoApplyIfNeeded`,
	autoSquash: "rebase.autoSquash",
	autoOpenPRUrlsInBrowser: `${configKeyPrefix}.autoOpenPRUrlsInBrowser`,
	ignoredBranches: `${configKeyPrefix}.ignoredBranches`,
} as const;

export async function loadGitConfig(
	repo: Git.Repository,
	specifiedOptions: SpecifiableGitStackedRebaseOptions
): Promise<Git.Config> {
	return getGitConfig__internal in specifiedOptions
		? await specifiedOptions[getGitConfig__internal]!({ GitConfig: Git.Config, repo })
		: await Git.Config.openDefault();
}

/**
 * DON'T FORGET TO UPDATE `_BaseOptionsForGitStackedRebase_Optional` in options.ts
 */
export type ConfigValues = {
	gpgSign: boolean | undefined;
	autoApplyIfNeeded: boolean | undefined;
	autoSquash: boolean | undefined;
	autoOpenPRUrlsInBrowser: "always" | "ask" | "never";

	/**
	 *
	 * @EXPERIMENTAL
	 * currently only matters for `getStackedBranchesReadyForStackedPRs`;
	 * in future should be expanded to work across all GSR operations.
	 *
	 * ---
	 *
	 * branches to ignore in the stack.
	 *
	 * should be specified before invoking git-stacked-rebase;
	 * specifying when in progress / in between commands can cause undefined behavior.
	 *
	 * matches substrings, e.g. if `night` is specified,
	 * `nightly` will match & will be ignored.
	 */
	ignoredBranches: string[];
};

export const defaultConfigValues: Pick<ConfigValues, "autoOpenPRUrlsInBrowser"> = {
	autoOpenPRUrlsInBrowser: "ask",
}; // TODO TS satisfies ConfigValues

export async function resolveGitConfigValues(config: Git.Config): Promise<ConfigValues> {
	/**
	 * beware:
	 * libgit's Git.Config is always taking from global, and ignoring local,
	 * which is obviously incorrect and not what we want...
	 *
	 * this (mostly) does not matter, until a user wants to configure per-project settings,
	 * which wasn't needed much, until `ignoredBranches` got implemented...
	 */
	const [
		gpgSign, //
		autoApplyIfNeeded,
		autoSquash,
		autoOpenPRUrlsInBrowser,
		ignoredBranches,
	] = await Promise.all([
		resolveConfigBooleanValue(config.getBool(configKeys.gpgSign)),
		resolveConfigBooleanValue(config.getBool(configKeys.autoApplyIfNeeded)),
		resolveConfigBooleanValue(config.getBool(configKeys.autoSquash)),
		resolveAutoOpenPRUrlsInBrowserValue(config.getStringBuf(configKeys.autoOpenPRUrlsInBrowser)),
		resolveConfigArrayValue(nativeConfigGet(configKeys.ignoredBranches)),
	]);

	const configValues: ConfigValues = {
		gpgSign,
		autoApplyIfNeeded,
		autoSquash,
		autoOpenPRUrlsInBrowser,
		ignoredBranches,
	};

	return configValues;
}

/**
 * there's a difference between a value set to false (intentionally disabled),
 * vs not set at all:
 * can then look thru lower level options providers, and take their value.
 *
 * ```
 * export const handleConfigBooleanValue = (x: Promise<number>) => x.then(Boolean).catch(() => undefined);
 * ```
 *
 * but actually, it doesn't matter here, because when we're trying to resolve (here),
 * our goal is to provide a final value that will be used by the program,
 * thus no `undefined`.
 *
 */
//
export const resolveConfigBooleanValue = (x: Promise<number>) => x.then(Boolean).catch(() => false);

export const resolveConfigArrayValue = (x: Promise<string>): Promise<string[]> =>
	x.then((x) => x.split(",")).catch(() => []);

export const resolveAutoOpenPRUrlsInBrowserValue = (
	pendingConfigValue: Promise<Git.Buf>
): Promise<ConfigValues["autoOpenPRUrlsInBrowser"]> => {
	const parse = (x: Git.Buf) =>
		autoOpenPRUrlsInBrowserAllowedValues.includes(x.ptr as ConfigValues["autoOpenPRUrlsInBrowser"])
			? (x.ptr as ConfigValues["autoOpenPRUrlsInBrowser"])
			: defaultConfigValues.autoOpenPRUrlsInBrowser;

	return pendingConfigValue
		.then(parse) //
		.catch(() => defaultConfigValues.autoOpenPRUrlsInBrowser);
};
export const autoOpenPRUrlsInBrowserAllowedValues: ConfigValues["autoOpenPRUrlsInBrowser"][] = [
	"always",
	"ask",
	"never",
];