git-chopstick-core 0.1.1 → 0.1.3

package/dist/git/for-each-ref.js

@@ -0,0 +1,114 @@
+import { git } from './core.js';
+import { GitError } from './exec.js';
+import { Branch, BranchType, } from '../models/branch.js';
+import { createForEachRefParser } from './git-delimiter-parser.js';
+/** Get all the branches. */
+export async function getBranches(repository, ...prefixes) {
+    const { formatArgs, parse } = createForEachRefParser({
+        fullName: '%(refname)',
+        shortName: '%(refname:short)',
+        upstreamShortName: '%(upstream:short)',
+        upstreamTrackingBranch: '%(upstream:track)',
+        sha: '%(objectname)',
+        symRef: '%(symref)',
+        authorDate: '%(authordate:iso8601)',
+    });
+    if (!prefixes || !prefixes.length) {
+        prefixes = ['refs/heads', 'refs/remotes'];
+    }
+    // TODO: use expectedErrors here to handle a specific error
+    // see https://github.com/desktop/desktop/pull/5299#discussion_r206603442 for
+    // discussion about what needs to change
+    const result = await git(['for-each-ref', ...formatArgs, ...prefixes], repository.path, 'getBranches', { expectedErrors: new Set([GitError.NotAGitRepository]) });
+    if (result.gitError === GitError.NotAGitRepository) {
+        return [];
+    }
+    const branches = [];
+    for (const ref of parse(result.stdout)) {
+        // excude symbolic refs from the branch list
+        if (ref.symRef.length > 0) {
+            continue;
+        }
+        const tip = {
+            sha: ref.sha,
+            author: {
+                date: new Date(ref.authorDate),
+            },
+        };
+        const type = ref.fullName.startsWith('refs/heads')
+            ? BranchType.Local
+            : BranchType.Remote;
+        const upstream = ref.upstreamShortName.length > 0 ? ref.upstreamShortName : null;
+        const isGone = ['[gone]', '(gone)'].includes(ref.upstreamTrackingBranch);
+        branches.push(new Branch(ref.shortName, upstream, tip, type, ref.fullName, isGone));
+    }
+    return branches;
+}
+/**
+ * Gets all branches that differ from their upstream (i.e. they're ahead,
+ * behind or both), excluding the current branch.
+ * Useful to narrow down a list of branches that could potentially be fast
+ * forwarded.
+ *
+ * @param repository Repository to get the branches from.
+ */
+export async function getBranchesDifferingFromUpstream(repository) {
+    const { formatArgs, parse } = createForEachRefParser({
+        fullName: '%(refname)',
+        sha: '%(objectname)', // SHA
+        upstream: '%(upstream)',
+        symref: '%(symref)',
+        head: '%(HEAD)',
+        worktreePath: '%(worktreepath)',
+    });
+    const prefixes = ['refs/heads', 'refs/remotes'];
+    const result = await git(['for-each-ref', ...formatArgs, ...prefixes], repository.path, 'getBranchesDifferingFromUpstream', { expectedErrors: new Set([GitError.NotAGitRepository]) });
+    if (result.gitError === GitError.NotAGitRepository) {
+        return [];
+    }
+    const localBranches = [];
+    const remoteBranchShas = new Map();
+    // First we need to collect the relevant info from the command output:
+    // - For local branches with upstream: name, ref, SHA and the upstream.
+    // - For remote branches we only need the sha (and the ref as key).
+    for (const ref of parse(result.stdout)) {
+        if (ref.symref.length > 0 || ref.head === '*') {
+            // Exclude symbolic refs and the current branch
+            continue;
+        }
+        if (ref.worktreePath.length > 0 && ref.worktreePath !== repository.path) {
+            // Exclude branches checked out in other worktrees, since they can't be fast-forwarded from here
+            continue;
+        }
+        if (ref.fullName.startsWith('refs/heads')) {
+            if (ref.upstream.length === 0) {
+                // Exclude local branches without upstream
+                continue;
+            }
+            localBranches.push({
+                ref: ref.fullName,
+                sha: ref.sha,
+                upstream: ref.upstream,
+            });
+        }
+        else {
+            remoteBranchShas.set(ref.fullName, ref.sha);
+        }
+    }
+    const eligibleBranches = new Array();
+    // Compare the SHA of every local branch with the SHA of its upstream and
+    // collect the names of local branches that differ from their upstream.
+    for (const branch of localBranches) {
+        const remoteSha = remoteBranchShas.get(branch.upstream);
+        if (remoteSha !== undefined && remoteSha !== branch.sha) {
+            eligibleBranches.push({
+                ref: branch.ref,
+                sha: branch.sha,
+                upstreamRef: branch.upstream,
+                upstreamSha: remoteSha,
+            });
+        }
+    }
+    return eligibleBranches;
+}
+//# sourceMappingURL=for-each-ref.js.map

package/dist/git/for-each-ref.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"for-each-ref.js","sourceRoot":"","sources":["../../src/git/for-each-ref.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AAEpC,OAAO,EACL,MAAM,EACN,UAAU,GAGX,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAA;AAElE,4BAA4B;AAC5B,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,UAAsB,EACtB,GAAG,QAAkB;IAErB,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,sBAAsB,CAAC;QACnD,QAAQ,EAAE,YAAY;QACtB,SAAS,EAAE,kBAAkB;QAC7B,iBAAiB,EAAE,mBAAmB;QACtC,sBAAsB,EAAE,mBAAmB;QAC3C,GAAG,EAAE,eAAe;QACpB,MAAM,EAAE,WAAW;QACnB,UAAU,EAAE,uBAAuB;KACpC,CAAC,CAAA;IAEF,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAClC,QAAQ,GAAG,CAAC,YAAY,EAAE,cAAc,CAAC,CAAA;IAC3C,CAAC;IAED,2DAA2D;IAC3D,6EAA6E;IAC7E,wCAAwC;IACxC,MAAM,MAAM,GAAG,MAAM,GAAG,CACtB,CAAC,cAAc,EAAE,GAAG,UAAU,EAAE,GAAG,QAAQ,CAAC,EAC5C,UAAU,CAAC,IAAI,EACf,aAAa,EACb,EAAE,cAAc,EAAE,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAC1D,CAAA;IAED,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QACnD,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,QAAQ,GAAG,EAAE,CAAA;IAEnB,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACvC,4CAA4C;QAC5C,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,SAAQ;QACV,CAAC;QAED,MAAM,GAAG,GAAe;YACtB,GAAG,EAAE,GAAG,CAAC,GAAG;YACZ,MAAM,EAAE;gBACN,IAAI,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC;aAC/B;SACF,CAAA;QAED,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC;YAChD,CAAC,CAAC,UAAU,CAAC,KAAK;YAClB,CAAC,CAAC,UAAU,CAAC,MAAM,CAAA;QAErB,MAAM,QAAQ,GACZ,GAAG,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAA;QAEjE,MAAM,MAAM,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;QAExE,QAAQ,CAAC,IAAI,CACX,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CACrE,CAAA;IACH,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,gCAAgC,CACpD,UAAsB;IAEtB,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,sBAAsB,CAAC;QACnD,QAAQ,EAAE,YAAY;QACtB,GAAG,EAAE,eAAe,EAAE,MAAM;QAC5B,QAAQ,EAAE,aAAa;QACvB,MAAM,EAAE,WAAW;QACnB,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,iBAAiB;KAChC,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,CAAC,YAAY,EAAE,cAAc,CAAC,CAAA;IAE/C,MAAM,MAAM,GAAG,MAAM,GAAG,CACtB,CAAC,cAAc,EAAE,GAAG,UAAU,EAAE,GAAG,QAAQ,CAAC,EAC5C,UAAU,CAAC,IAAI,EACf,kCAAkC,EAClC,EAAE,cAAc,EAAE,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAC1D,CAAA;IAED,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QACnD,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,aAAa,GAAG,EAAE,CAAA;IACxB,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAkB,CAAA;IAElD,sEAAsE;IACtE,uEAAuE;IACvE,mEAAmE;IACnE,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACvC,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;YAC9C,+CAA+C;YAC/C,SAAQ;QACV,CAAC;QACD,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,YAAY,KAAK,UAAU,CAAC,IAAI,EAAE,CAAC;YACxE,gGAAgG;YAChG,SAAQ;QACV,CAAC;QAED,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YAC1C,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC9B,0CAA0C;gBAC1C,SAAQ;YACV,CAAC;YAED,aAAa,CAAC,IAAI,CAAC;gBACjB,GAAG,EAAE,GAAG,CAAC,QAAQ;gBACjB,GAAG,EAAE,GAAG,CAAC,GAAG;gBACZ,QAAQ,EAAE,GAAG,CAAC,QAAQ;aACvB,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;QAC7C,CAAC;IACH,CAAC;IAED,MAAM,gBAAgB,GAAG,IAAI,KAAK,EAAmB,CAAA;IAErD,yEAAyE;IACzE,uEAAuE;IACvE,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAEvD,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;YACxD,gBAAgB,CAAC,IAAI,CAAC;gBACpB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,WAAW,EAAE,MAAM,CAAC,QAAQ;gBAC5B,WAAW,EAAE,SAAS;aACvB,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,OAAO,gBAAgB,CAAA;AACzB,CAAC"}

package/dist/git/format-patch.d.ts

@@ -0,0 +1,10 @@
+import { Repository } from '../models/repository.js';
+/**
+ * Generate a patch representing the changes associated with a range of commits
+ *
+ * @param repository where to generate path from
+ * @param base starting commit in range
+ * @param head ending commit in rage
+ * @returns patch generated
+ */
+export declare function formatPatch({ path }: Repository, base: string, head: string): Promise<string>;

package/dist/git/format-patch.js

@@ -0,0 +1,16 @@
+import { revRange } from './rev-list.js';
+import { git } from './index.js';
+/**
+ * Generate a patch representing the changes associated with a range of commits
+ *
+ * @param repository where to generate path from
+ * @param base starting commit in range
+ * @param head ending commit in rage
+ * @returns patch generated
+ */
+export function formatPatch({ path }, base, head) {
+    const range = revRange(base, head);
+    const args = ['format-patch', '--unified=1', '--minimal', '--stdout', range];
+    return git(args, path, 'formatPatch').then(x => x.stdout);
+}
+//# sourceMappingURL=format-patch.js.map

package/dist/git/format-patch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-patch.js","sourceRoot":"","sources":["../../src/git/format-patch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAExC,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAA;AAEhC;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAC,EAAE,IAAI,EAAc,EAAE,IAAY,EAAE,IAAY;IAC1E,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAClC,MAAM,IAAI,GAAG,CAAC,cAAc,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,KAAK,CAAC,CAAA;IAC5E,OAAO,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;AAC3D,CAAC"}

package/dist/git/git-delimiter-parser.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Create a new parser suitable for parsing --format output from commands such
+ * as `git log`, `git stash`, and other commands that are not derived from
+ * `ref-filter`.
+ *
+ * Returns an object with the arguments that need to be appended to the git
+ * call and the parse function itself
+ *
+ * @param fields An object keyed on the friendly name of the value being
+ *               parsed with the value being the format string of said value.
+ *
+ *               Example:
+ *
+ *               `const { args, parse } = createLogParser({ sha: '%H' })`
+ */
+export declare function createLogParser<T extends Record<string, string>>(fields: T): {
+    formatArgs: string[];
+    parse: <V extends string | Buffer>(value: V) => { [K in keyof T]: V; }[];
+};
+/**
+ * Create a new parser suitable for parsing --format output from commands such
+ * as `git for-each-ref`, `git branch`, and other commands that are not derived
+ * from `git log`.
+ *
+ * Returns an object with the arguments that need to be appended to the git
+ * call and the parse function itself
+ *
+ * @param fields An object keyed on the friendly name of the value being
+ *               parsed with the value being the format string of said value.
+ *
+ *               Example:
+ *
+ *               `const { args, parse } = createForEachRefParser({ sha: '%(objectname)' })`
+ */
+export declare function createForEachRefParser<T extends Record<string, string>>(fields: T): {
+    formatArgs: string[];
+    parse: (value: string) => { [K in keyof T]: string; }[];
+};

package/dist/git/git-delimiter-parser.js

@@ -0,0 +1,79 @@
+import { splitBuffer } from '../lib/split-buffer.js';
+/**
+ * Create a new parser suitable for parsing --format output from commands such
+ * as `git log`, `git stash`, and other commands that are not derived from
+ * `ref-filter`.
+ *
+ * Returns an object with the arguments that need to be appended to the git
+ * call and the parse function itself
+ *
+ * @param fields An object keyed on the friendly name of the value being
+ *               parsed with the value being the format string of said value.
+ *
+ *               Example:
+ *
+ *               `const { args, parse } = createLogParser({ sha: '%H' })`
+ */
+export function createLogParser(fields) {
+    const keys = Object.keys(fields);
+    const format = Object.values(fields).join('%x00');
+    const formatArgs = ['-z', `--format=${format}`];
+    const parse = (value) => {
+        const records = (Buffer.isBuffer(value) ? splitBuffer(value, '\0') : value.split('\0'));
+        const entries = [];
+        for (let i = 0; i < records.length - keys.length; i += keys.length) {
+            const entry = {};
+            keys.forEach((key, ix) => (entry[key] = records[i + ix]));
+            entries.push(entry);
+        }
+        return entries;
+    };
+    return { formatArgs, parse };
+}
+/**
+ * Create a new parser suitable for parsing --format output from commands such
+ * as `git for-each-ref`, `git branch`, and other commands that are not derived
+ * from `git log`.
+ *
+ * Returns an object with the arguments that need to be appended to the git
+ * call and the parse function itself
+ *
+ * @param fields An object keyed on the friendly name of the value being
+ *               parsed with the value being the format string of said value.
+ *
+ *               Example:
+ *
+ *               `const { args, parse } = createForEachRefParser({ sha: '%(objectname)' })`
+ */
+export function createForEachRefParser(fields) {
+    const keys = Object.keys(fields);
+    const format = Object.values(fields).join('%00');
+    const formatArgs = [`--format=%00${format}%00`];
+    const parse = (value) => {
+        const records = value.split('\0');
+        const entries = new Array();
+        let entry;
+        let consumed = 0;
+        // start at 1 to avoid 0 modulo X problem. The first record is guaranteed
+        // to be empty anyway (due to %00 at the start of --format)
+        for (let i = 1; i < records.length - 1; i++) {
+            if (i % (keys.length + 1) === 0) {
+                if (records[i] !== '\n') {
+                    throw new Error('Expected newline');
+                }
+                continue;
+            }
+            entry = entry ?? {};
+            const key = keys[consumed % keys.length];
+            entry[key] = records[i];
+            consumed++;
+            if (consumed % keys.length === 0) {
+                entries.push(entry);
+                entry = undefined;
+            }
+        }
+        return entries;
+    };
+    return { formatArgs, parse };
+}
+//# sourceMappingURL=git-delimiter-parser.js.map

package/dist/git/git-delimiter-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"git-delimiter-parser.js","sourceRoot":"","sources":["../../src/git/git-delimiter-parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAEpD;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,eAAe,CAAmC,MAAS;IACzE,MAAM,IAAI,GAAmB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAChD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACjD,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,YAAY,MAAM,EAAE,CAAC,CAAA;IAE/C,MAAM,KAAK,GAAG,CAA4B,KAAQ,EAAE,EAAE;QACpD,MAAM,OAAO,GAAG,CACd,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAC/D,CAAA;QACR,MAAM,OAAO,GAAG,EAAE,CAAA;QAElB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACnE,MAAM,KAAK,GAAG,EAA2B,CAAA;YACzC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAA;YACzD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACrB,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC,CAAA;IAED,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,CAAA;AAC9B,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAS;IAET,MAAM,IAAI,GAAmB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAChD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAChD,MAAM,UAAU,GAAG,CAAC,eAAe,MAAM,KAAK,CAAC,CAAA;IAE/C,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,EAAE;QAC9B,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACjC,MAAM,OAAO,GAAG,IAAI,KAAK,EAA8B,CAAA;QAEvD,IAAI,KAAK,CAAA;QACT,IAAI,QAAQ,GAAG,CAAC,CAAA;QAEhB,yEAAyE;QACzE,2DAA2D;QAC3D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;oBACxB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAA;gBACrC,CAAC;gBACD,SAAQ;YACV,CAAC;YAED,KAAK,GAAG,KAAK,IAAK,EAAiC,CAAA;YACnD,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,CAAA;YACxC,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;YACvB,QAAQ,EAAE,CAAA;YAEV,IAAI,QAAQ,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACjC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;gBACnB,KAAK,GAAG,SAAS,CAAA;YACnB,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC,CAAA;IAED,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,CAAA;AAC9B,CAAC"}

package/dist/git/gitignore.d.ts

@@ -0,0 +1,26 @@
+import { Repository } from '../models/repository.js';
+/**
+ * Read the contents of the repository .gitignore.
+ *
+ * Returns a promise which will either be rejected or resolved
+ * with the contents of the file. If there's no .gitignore file
+ * in the repository root the promise will resolve with null.
+ */
+export declare function readGitIgnoreAtRoot(repository: Repository): Promise<string | null>;
+/**
+ * Persist the given content to the repository root .gitignore.
+ *
+ * If the repository root doesn't contain a .gitignore file one
+ * will be created, otherwise the current file will be overwritten.
+ */
+export declare function saveGitIgnore(repository: Repository, text: string): Promise<void>;
+/** Add the given pattern or patterns to the root gitignore file */
+export declare function appendIgnoreRule(repository: Repository, patterns: string | string[]): Promise<void>;
+/**
+ * Convenience method to add the given file path(s) to the repository's gitignore.
+ *
+ * The file path will be escaped before adding.
+ */
+export declare function appendIgnoreFile(repository: Repository, filePath: string | string[]): Promise<void>;
+/** Escapes a string from special characters used in a gitignore file */
+export declare function escapeGitSpecialCharacters(pattern: string): string;

package/dist/git/gitignore.js

@@ -0,0 +1,124 @@
+import * as Path from 'path';
+import * as FS from 'fs';
+import { getConfigValue } from './config.js';
+import { writeFile } from 'fs/promises';
+/**
+ * Read the contents of the repository .gitignore.
+ *
+ * Returns a promise which will either be rejected or resolved
+ * with the contents of the file. If there's no .gitignore file
+ * in the repository root the promise will resolve with null.
+ */
+export async function readGitIgnoreAtRoot(repository) {
+    const ignorePath = Path.join(repository.path, '.gitignore');
+    return new Promise((resolve, reject) => {
+        FS.readFile(ignorePath, 'utf8', (err, data) => {
+            if (err) {
+                if (err.code === 'ENOENT') {
+                    resolve(null);
+                }
+                else {
+                    reject(err);
+                }
+            }
+            else {
+                resolve(data);
+            }
+        });
+    });
+}
+/**
+ * Persist the given content to the repository root .gitignore.
+ *
+ * If the repository root doesn't contain a .gitignore file one
+ * will be created, otherwise the current file will be overwritten.
+ */
+export async function saveGitIgnore(repository, text) {
+    const ignorePath = Path.join(repository.path, '.gitignore');
+    if (text === '') {
+        return new Promise((resolve, reject) => {
+            FS.unlink(ignorePath, err => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve();
+                }
+            });
+        });
+    }
+    const fileContents = await formatGitIgnoreContents(text, repository);
+    await writeFile(ignorePath, fileContents);
+}
+/** Add the given pattern or patterns to the root gitignore file */
+export async function appendIgnoreRule(repository, patterns) {
+    const text = (await readGitIgnoreAtRoot(repository)) || '';
+    const currentContents = await formatGitIgnoreContents(text, repository);
+    const newPatternText = patterns instanceof Array ? patterns.join('\n') : patterns;
+    const newText = await formatGitIgnoreContents(`${currentContents}${newPatternText}`, repository);
+    await saveGitIgnore(repository, newText);
+}
+/**
+ * Convenience method to add the given file path(s) to the repository's gitignore.
+ *
+ * The file path will be escaped before adding.
+ */
+export async function appendIgnoreFile(repository, filePath) {
+    if (filePath instanceof Array) {
+        const escapedFilePaths = filePath.map(path => escapeGitSpecialCharacters(path));
+        return appendIgnoreRule(repository, escapedFilePaths);
+    }
+    const escapedFilePath = escapeGitSpecialCharacters(filePath);
+    return appendIgnoreRule(repository, escapedFilePath);
+}
+/** Escapes a string from special characters used in a gitignore file */
+export function escapeGitSpecialCharacters(pattern) {
+    const specialCharacters = /[\[\]!\*\#\?]/g;
+    return pattern.replaceAll(specialCharacters, match => {
+        return '\\' + match;
+    });
+}
+/**
+ * Format the gitignore text based on the current config settings.
+ *
+ * This setting looks at core.autocrlf to decide which line endings to use
+ * when updating the .gitignore file.
+ *
+ * If core.safecrlf is also set, adding this file to the index may cause
+ * Git to return a non-zero exit code, leaving the working directory in a
+ * confusing state for the user. So we should reformat the file in that
+ * case.
+ *
+ * @param text The text to format.
+ * @param repository The repository associated with the gitignore file.
+ */
+async function formatGitIgnoreContents(text, repository) {
+    const autocrlf = await getConfigValue(repository, 'core.autocrlf');
+    const safecrlf = await getConfigValue(repository, 'core.safecrlf');
+    return new Promise((resolve, reject) => {
+        if (autocrlf === 'true' && safecrlf === 'true') {
+            // based off https://stackoverflow.com/a/141069/1363815
+            const normalizedText = text.replace(/\r\n|\n\r|\n|\r/g, '\r\n');
+            resolve(normalizedText + '\r\n');
+            return;
+        }
+        if (text === '' || text.endsWith('\n')) {
+            resolve(text);
+            return;
+        }
+        if (autocrlf == null) {
+            // fallback to Git default behaviour
+            resolve(`${text}\n`);
+        }
+        else {
+            const linesEndInCRLF = autocrlf === 'true';
+            if (linesEndInCRLF) {
+                resolve(`${text}\n`);
+            }
+            else {
+                resolve(`${text}\r\n`);
+            }
+        }
+    });
+}
+//# sourceMappingURL=gitignore.js.map

package/dist/git/gitignore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitignore.js","sourceRoot":"","sources":["../../src/git/gitignore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAC5B,OAAO,KAAK,EAAE,MAAM,IAAI,CAAA;AAExB,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,UAAsB;IAEtB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;IAE3D,OAAO,IAAI,OAAO,CAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACpD,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YAC5C,IAAI,GAAG,EAAE,CAAC;gBACR,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC1B,OAAO,CAAC,IAAI,CAAC,CAAA;gBACf,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,GAAG,CAAC,CAAA;gBACb,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,CAAA;YACf,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,UAAsB,EACtB,IAAY;IAEZ,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;IAE3D,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;QAChB,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC3C,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE;gBAC1B,IAAI,GAAG,EAAE,CAAC;oBACR,MAAM,CAAC,GAAG,CAAC,CAAA;gBACb,CAAC;qBAAM,CAAC;oBACN,OAAO,EAAE,CAAA;gBACX,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,YAAY,GAAG,MAAM,uBAAuB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;IACpE,MAAM,SAAS,CAAC,UAAU,EAAE,YAAY,CAAC,CAAA;AAC3C,CAAC;AAED,mEAAmE;AACnE,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,UAAsB,EACtB,QAA2B;IAE3B,MAAM,IAAI,GAAG,CAAC,MAAM,mBAAmB,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAA;IAE1D,MAAM,eAAe,GAAG,MAAM,uBAAuB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;IAEvE,MAAM,cAAc,GAClB,QAAQ,YAAY,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAA;IAC5D,MAAM,OAAO,GAAG,MAAM,uBAAuB,CAC3C,GAAG,eAAe,GAAG,cAAc,EAAE,EACrC,UAAU,CACX,CAAA;IAED,MAAM,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;AAC1C,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,UAAsB,EACtB,QAA2B;IAE3B,IAAI,QAAQ,YAAY,KAAK,EAAE,CAAC;QAC9B,MAAM,gBAAgB,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAC3C,0BAA0B,CAAC,IAAI,CAAC,CACjC,CAAA;QAED,OAAO,gBAAgB,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAA;IACvD,CAAC;IAED,MAAM,eAAe,GAAG,0BAA0B,CAAC,QAAQ,CAAC,CAAA;IAC5D,OAAO,gBAAgB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAA;AACtD,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,0BAA0B,CAAC,OAAe;IACxD,MAAM,iBAAiB,GAAG,gBAAgB,CAAA;IAE1C,OAAO,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,KAAK,CAAC,EAAE;QACnD,OAAO,IAAI,GAAG,KAAK,CAAA;IACrB,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,KAAK,UAAU,uBAAuB,CACpC,IAAY,EACZ,UAAsB;IAEtB,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,UAAU,EAAE,eAAe,CAAC,CAAA;IAClE,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,UAAU,EAAE,eAAe,CAAC,CAAA;IAElE,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC7C,IAAI,QAAQ,KAAK,MAAM,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;YAC/C,uDAAuD;YACvD,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAA;YAC/D,OAAO,CAAC,cAAc,GAAG,MAAM,CAAC,CAAA;YAChC,OAAM;QACR,CAAC;QAED,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,OAAO,CAAC,IAAI,CAAC,CAAA;YACb,OAAM;QACR,CAAC;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,oCAAoC;YACpC,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,CAAA;QACtB,CAAC;aAAM,CAAC;YACN,MAAM,cAAc,GAAG,QAAQ,KAAK,MAAM,CAAA;YAC1C,IAAI,cAAc,EAAE,CAAC;gBACnB,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,CAAA;YACtB,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,IAAI,MAAM,CAAC,CAAA;YACxB,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/git/index.d.ts

@@ -0,0 +1,46 @@
+export * from './add.js';
+export * from './apply.js';
+export * from './branch.js';
+export * from './checkout.js';
+export * from './checkout-index.js';
+export * from './cherry-pick.js';
+export * from './clean.js';
+export * from './clone.js';
+export * from './commit.js';
+export * from './config.js';
+export * from './core.js';
+export * from './description.js';
+export * from './diff.js';
+export * from './diff-index.js';
+export * from './fetch.js';
+export * from './for-each-ref.js';
+export * from './format-patch.js';
+export * from './gitignore.js';
+export * from './init.js';
+export * from './interpret-trailers.js';
+export * from './lfs.js';
+export * from './log.js';
+export * from './merge.js';
+export * from './merge-tree.js';
+export * from './pull.js';
+export * from './push.js';
+export * from './rebase.js';
+export * from './reflog.js';
+export * from './refs.js';
+export * from './remote.js';
+export * from './reorder.js';
+export * from './reset.js';
+export * from './rev-list.js';
+export * from './rev-parse.js';
+export * from './rm.js';
+export * from './squash.js';
+export * from './stage.js';
+export * from './stash.js';
+export * from './status.js';
+export * from './submodule.js';
+export * from './tag.js';
+export * from './update-index.js';
+export * from './update-ref.js';
+export * from './var.js';
+export * from './worktree.js';
+export * from './worktree-include.js';

package/dist/git/index.js

@@ -0,0 +1,47 @@
+export * from './add.js';
+export * from './apply.js';
+export * from './branch.js';
+export * from './checkout.js';
+export * from './checkout-index.js';
+export * from './cherry-pick.js';
+export * from './clean.js';
+export * from './clone.js';
+export * from './commit.js';
+export * from './config.js';
+export * from './core.js';
+export * from './description.js';
+export * from './diff.js';
+export * from './diff-index.js';
+export * from './fetch.js';
+export * from './for-each-ref.js';
+export * from './format-patch.js';
+export * from './gitignore.js';
+export * from './init.js';
+export * from './interpret-trailers.js';
+export * from './lfs.js';
+export * from './log.js';
+export * from './merge.js';
+export * from './merge-tree.js';
+export * from './pull.js';
+export * from './push.js';
+export * from './rebase.js';
+export * from './reflog.js';
+export * from './refs.js';
+export * from './remote.js';
+export * from './reorder.js';
+export * from './reset.js';
+export * from './rev-list.js';
+export * from './rev-parse.js';
+export * from './rm.js';
+export * from './squash.js';
+export * from './stage.js';
+export * from './stash.js';
+export * from './status.js';
+export * from './submodule.js';
+export * from './tag.js';
+export * from './update-index.js';
+export * from './update-ref.js';
+export * from './var.js';
+export * from './worktree.js';
+export * from './worktree-include.js';
+//# sourceMappingURL=index.js.map

package/dist/git/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/git/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,kBAAkB,CAAA;AAChC,cAAc,WAAW,CAAA;AACzB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA;AACzB,cAAc,yBAAyB,CAAA;AACvC,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,SAAS,CAAA;AACvB,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA"}

package/dist/git/init.d.ts

@@ -0,0 +1,2 @@
+/** Init a new git repository in the given path. */
+export declare function initGitRepository(path: string): Promise<void>;

package/dist/git/init.js

@@ -0,0 +1,7 @@
+import { getDefaultBranch } from '../lib/helpers/default-branch.js';
+import { git } from './core.js';
+/** Init a new git repository in the given path. */
+export async function initGitRepository(path) {
+    await git(['-c', `init.defaultBranch=${await getDefaultBranch()}`, 'init'], path, 'initGitRepository');
+}
+//# sourceMappingURL=init.js.map

package/dist/git/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../src/git/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAA;AACnE,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AAE/B,mDAAmD;AACnD,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,IAAY;IAClD,MAAM,GAAG,CACP,CAAC,IAAI,EAAE,sBAAsB,MAAM,gBAAgB,EAAE,EAAE,EAAE,MAAM,CAAC,EAChE,IAAI,EACJ,mBAAmB,CACpB,CAAA;AACH,CAAC"}