isomorphic-git 1.38.10 → 1.40.0

package/index.d.ts

@@ -353,6 +353,10 @@ export type CommitObject = {
      * an array of zero or more SHA-1 object ids
      */
     parent: string[];
+    /**
+     * Changed files as `[newOid, oldOid, filepath]`; present when `log` is called with `includeChanges: true`.
+     */
+    changes?: (string | null)[][] | undefined;
     author: {
         name: string;
         email: string;
@@ -705,6 +709,7 @@ export var Errors: Readonly<{
     CherryPickMergeCommitError: typeof CherryPickMergeCommitError;
     CherryPickRootCommitError: typeof CherryPickRootCommitError;
     CommitNotFetchedError: typeof CommitNotFetchedError;
+    EmptyCommitError: typeof EmptyCommitError;
     EmptyServerResponseError: typeof EmptyServerResponseError;
     FastForwardError: typeof FastForwardError;
     GitPushError: typeof GitPushError;
@@ -1200,6 +1205,7 @@ export function clone({ fs, http, onProgress, onMessage, onAuth, onAuthSuccess,
  * @param {boolean} [args.amend = false] - If true, replaces the last commit pointed to by `ref` with a new commit.
  * @param {boolean} [args.dryRun = false] - If true, simulates making a commit so you can test whether it would succeed. Implies `noUpdateBranch`.
  * @param {boolean} [args.noUpdateBranch = false] - If true, does not update the branch pointer after creating the commit.
+ * @param {boolean} [args.disallowEmpty = false] - If true, throws an error instead of creating a commit with no staged changes.
  * @param {string} [args.ref] - The fully expanded name of the branch to commit to. Default is the current branch pointed to by HEAD. (TODO: fix it so it can expand branch names without throwing if the branch doesn't exist yet.)
  * @param {string[]} [args.parent] - The SHA-1 object ids of the commits to use as parents. If not specified, the commit pointed to by `ref` is used.
  * @param {string} [args.tree] - The SHA-1 object id of the tree to use. If not specified, a new tree object is created from the current git index.
@@ -1220,7 +1226,7 @@ export function clone({ fs, http, onProgress, onMessage, onAuth, onAuthSuccess,
  * console.log(sha)
  *
  */
-export function commit({ fs: _fs, onSign, dir, gitdir, message, author, committer, signingKey, amend, dryRun, noUpdateBranch, ref, parent, tree, cache, }: {
+export function commit({ fs: _fs, onSign, dir, gitdir, message, author, committer, signingKey, amend, dryRun, noUpdateBranch, disallowEmpty, ref, parent, tree, cache, }: {
     fs: FsClient;
     onSign?: SignCallback | undefined;
     dir?: string | undefined;
@@ -1242,6 +1248,7 @@ export function commit({ fs: _fs, onSign, dir, gitdir, message, author, committe
     amend?: boolean | undefined;
     dryRun?: boolean | undefined;
     noUpdateBranch?: boolean | undefined;
+    disallowEmpty?: boolean | undefined;
     ref?: string | undefined;
     parent?: string[] | undefined;
     tree?: string | undefined;
@@ -2177,6 +2184,7 @@ export function listTags({ fs, dir, gitdir }: {
  * @param {Date} [args.since] - Return history newer than the given date. Can be combined with `depth` to get whichever is shorter.
  * @param {boolean=} [args.force=false] do not throw error if filepath is not exist (works only for a single file). defaults to false
  * @param {boolean=} [args.follow=false] Continue listing the history of a file beyond renames (works only for a single file). defaults to false
+ * @param {boolean=} [args.includeChanges=false] Include changed file object ids for each commit. Each tuple is `[newOid, oldOid, filepath]`; an added or removed file has a null old or new oid, respectively.
  * @param {object} [args.cache] - a [cache](cache.md) object
  *
  * @returns {Promise<Array<ReadCommitResult>>} Resolves to an array of ReadCommitResult objects
@@ -2193,7 +2201,7 @@ export function listTags({ fs, dir, gitdir }: {
  * console.log(commits)
  *
  */
-export function log({ fs, dir, gitdir, filepath, ref, depth, since, force, follow, cache, }: {
+export function log({ fs, dir, gitdir, filepath, ref, depth, since, force, follow, includeChanges, cache, }: {
     fs: FsClient;
     dir?: string | undefined;
     gitdir?: string | undefined;
@@ -2203,6 +2211,7 @@ export function log({ fs, dir, gitdir, filepath, ref, depth, since, force, follo
     since?: Date | undefined;
     force?: boolean | undefined;
     follow?: boolean | undefined;
+    includeChanges?: boolean | undefined;
     cache?: object;
 }): Promise<Array<ReadCommitResult>>;
 /**
@@ -4028,6 +4037,16 @@ declare namespace CommitNotFetchedError {
     let code_5: "CommitNotFetchedError";
     export { code_5 as code };
 }
+declare class EmptyCommitError extends BaseError {
+    constructor();
+    code: "EmptyCommitError";
+    name: "EmptyCommitError";
+    data: {};
+}
+declare namespace EmptyCommitError {
+    let code_6: "EmptyCommitError";
+    export { code_6 as code };
+}
 declare class EmptyServerResponseError extends BaseError {
     constructor();
     code: "EmptyServerResponseError";
@@ -4035,8 +4054,8 @@ declare class EmptyServerResponseError extends BaseError {
     data: {};
 }
 declare namespace EmptyServerResponseError {
-    let code_6: "EmptyServerResponseError";
-    export { code_6 as code };
+    let code_7: "EmptyServerResponseError";
+    export { code_7 as code };
 }
 declare class FastForwardError extends BaseError {
     constructor();
@@ -4045,8 +4064,8 @@ declare class FastForwardError extends BaseError {
     data: {};
 }
 declare namespace FastForwardError {
-    let code_7: "FastForwardError";
-    export { code_7 as code };
+    let code_8: "FastForwardError";
+    export { code_8 as code };
 }
 declare class GitPushError extends BaseError {
     /**
@@ -4062,8 +4081,8 @@ declare class GitPushError extends BaseError {
     };
 }
 declare namespace GitPushError {
-    let code_8: "GitPushError";
-    export { code_8 as code };
+    let code_9: "GitPushError";
+    export { code_9 as code };
 }
 declare class HttpError extends BaseError {
     /**
@@ -4081,8 +4100,8 @@ declare class HttpError extends BaseError {
     };
 }
 declare namespace HttpError {
-    let code_9: "HttpError";
-    export { code_9 as code };
+    let code_10: "HttpError";
+    export { code_10 as code };
 }
 declare class InternalError extends BaseError {
     /**
@@ -4096,8 +4115,8 @@ declare class InternalError extends BaseError {
     };
 }
 declare namespace InternalError {
-    let code_10: "InternalError";
-    export { code_10 as code };
+    let code_11: "InternalError";
+    export { code_11 as code };
 }
 declare class InvalidFilepathError extends BaseError {
     /**
@@ -4111,8 +4130,8 @@ declare class InvalidFilepathError extends BaseError {
     };
 }
 declare namespace InvalidFilepathError {
-    let code_11: "InvalidFilepathError";
-    export { code_11 as code };
+    let code_12: "InvalidFilepathError";
+    export { code_12 as code };
 }
 declare class InvalidOidError extends BaseError {
     /**
@@ -4126,8 +4145,8 @@ declare class InvalidOidError extends BaseError {
     };
 }
 declare namespace InvalidOidError {
-    let code_12: "InvalidOidError";
-    export { code_12 as code };
+    let code_13: "InvalidOidError";
+    export { code_13 as code };
 }
 declare class InvalidRefNameError extends BaseError {
     /**
@@ -4144,8 +4163,8 @@ declare class InvalidRefNameError extends BaseError {
     };
 }
 declare namespace InvalidRefNameError {
-    let code_13: "InvalidRefNameError";
-    export { code_13 as code };
+    let code_14: "InvalidRefNameError";
+    export { code_14 as code };
 }
 declare class MaxDepthError extends BaseError {
     /**
@@ -4159,8 +4178,8 @@ declare class MaxDepthError extends BaseError {
     };
 }
 declare namespace MaxDepthError {
-    let code_14: "MaxDepthError";
-    export { code_14 as code };
+    let code_15: "MaxDepthError";
+    export { code_15 as code };
 }
 declare class MergeNotSupportedError extends BaseError {
     constructor();
@@ -4169,8 +4188,8 @@ declare class MergeNotSupportedError extends BaseError {
     data: {};
 }
 declare namespace MergeNotSupportedError {
-    let code_15: "MergeNotSupportedError";
-    export { code_15 as code };
+    let code_16: "MergeNotSupportedError";
+    export { code_16 as code };
 }
 declare class MergeConflictError extends BaseError {
     /**
@@ -4190,8 +4209,8 @@ declare class MergeConflictError extends BaseError {
     };
 }
 declare namespace MergeConflictError {
-    let code_16: "MergeConflictError";
-    export { code_16 as code };
+    let code_17: "MergeConflictError";
+    export { code_17 as code };
 }
 declare class MissingNameError extends BaseError {
     /**
@@ -4205,8 +4224,8 @@ declare class MissingNameError extends BaseError {
     };
 }
 declare namespace MissingNameError {
-    let code_17: "MissingNameError";
-    export { code_17 as code };
+    let code_18: "MissingNameError";
+    export { code_18 as code };
 }
 declare class MissingParameterError extends BaseError {
     /**
@@ -4220,8 +4239,8 @@ declare class MissingParameterError extends BaseError {
     };
 }
 declare namespace MissingParameterError {
-    let code_18: "MissingParameterError";
-    export { code_18 as code };
+    let code_19: "MissingParameterError";
+    export { code_19 as code };
 }
 declare class MultipleGitError extends BaseError {
     /**
@@ -4237,8 +4256,8 @@ declare class MultipleGitError extends BaseError {
     errors: Error[];
 }
 declare namespace MultipleGitError {
-    let code_19: "MultipleGitError";
-    export { code_19 as code };
+    let code_20: "MultipleGitError";
+    export { code_20 as code };
 }
 declare class NoRefspecError extends BaseError {
     /**
@@ -4252,8 +4271,8 @@ declare class NoRefspecError extends BaseError {
     };
 }
 declare namespace NoRefspecError {
-    let code_20: "NoRefspecError";
-    export { code_20 as code };
+    let code_21: "NoRefspecError";
+    export { code_21 as code };
 }
 declare class NotFoundError extends BaseError {
     /**
@@ -4267,8 +4286,8 @@ declare class NotFoundError extends BaseError {
     };
 }
 declare namespace NotFoundError {
-    let code_21: "NotFoundError";
-    export { code_21 as code };
+    let code_22: "NotFoundError";
+    export { code_22 as code };
 }
 declare class ObjectTypeError extends BaseError {
     /**
@@ -4288,8 +4307,8 @@ declare class ObjectTypeError extends BaseError {
     };
 }
 declare namespace ObjectTypeError {
-    let code_22: "ObjectTypeError";
-    export { code_22 as code };
+    let code_23: "ObjectTypeError";
+    export { code_23 as code };
 }
 declare class ParseError extends BaseError {
     /**
@@ -4305,8 +4324,8 @@ declare class ParseError extends BaseError {
     };
 }
 declare namespace ParseError {
-    let code_23: "ParseError";
-    export { code_23 as code };
+    let code_24: "ParseError";
+    export { code_24 as code };
 }
 declare class PushRejectedError extends BaseError {
     /**
@@ -4320,8 +4339,8 @@ declare class PushRejectedError extends BaseError {
     };
 }
 declare namespace PushRejectedError {
-    let code_24: "PushRejectedError";
-    export { code_24 as code };
+    let code_25: "PushRejectedError";
+    export { code_25 as code };
 }
 declare class RemoteCapabilityError extends BaseError {
     /**
@@ -4337,8 +4356,8 @@ declare class RemoteCapabilityError extends BaseError {
     };
 }
 declare namespace RemoteCapabilityError {
-    let code_25: "RemoteCapabilityError";
-    export { code_25 as code };
+    let code_26: "RemoteCapabilityError";
+    export { code_26 as code };
 }
 declare class SmartHttpError extends BaseError {
     /**
@@ -4354,8 +4373,8 @@ declare class SmartHttpError extends BaseError {
     };
 }
 declare namespace SmartHttpError {
-    let code_26: "SmartHttpError";
-    export { code_26 as code };
+    let code_27: "SmartHttpError";
+    export { code_27 as code };
 }
 declare class UnknownTransportError extends BaseError {
     /**
@@ -4373,8 +4392,8 @@ declare class UnknownTransportError extends BaseError {
     };
 }
 declare namespace UnknownTransportError {
-    let code_27: "UnknownTransportError";
-    export { code_27 as code };
+    let code_28: "UnknownTransportError";
+    export { code_28 as code };
 }
 declare class UnsafeFilepathError extends BaseError {
     /**
@@ -4388,8 +4407,8 @@ declare class UnsafeFilepathError extends BaseError {
     };
 }
 declare namespace UnsafeFilepathError {
-    let code_28: "UnsafeFilepathError";
-    export { code_28 as code };
+    let code_29: "UnsafeFilepathError";
+    export { code_29 as code };
 }
 declare class UrlParseError extends BaseError {
     /**
@@ -4403,8 +4422,8 @@ declare class UrlParseError extends BaseError {
     };
 }
 declare namespace UrlParseError {
-    let code_29: "UrlParseError";
-    export { code_29 as code };
+    let code_30: "UrlParseError";
+    export { code_30 as code };
 }
 declare class UserCanceledError extends BaseError {
     constructor();
@@ -4413,8 +4432,8 @@ declare class UserCanceledError extends BaseError {
     data: {};
 }
 declare namespace UserCanceledError {
-    let code_30: "UserCanceledError";
-    export { code_30 as code };
+    let code_31: "UserCanceledError";
+    export { code_31 as code };
 }
 declare class UnmergedPathsError extends BaseError {
     /**
@@ -4428,8 +4447,8 @@ declare class UnmergedPathsError extends BaseError {
     };
 }
 declare namespace UnmergedPathsError {
-    let code_31: "UnmergedPathsError";
-    export { code_31 as code };
+    let code_32: "UnmergedPathsError";
+    export { code_32 as code };
 }
 declare class IndexResetError extends BaseError {
     /**
@@ -4443,8 +4462,8 @@ declare class IndexResetError extends BaseError {
     };
 }
 declare namespace IndexResetError {
-    let code_32: "IndexResetError";
-    export { code_32 as code };
+    let code_33: "IndexResetError";
+    export { code_33 as code };
 }
 declare class NoCommitError extends BaseError {
     /**
@@ -4458,8 +4477,8 @@ declare class NoCommitError extends BaseError {
     };
 }
 declare namespace NoCommitError {
-    let code_33: "NoCommitError";
-    export { code_33 as code };
+    let code_34: "NoCommitError";
+    export { code_34 as code };
 }
 /**
  * @typedef {Object} GitProgressEvent
@@ -4507,6 +4526,7 @@ declare namespace NoCommitError {
  * @property {string} message Commit message
  * @property {string} tree SHA-1 object id of corresponding file tree
  * @property {string[]} parent an array of zero or more SHA-1 object ids
+ * @property {Array.<Array.<string|null>>} [changes] Changed files as `[newOid, oldOid, filepath]`; present when `log` is called with `includeChanges: true`.
  * @property {Object} author
  * @property {string} author.name The author's name
  * @property {string} author.email The author's email

package/index.js

@@ -59,6 +59,7 @@ import diff3Merge from 'diff3';
  * @property {string} message Commit message
  * @property {string} tree SHA-1 object id of corresponding file tree
  * @property {string[]} parent an array of zero or more SHA-1 object ids
+ * @property {Array.<Array.<string|null>>} [changes] Changed files as `[newOid, oldOid, filepath]`; present when `log` is called with `includeChanges: true`.
  * @property {Object} author
  * @property {string} author.name The author's name
  * @property {string} author.email The author's email
@@ -3732,6 +3733,16 @@ class CommitNotFetchedError extends BaseError {
 /** @type {'CommitNotFetchedError'} */
 CommitNotFetchedError.code = 'CommitNotFetchedError';
 
+class EmptyCommitError extends BaseError {
+  constructor() {
+    super('Cannot create an empty commit when disallowEmpty is true.');
+    this.code = this.name = EmptyCommitError.code;
+    this.data = {};
+  }
+}
+/** @type {'EmptyCommitError'} */
+EmptyCommitError.code = 'EmptyCommitError';
+
 class EmptyServerResponseError extends BaseError {
   constructor() {
     super(`Empty response from git server.`);
@@ -4050,6 +4061,7 @@ var Errors = /*#__PURE__*/Object.freeze({
   CherryPickMergeCommitError: CherryPickMergeCommitError,
   CherryPickRootCommitError: CherryPickRootCommitError,
   CommitNotFetchedError: CommitNotFetchedError,
+  EmptyCommitError: EmptyCommitError,
   EmptyServerResponseError: EmptyServerResponseError,
   FastForwardError: FastForwardError,
   GitPushError: GitPushError,
@@ -5963,6 +5975,8 @@ async function _readCommit({ fs, cache, gitdir, oid }) {
 
 // @ts-check
 
+const EMPTY_TREE_OID = '4b825dc642cb6eb9a060e54bf8d69288fbee4904';
+
 /**
  *
  * @param {Object} args
@@ -5985,6 +5999,7 @@ async function _readCommit({ fs, cache, gitdir, oid }) {
  * @param {boolean} [args.amend = false]
  * @param {boolean} [args.dryRun = false]
  * @param {boolean} [args.noUpdateBranch = false]
+ * @param {boolean} [args.disallowEmpty = false]
  * @param {string} [args.ref]
  * @param {string[]} [args.parent]
  * @param {string} [args.tree]
@@ -6003,6 +6018,7 @@ async function _commit({
   amend = false,
   dryRun = false,
   noUpdateBranch = false,
+  disallowEmpty = false,
   ref,
   parent,
   tree,
@@ -6090,6 +6106,15 @@ async function _commit({
         );
       }
 
+      if (
+        disallowEmpty &&
+        !amend &&
+        ((initialCommit && tree === EMPTY_TREE_OID) ||
+          (!initialCommit && tree === refCommit.commit.tree))
+      ) {
+        throw new EmptyCommitError()
+      }
+
       // Determine message of this commit
       if (!message) {
         if (!amend) {
@@ -9486,8 +9511,8 @@ function filterCapabilities(server, client) {
 
 const pkg = {
   name: 'isomorphic-git',
-  version: '1.38.10',
-  agent: 'git/isomorphic-git@1.38.10',
+  version: '1.40.0',
+  agent: 'git/isomorphic-git@1.40.0',
 };
 
 class FIFO {
@@ -10474,6 +10499,7 @@ async function clone({
  * @param {boolean} [args.amend = false] - If true, replaces the last commit pointed to by `ref` with a new commit.
  * @param {boolean} [args.dryRun = false] - If true, simulates making a commit so you can test whether it would succeed. Implies `noUpdateBranch`.
  * @param {boolean} [args.noUpdateBranch = false] - If true, does not update the branch pointer after creating the commit.
+ * @param {boolean} [args.disallowEmpty = false] - If true, throws an error instead of creating a commit with no staged changes.
  * @param {string} [args.ref] - The fully expanded name of the branch to commit to. Default is the current branch pointed to by HEAD. (TODO: fix it so it can expand branch names without throwing if the branch doesn't exist yet.)
  * @param {string[]} [args.parent] - The SHA-1 object ids of the commits to use as parents. If not specified, the commit pointed to by `ref` is used.
  * @param {string} [args.tree] - The SHA-1 object id of the tree to use. If not specified, a new tree object is created from the current git index.
@@ -10506,6 +10532,7 @@ async function commit({
   amend = false,
   dryRun = false,
   noUpdateBranch = false,
+  disallowEmpty = false,
   ref,
   parent,
   tree,
@@ -10534,6 +10561,7 @@ async function commit({
       amend,
       dryRun,
       noUpdateBranch,
+      disallowEmpty,
       ref,
       parent,
       tree,
@@ -13057,7 +13085,7 @@ async function _resolveFileId({
  * @param {number|void} args.depth
  * @param {boolean=} [args.force=false] do not throw error if filepath is not exist (works only for a single file). defaults to false
  * @param {boolean=} [args.follow=false] Continue listing the history of a file beyond renames (works only for a single file). defaults to false
- * @param {boolean=} args.follow Continue listing the history of a file beyond renames (works only for a single file). defaults to false
+ * @param {boolean=} [args.includeChanges=false] Include changed file object ids for each commit.
  *
  * @returns {Promise<Array<ReadCommitResult>>} Resolves to an array of ReadCommitResult objects
  * @see ReadCommitResult
@@ -13078,6 +13106,7 @@ async function _log({
   since,
   force,
   follow,
+  includeChanges,
 }) {
   const sinceTimestamp =
     typeof since === 'undefined'
@@ -13205,9 +13234,57 @@ async function _log({
     // Process tips in order by age
     tips.sort((a, b) => compareAge(a.commit, b.commit));
   }
+  if (includeChanges) {
+    for (const commit of commits) {
+      commit.commit.changes = await getChanges({
+        fs,
+        cache,
+        gitdir,
+        commit,
+        shallow: shallowCommits.has(commit.oid),
+      });
+    }
+  }
   return commits
 }
 
+async function getChanges({ fs, cache, gitdir, commit, shallow }) {
+  const parent =
+    shallow || !commit.commit.parent[0]
+      ? '4b825dc642cb6eb9a060e54bf8d69288fbee4904'
+      : commit.commit.parent[0];
+  return _walk({
+    fs,
+    cache,
+    gitdir,
+    trees: [TREE({ ref: commit.oid }), TREE({ ref: parent })],
+    map: async (filepath, [current, previous]) => {
+      const [currentType, previousType] = await Promise.all([
+        current && current.type(),
+        previous && previous.type(),
+      ]);
+      if (currentType === 'tree') {
+        if (previousType && previousType !== 'tree') {
+          return [null, await previous.oid(), filepath]
+        }
+        return
+      }
+      if (previousType === 'tree') {
+        if (currentType) {
+          return [await current.oid(), null, filepath]
+        }
+        return
+      }
+      const [newOid, oldOid] = await Promise.all([
+        current ? current.oid() : null,
+        previous ? previous.oid() : null,
+      ]);
+      if (newOid === oldOid) return
+      return [newOid, oldOid, filepath]
+    },
+  })
+}
+
 // @ts-check
 
 /**
@@ -13223,6 +13300,7 @@ async function _log({
  * @param {Date} [args.since] - Return history newer than the given date. Can be combined with `depth` to get whichever is shorter.
  * @param {boolean=} [args.force=false] do not throw error if filepath is not exist (works only for a single file). defaults to false
  * @param {boolean=} [args.follow=false] Continue listing the history of a file beyond renames (works only for a single file). defaults to false
+ * @param {boolean=} [args.includeChanges=false] Include changed file object ids for each commit. Each tuple is `[newOid, oldOid, filepath]`; an added or removed file has a null old or new oid, respectively.
  * @param {object} [args.cache] - a [cache](cache.md) object
  *
  * @returns {Promise<Array<ReadCommitResult>>} Resolves to an array of ReadCommitResult objects
@@ -13249,6 +13327,7 @@ async function log({
   since, // Date
   force,
   follow,
+  includeChanges = false,
   cache = {},
 }) {
   try {
@@ -13268,6 +13347,7 @@ async function log({
       since,
       force,
       follow,
+      includeChanges,
     })
   } catch (err) {
     err.caller = 'git.log';