git-chopstick-core 0.1.1 → 0.1.2

package/dist/git/config.d.ts

@@ -0,0 +1,98 @@
+import { Repository } from '../models/repository.js';
+/**
+ * Look up a config value by name in the repository.
+ *
+ * @param onlyLocal Whether or not the value to be retrieved should stick to
+ *                  the local repository settings. It is false by default. This
+ *                  is equivalent to using the `--local` argument in the
+ *                  `git config` invocation.
+ */
+export declare function getConfigValue(repository: Repository, name: string, onlyLocal?: boolean): Promise<string | null>;
+/** Look up a global config value by name. */
+export declare function getGlobalConfigValue(name: string, env?: {
+    HOME: string;
+}): Promise<string | null>;
+/**
+ * Look up a config value by name.
+ *
+ * Treats the returned value as a boolean as per Git's
+ * own definition of a boolean configuration value (i.e.
+ * 0 -> false, "off" -> false, "yes" -> true etc)
+ */
+export declare function getBooleanConfigValue(repository: Repository, name: string, onlyLocal?: boolean, env?: {
+    HOME: string;
+}): Promise<boolean | null>;
+/**
+ * Look up a global config value by name.
+ *
+ * Treats the returned value as a boolean as per Git's
+ * own definition of a boolean configuration value (i.e.
+ * 0 -> false, "off" -> false, "yes" -> true etc)
+ */
+export declare function getGlobalBooleanConfigValue(name: string, env?: {
+    HOME: string;
+}): Promise<boolean | null>;
+/**
+ * Get the path to the global git config
+ *
+ * Note: this uses git config --edit which will automatically create the global
+ * config file if it doesn't exist yet. The primary purpose behind this method
+ * is to support opening the global git config for editing.
+ */
+export declare const getGlobalConfigPath: (env?: {
+    HOME: string;
+}) => Promise<string>;
+/** Set the local config value by name. */
+export declare function setConfigValue(repository: Repository, name: string, value: string, env?: {
+    HOME: string;
+}): Promise<void>;
+/** Set the global config value by name. */
+export declare function setGlobalConfigValue(name: string, value: string, env?: {
+    HOME: string;
+}): Promise<void>;
+/** Set the global config value by name. */
+export declare function addGlobalConfigValue(name: string, value: string): Promise<void>;
+/**
+ * Adds a path to the `safe.directories` configuration variable if it's not
+ * already present. Adding a path to `safe.directory` will cause Git to ignore
+ * if the path is owner by a different user than the current.
+ */
+export declare function addSafeDirectory(path: string): Promise<void>;
+/** Set the global config value by name. */
+export declare function addGlobalConfigValueIfMissing(name: string, value: string): Promise<void>;
+/** Remove the local config value by name. */
+export declare function removeConfigValue(repository: Repository, name: string, env?: {
+    HOME: string;
+}): Promise<void>;
+/** Remove the global config value by name. */
+export declare function removeGlobalConfigValue(name: string, env?: {
+    HOME: string;
+}): Promise<void>;
+export interface IConfigValueOrigin {
+    readonly value: string;
+    readonly scope: string;
+    readonly origin: string;
+}
+/**
+ * Look up a config value along with its source file and scope.
+ * Requires Git 2.26+ for --show-scope.
+ */
+export declare function getConfigValueWithOrigin(repository: Repository, name: string): Promise<IConfigValueOrigin | null>;
+/**
+ * Extract the file path from a config value origin, stripping the `file:` prefix.
+ * When repositoryPath is provided, relative paths (e.g. `.git/config` for local
+ * scope) are resolved to absolute paths.
+ */
+export declare function getOriginFilePath(origin: IConfigValueOrigin, repositoryPath?: string): string;
+/**
+ * Check whether a global-scoped config value comes from a conditionally
+ * included file (via includeIf directive) rather than a standard location.
+ */
+export declare function isConditionalInclude(origin: IConfigValueOrigin): boolean;
+/** Format a human-readable scope description for a config value origin. */
+export declare function formatConfigScope(origin: IConfigValueOrigin): string;
+/**
+ * Format the file path for a config value origin.
+ * For local/worktree scope, displays the path with a `<repo>` prefix.
+ */
+export declare function formatConfigPath(origin: IConfigValueOrigin, repositoryPath: string): string;

package/dist/git/config.js

@@ -0,0 +1,249 @@
+import { git } from './core.js';
+import { normalize } from 'path';
+/**
+ * Look up a config value by name in the repository.
+ *
+ * @param onlyLocal Whether or not the value to be retrieved should stick to
+ *                  the local repository settings. It is false by default. This
+ *                  is equivalent to using the `--local` argument in the
+ *                  `git config` invocation.
+ */
+export function getConfigValue(repository, name, onlyLocal = false) {
+    return getConfigValueInPath(name, repository.path, onlyLocal);
+}
+/** Look up a global config value by name. */
+export function getGlobalConfigValue(name, env) {
+    return getConfigValueInPath(name, null, false, undefined, env);
+}
+/**
+ * Look up a config value by name.
+ *
+ * Treats the returned value as a boolean as per Git's
+ * own definition of a boolean configuration value (i.e.
+ * 0 -> false, "off" -> false, "yes" -> true etc)
+ */
+export async function getBooleanConfigValue(repository, name, onlyLocal = false, env) {
+    const value = await getConfigValueInPath(name, repository.path, onlyLocal, 'bool', env);
+    return value === null ? null : value !== 'false';
+}
+/**
+ * Look up a global config value by name.
+ *
+ * Treats the returned value as a boolean as per Git's
+ * own definition of a boolean configuration value (i.e.
+ * 0 -> false, "off" -> false, "yes" -> true etc)
+ */
+export async function getGlobalBooleanConfigValue(name, env) {
+    const value = await getConfigValueInPath(name, null, false, 'bool', env);
+    return value === null ? null : value !== 'false';
+}
+/**
+ * Look up a config value by name
+ *
+ * @param path      The path to execute the `git` command in. If null
+ *                  we'll use the global configuration (i.e. --global)
+ *                  and execute the Git call from the same location that
+ *                  GitHub Desktop is installed in.
+ * @param onlyLocal Whether or not the value to be retrieved should stick to
+ *                  the local repository settings (if a path is specified). It
+ *                  is false by default. It is equivalent to using the `--local`
+ *                  argument in the `git config` invocation.
+ * @param type      Canonicalize configuration values according to the
+ *                  expected type (i.e. 0 -> false, "on" -> true etc).
+ *                  See `--type` documentation in `git config`
+ */
+async function getConfigValueInPath(name, path, onlyLocal = false, type, env) {
+    const flags = ['config', '-z'];
+    if (!path) {
+        flags.push('--global');
+    }
+    else if (onlyLocal) {
+        flags.push('--local');
+    }
+    if (type !== undefined) {
+        flags.push('--type', type);
+    }
+    flags.push(name);
+    const result = await git(flags, path || __dirname, 'getConfigValueInPath', {
+        successExitCodes: new Set([0, 1]),
+        env,
+    });
+    // Git exits with 1 if the value isn't found. That's OK.
+    if (result.exitCode === 1) {
+        return null;
+    }
+    const output = result.stdout;
+    const pieces = output.split('\0');
+    return pieces[0];
+}
+/**
+ * Get the path to the global git config
+ *
+ * Note: this uses git config --edit which will automatically create the global
+ * config file if it doesn't exist yet. The primary purpose behind this method
+ * is to support opening the global git config for editing.
+ */
+export const getGlobalConfigPath = (env) => git(['config', '--edit', '--global'], __dirname, 'getGlobalConfigPath', {
+    // We're using printf instead of echo because echo could attempt to decode
+    // escape sequences like \n which would be bad in a case like
+    // c:\Users\niik\.gitconfig
+    //         ^^
+    env: { ...env, GIT_EDITOR: 'printf %s' },
+}).then(x => normalize(x.stdout));
+/** Set the local config value by name. */
+export async function setConfigValue(repository, name, value, env) {
+    return setConfigValueInPath(name, value, repository.path, env);
+}
+/** Set the global config value by name. */
+export async function setGlobalConfigValue(name, value, env) {
+    return setConfigValueInPath(name, value, null, env);
+}
+/** Set the global config value by name. */
+export async function addGlobalConfigValue(name, value) {
+    await git(['config', '--global', '--add', name, value], __dirname, 'addGlobalConfigValue');
+}
+/**
+ * Adds a path to the `safe.directories` configuration variable if it's not
+ * already present. Adding a path to `safe.directory` will cause Git to ignore
+ * if the path is owner by a different user than the current.
+ */
+export async function addSafeDirectory(path) {
+    // UNC-paths on Windows need to be prefixed with `%(prefix)/`, see
+    // https://github.com/git-for-windows/git/commit/e394a16023cbb62784e380f70ad8a833fb960d68
+    if (process.platform === 'win32' && path[0] === '/') {
+        path = `%(prefix)/${path}`;
+    }
+    await addGlobalConfigValueIfMissing('safe.directory', path);
+}
+/** Set the global config value by name. */
+export async function addGlobalConfigValueIfMissing(name, value) {
+    const { stdout, exitCode } = await git(['config', '--global', '-z', '--get-all', name, value], __dirname, 'addGlobalConfigValue', { successExitCodes: new Set([0, 1]) });
+    if (exitCode === 1 || !stdout.split('\0').includes(value)) {
+        await addGlobalConfigValue(name, value);
+    }
+}
+/**
+ * Set config value by name
+ *
+ * @param path The path to execute the `git` command in. If null
+ *             we'll use the global configuration (i.e. --global)
+ *             and execute the Git call from the same location that
+ *             GitHub Desktop is installed in.
+ */
+async function setConfigValueInPath(name, value, path, env) {
+    const options = env ? { env } : undefined;
+    const flags = ['config'];
+    if (!path) {
+        flags.push('--global');
+    }
+    flags.push('--replace-all', name, value);
+    await git(flags, path || __dirname, 'setConfigValueInPath', options);
+}
+/** Remove the local config value by name. */
+export async function removeConfigValue(repository, name, env) {
+    return removeConfigValueInPath(name, repository.path, env);
+}
+/** Remove the global config value by name. */
+export async function removeGlobalConfigValue(name, env) {
+    return removeConfigValueInPath(name, null, env);
+}
+/**
+ * Remove config value by name
+ *
+ * @param path The path to execute the `git` command in. If null
+ *             we'll use the global configuration (i.e. --global)
+ *             and execute the Git call from the same location that
+ *             GitHub Desktop is installed in.
+ */
+async function removeConfigValueInPath(name, path, env) {
+    const options = env ? { env } : undefined;
+    const flags = ['config'];
+    if (!path) {
+        flags.push('--global');
+    }
+    flags.push('--unset-all', name);
+    await git(flags, path || __dirname, 'removeConfigValueInPath', options);
+}
+/**
+ * Look up a config value along with its source file and scope.
+ * Requires Git 2.26+ for --show-scope.
+ */
+export async function getConfigValueWithOrigin(repository, name) {
+    const result = await git(['config', '--show-origin', '--show-scope', '-z', name], repository.path, 'getConfigValueWithOrigin', 
+    // 0 = found, 1 = key not set, 128 = not a git repo or git error
+    { successExitCodes: new Set([0, 1, 128]) });
+    if (result.exitCode !== 0) {
+        return null;
+    }
+    const parts = result.stdout.split('\0');
+    if (parts.length >= 3) {
+        return {
+            scope: parts[0],
+            origin: parts[1],
+            value: parts[2],
+        };
+    }
+    return null;
+}
+/**
+ * Extract the file path from a config value origin, stripping the `file:` prefix.
+ * When repositoryPath is provided, relative paths (e.g. `.git/config` for local
+ * scope) are resolved to absolute paths.
+ */
+export function getOriginFilePath(origin, repositoryPath) {
+    const filePath = origin.origin.replace(/^file:/, '');
+    // Git returns relative paths for local/worktree scope (e.g. `.git/config`)
+    if (repositoryPath && !/^([a-zA-Z]:|[/\\])/.test(filePath)) {
+        const base = repositoryPath.replace(/[\\/]+$/, '');
+        return `${base}/${filePath}`;
+    }
+    return filePath;
+}
+/**
+ * Check whether a global-scoped config value comes from a conditionally
+ * included file (via includeIf directive) rather than a standard location.
+ */
+export function isConditionalInclude(origin) {
+    if (origin.scope !== 'global') {
+        return false;
+    }
+    const filePath = getOriginFilePath(origin);
+    return (!/[/\\]\.gitconfig$/i.test(filePath) &&
+        !/[/\\]\.config[/\\]git[/\\]config$/i.test(filePath));
+}
+/** Format a human-readable scope description for a config value origin. */
+export function formatConfigScope(origin) {
+    if (origin.scope === 'local') {
+        return 'local';
+    }
+    else if (origin.scope === 'system') {
+        return 'system';
+    }
+    else if (origin.scope === 'worktree') {
+        return 'worktree';
+    }
+    else if (origin.scope === 'global') {
+        return isConditionalInclude(origin) ? 'global, via [includeIf]' : 'global';
+    }
+    return origin.scope;
+}
+/**
+ * Format the file path for a config value origin.
+ * For local/worktree scope, displays the path with a `<repo>` prefix.
+ */
+export function formatConfigPath(origin, repositoryPath) {
+    const rawPath = origin.origin.replace(/^file:/, '');
+    if (origin.scope === 'local' || origin.scope === 'worktree') {
+        // Git returns relative paths for local scope (e.g. `.git/config`)
+        if (!/^([a-zA-Z]:|[/\\])/.test(rawPath)) {
+            return '<repo>/' + rawPath;
+        }
+        // Absolute path — strip repo prefix
+        const normalized = repositoryPath.replace(/[\\/]+$/, '');
+        if (rawPath.toLowerCase().startsWith(normalized.toLowerCase())) {
+            return '<repo>' + rawPath.slice(normalized.length);
+        }
+    }
+    return rawPath;
+}
+//# sourceMappingURL=config.js.map

package/dist/git/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/git/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AAE/B,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAEhC;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAC5B,UAAsB,EACtB,IAAY,EACZ,YAAqB,KAAK;IAE1B,OAAO,oBAAoB,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;AAC/D,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,oBAAoB,CAClC,IAAY,EACZ,GAEC;IAED,OAAO,oBAAoB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,CAAA;AAChE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,UAAsB,EACtB,IAAY,EACZ,YAAqB,KAAK,EAC1B,GAEC;IAED,MAAM,KAAK,GAAG,MAAM,oBAAoB,CACtC,IAAI,EACJ,UAAU,CAAC,IAAI,EACf,SAAS,EACT,MAAM,EACN,GAAG,CACJ,CAAA;IACD,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,OAAO,CAAA;AAClD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,IAAY,EACZ,GAEC;IAED,MAAM,KAAK,GAAG,MAAM,oBAAoB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;IACxE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,OAAO,CAAA;AAClD,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,oBAAoB,CACjC,IAAY,EACZ,IAAmB,EACnB,YAAqB,KAAK,EAC1B,IAAwE,EACxE,GAEC;IAED,MAAM,KAAK,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;IAC9B,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACxB,CAAC;SAAM,IAAI,SAAS,EAAE,CAAC;QACrB,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACvB,CAAC;IAED,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;IAC5B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAEhB,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,KAAK,EAAE,IAAI,IAAI,SAAS,EAAE,sBAAsB,EAAE;QACzE,gBAAgB,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACjC,GAAG;KACJ,CAAC,CAAA;IAEF,wDAAwD;IACxD,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;IAC5B,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACjC,OAAO,MAAM,CAAC,CAAC,CAAC,CAAA;AAClB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,GAAsB,EAAE,EAAE,CAC5D,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC,EAAE,SAAS,EAAE,qBAAqB,EAAE;IACtE,0EAA0E;IAC1E,6DAA6D;IAC7D,2BAA2B;IAC3B,aAAa;IACb,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,UAAU,EAAE,WAAW,EAAE;CACzC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA;AAEnC,0CAA0C;AAC1C,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,UAAsB,EACtB,IAAY,EACZ,KAAa,EACb,GAEC;IAED,OAAO,oBAAoB,CAAC,IAAI,EAAE,KAAK,EAAE,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;AAChE,CAAC;AAED,2CAA2C;AAC3C,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,IAAY,EACZ,KAAa,EACb,GAEC;IAED,OAAO,oBAAoB,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;AACrD,CAAC;AAED,2CAA2C;AAC3C,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,IAAY,EACZ,KAAa;IAEb,MAAM,GAAG,CACP,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,EAC5C,SAAS,EACT,sBAAsB,CACvB,CAAA;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,IAAY;IACjD,kEAAkE;IAClE,yFAAyF;IACzF,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;QACpD,IAAI,GAAG,aAAa,IAAI,EAAE,CAAA;IAC5B,CAAC;IAED,MAAM,6BAA6B,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAA;AAC7D,CAAC;AAED,2CAA2C;AAC3C,MAAM,CAAC,KAAK,UAAU,6BAA6B,CACjD,IAAY,EACZ,KAAa;IAEb,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,GAAG,CACpC,CAAC,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,KAAK,CAAC,EACtD,SAAS,EACT,sBAAsB,EACtB,EAAE,gBAAgB,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CACtC,CAAA;IAED,IAAI,QAAQ,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1D,MAAM,oBAAoB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IACzC,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,oBAAoB,CACjC,IAAY,EACZ,KAAa,EACb,IAAmB,EACnB,GAEC;IAED,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;IAEzC,MAAM,KAAK,GAAG,CAAC,QAAQ,CAAC,CAAA;IAExB,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;IAExC,MAAM,GAAG,CAAC,KAAK,EAAE,IAAI,IAAI,SAAS,EAAE,sBAAsB,EAAE,OAAO,CAAC,CAAA;AACtE,CAAC;AAED,6CAA6C;AAC7C,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,UAAsB,EACtB,IAAY,EACZ,GAEC;IAED,OAAO,uBAAuB,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;AAC5D,CAAC;AAED,8CAA8C;AAC9C,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,IAAY,EACZ,GAEC;IAED,OAAO,uBAAuB,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;AACjD,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,uBAAuB,CACpC,IAAY,EACZ,IAAmB,EACnB,GAEC;IAED,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;IAEzC,MAAM,KAAK,GAAG,CAAC,QAAQ,CAAC,CAAA;IAExB,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAA;IAE/B,MAAM,GAAG,CAAC,KAAK,EAAE,IAAI,IAAI,SAAS,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAA;AACzE,CAAC;AAQD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,UAAsB,EACtB,IAAY;IAEZ,MAAM,MAAM,GAAG,MAAM,GAAG,CACtB,CAAC,QAAQ,EAAE,eAAe,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,CAAC,EACvD,UAAU,CAAC,IAAI,EACf,0BAA0B;IAC1B,gEAAgE;IAChE,EAAE,gBAAgB,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAC3C,CAAA;IAED,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACvC,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO;YACL,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;YACf,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;YAChB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;SAChB,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAA0B,EAC1B,cAAuB;IAEvB,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IACpD,2EAA2E;IAC3E,IAAI,cAAc,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3D,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAA;QAClD,OAAO,GAAG,IAAI,IAAI,QAAQ,EAAE,CAAA;IAC9B,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAA0B;IAC7D,IAAI,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAA;IACd,CAAC;IACD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAA;IAC1C,OAAO,CACL,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC;QACpC,CAAC,oCAAoC,CAAC,IAAI,CAAC,QAAQ,CAAC,CACrD,CAAA;AACH,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,iBAAiB,CAAC,MAA0B;IAC1D,IAAI,MAAM,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;QAC7B,OAAO,OAAO,CAAA;IAChB,CAAC;SAAM,IAAI,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO,QAAQ,CAAA;IACjB,CAAC;SAAM,IAAI,MAAM,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;QACvC,OAAO,UAAU,CAAA;IACnB,CAAC;SAAM,IAAI,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,QAAQ,CAAA;IAC5E,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAA;AACrB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAC9B,MAA0B,EAC1B,cAAsB;IAEtB,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IACnD,IAAI,MAAM,CAAC,KAAK,KAAK,OAAO,IAAI,MAAM,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;QAC5D,kEAAkE;QAClE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACxC,OAAO,SAAS,GAAG,OAAO,CAAA;QAC5B,CAAC;QACD,oCAAoC;QACpC,MAAM,UAAU,GAAG,cAAc,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAA;QACxD,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YAC/D,OAAO,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QACpD,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC"}

package/dist/git/core.d.ts

@@ -0,0 +1,167 @@
+import { GitError as DugiteError, ExecError } from './exec.js';
+export declare const isMaxBufferExceededError: (error: unknown) => error is ExecError & {
+    code: "ERR_CHILD_PROCESS_STDIO_MAXBUFFER";
+};
+export type TerminalOutput = string | Buffer | Buffer[];
+export type TerminalOutputListener = (cb: (chunk: TerminalOutput) => void) => {
+    unsubscribe: () => void;
+};
+export type TerminalOutputCallback = (subscribe: TerminalOutputListener) => void;
+export type HookProgress = {
+    readonly hookName: string;
+} & ({
+    readonly status: 'started';
+    readonly abort: () => void;
+} | {
+    readonly status: 'finished' | 'failed';
+});
+export type HookCallbackOptions = {
+    readonly onHookProgress?: (progress: HookProgress) => void;
+    readonly onHookFailure?: (hookName: string, terminalOutput: TerminalOutput) => Promise<'abort' | 'ignore'>;
+    readonly onTerminalOutputAvailable?: TerminalOutputCallback;
+};
+/**
+ * An extension of the execution options in dugite that
+ * allows us to piggy-back our own configuration options in the
+ * same object.
+ */
+export interface IGitExecutionOptions extends HookCallbackOptions {
+    readonly env?: Record<string, string | undefined>;
+    readonly stdin?: string;
+    readonly maxBuffer?: number;
+    readonly processCallback?: (process: any) => void;
+    readonly encoding?: BufferEncoding;
+    /**
+     * The exit codes which indicate success to the
+     * caller. Unexpected exit codes will be logged and an
+     * error thrown. Defaults to 0 if undefined.
+     */
+    readonly successExitCodes?: ReadonlySet<number>;
+    /**
+     * The git errors which are expected by the caller. Unexpected errors will
+     * be logged and an error thrown.
+     */
+    readonly expectedErrors?: ReadonlySet<DugiteError>;
+    /** Should it track & report LFS progress? */
+    readonly trackLFSProgress?: boolean;
+    /**
+     * Whether the command about to run is part of a background task or not.
+     * This affects error handling and UI such as credential prompts.
+     */
+    readonly isBackgroundTask?: boolean;
+    readonly interceptHooks?: string[];
+}
+/**
+ * The result of using `git`. This wraps dugite's results to provide
+ * the parsed error if one occurs.
+ */
+export interface IGitResult {
+    readonly stdout: string;
+    readonly stderr: string;
+    readonly exitCode: number;
+    /**
+     * The parsed git error. This will be null when the exit code is included in
+     * the `successExitCodes`, or when dugite was unable to parse the
+     * error.
+     */
+    readonly gitError: DugiteError | null;
+    /** The human-readable error description, based on `gitError`. */
+    readonly gitErrorDescription: string | null;
+    /**
+     * The path that the Git command was executed from, i.e. the
+     * process working directory (not to be confused with the Git
+     * working directory which is... super confusing, I know)
+     */
+    readonly path: string;
+}
+/** The result of shelling out to git using a string encoding (default) */
+export interface IGitStringResult extends IGitResult {
+    /** The standard output from git. */
+    readonly stdout: string;
+    /** The standard error output from git. */
+    readonly stderr: string;
+}
+export interface IGitStringExecutionOptions extends IGitExecutionOptions {
+    readonly encoding?: BufferEncoding;
+}
+export interface IGitBufferExecutionOptions extends Omit<IGitExecutionOptions, 'encoding'> {
+    readonly encoding: 'buffer';
+}
+/** The result of shelling out to git using a buffer encoding */
+export interface IGitBufferResult extends Omit<IGitResult, 'stdout' | 'stderr'> {
+    /** The standard output from git. */
+    readonly stdout: Buffer;
+    /** The standard error output from git. */
+    readonly stderr: Buffer;
+}
+export interface IGitFullResult extends IGitResult {
+    readonly stdout: string;
+    readonly stderr: string;
+    readonly exitCode: number;
+    readonly gitError: DugiteError | null;
+    readonly gitErrorDescription: string | null;
+    readonly path: string;
+}
+export declare class GitError extends Error {
+    /** The result from the failed command. */
+    readonly result: IGitResult;
+    /** The args for the failed command. */
+    readonly args: ReadonlyArray<string>;
+    /**
+     * Whether or not the error message is just the raw output of the git command.
+     */
+    readonly isRawMessage: boolean;
+    constructor(result: IGitResult, args: ReadonlyArray<string>, terminalOutput: string);
+}
+export declare const isGitError: (e: unknown, parsedError?: DugiteError) => e is GitError;
+/**
+ * Shell out to git with the given arguments, at the given path.
+ *
+ * @param args             The arguments to pass to `git`.
+ *
+ * @param path             The working directory path for the execution of the
+ *                         command.
+ *
+ * @param name             The name for the command based on its caller's
+ *                         context. This will be used for performance
+ *                         measurements and debugging.
+ *
+ * @param options          Configuration options for the execution of git,
+ *                         see IGitExecutionOptions for more information.
+ *
+ * Returns the result. If the command exits with a code not in
+ * `successExitCodes` or an error not in `expectedErrors`, a `GitError` will be
+ * thrown.
+ */
+export declare function git(args: string[], path: string, name: string, options?: IGitStringExecutionOptions): Promise<IGitStringResult>;
+export declare function git(args: string[], path: string, name: string, options?: IGitBufferExecutionOptions): Promise<IGitBufferResult>;
+/**
+ * Determine whether the provided `error` is an authentication failure
+ * as per our definition. Note that this is not an exhaustive list of
+ * authentication failures, only a collection of errors that we treat
+ * equally in terms of error message and presentation to the user.
+ */
+export declare function isAuthFailureError(error: DugiteError): error is DugiteError.SSHAuthenticationFailed | DugiteError.SSHPermissionDenied | DugiteError.HTTPSAuthenticationFailed;
+/**
+ * Determine whether the provided `error` is an error from Git indicating
+ * that a configuration file  write failed due to a lock file already
+ * existing for that config file.
+ */
+export declare function isConfigFileLockError(error: Error): error is GitError;
+/**
+ * If the `result` is associated with an config lock file error (as determined
+ * by `isConfigFileLockError`) this method will attempt to extract an absolute
+ * path (i.e. rooted) to the configuration lock file in question from the Git
+ * output.
+ */
+export declare function parseConfigLockFilePathFromError(result: IGitResult): string | null;
+export declare function getDescriptionForError(error: DugiteError, stderr: string): string | null;
+/**
+ * Returns the arguments to use on any git operation that can end up
+ * triggering a rebase.
+ */
+export declare function gitRebaseArguments(): string[];
+/**
+ * Returns the SHA of the passed in IGitResult
+ */
+export declare function parseCommitSHA(result: IGitStringResult): string;