isomorphic-git 1.39.0 → 1.40.1

package/index.cjs

@@ -66,6 +66,7 @@ var diff3Merge = _interopDefault(require('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
@@ -1331,6 +1332,23 @@ class InvalidOidError extends BaseError {
 /** @type {'InvalidOidError'} */
 InvalidOidError.code = 'InvalidOidError';
 
+class InvalidRefNameError extends BaseError {
+  /**
+   * @param {string} ref
+   * @param {string} suggestion
+   * @param {boolean} canForce
+   */
+  constructor(ref, suggestion) {
+    super(
+      `"${ref}" would be an invalid git reference. (Hint: a valid alternative would be "${suggestion}".)`
+    );
+    this.code = this.name = InvalidRefNameError.code;
+    this.data = { ref, suggestion };
+  }
+}
+/** @type {'InvalidRefNameError'} */
+InvalidRefNameError.code = 'InvalidRefNameError';
+
 class NoRefspecError extends BaseError {
   /**
    * @param {string} remote
@@ -2002,6 +2020,16 @@ const refpaths = ref => [
 // @see https://git-scm.com/docs/gitrepository-layout
 const GIT_FILES = ['config', 'description', 'index', 'shallow', 'commondir'];
 
+// These names are legal one-level ref names, so nothing upstream of here
+// rejects them, and writing to one lands on the repository file itself.
+// Canonical git refuses too: `git update-ref index <oid>` fails with
+// "cannot lock ref 'index': reference broken" and leaves the file alone.
+function assertWritableRef(ref) {
+  if (GIT_FILES.includes(ref)) {
+    throw new InvalidRefNameError(ref, `refs/heads/${ref}`)
+  }
+}
+
 let lock$1;
 
 async function acquireLock(ref, callback) {
@@ -2056,6 +2084,31 @@ class GitRefManager {
     }
     const refspec = GitRefSpecSet.from(refspecs);
     const actualRefsToWrite = new Map();
+    // Work out every destination this call will write, before touching the
+    // repository. Translating is pure, so it can happen up here; the writes
+    // themselves stay at the end of the function.
+    const refTranslations = refspec.translate([...refs.keys()]);
+    const symrefTranslations = [];
+    for (const [serverRef, translatedRef] of refspec.translate([
+      ...symrefs.keys(),
+    ])) {
+      const symtarget = refspec.translateOne(symrefs.get(serverRef));
+      if (symtarget) {
+        symrefTranslations.push([translatedRef, `ref: ${symtarget}`]);
+      }
+    }
+    // The local side of a refspec is whatever `remote.<name>.fetch` says, so a
+    // config like `+refs/heads/main:index` lands a write on `.git/index`.
+    // Refuse it here rather than at the write loop: `pruneTags` and `prune`
+    // delete refs in between, so a later throw leaves the repository pruned
+    // and not updated. The tags added below are always `refs/tags/...`, which
+    // is never a system file, so nothing is missed by checking this early.
+    for (const [, translatedRef] of refTranslations) {
+      assertWritableRef(translatedRef);
+    }
+    for (const [translatedRef] of symrefTranslations) {
+      assertWritableRef(translatedRef);
+    }
     // Delete all current tags if the pruneTags argument is true.
     if (pruneTags) {
       const tags = await GitRefManager.listRefs({
@@ -2083,18 +2136,12 @@ class GitRefManager {
       }
     }
     // Combine refs and symrefs giving symrefs priority
-    const refTranslations = refspec.translate([...refs.keys()]);
     for (const [serverRef, translatedRef] of refTranslations) {
       const value = refs.get(serverRef);
       actualRefsToWrite.set(translatedRef, value);
     }
-    const symrefTranslations = refspec.translate([...symrefs.keys()]);
-    for (const [serverRef, translatedRef] of symrefTranslations) {
-      const value = symrefs.get(serverRef);
-      const symtarget = refspec.translateOne(value);
-      if (symtarget) {
-        actualRefsToWrite.set(translatedRef, `ref: ${symtarget}`);
-      }
+    for (const [translatedRef, value] of symrefTranslations) {
+      actualRefsToWrite.set(translatedRef, value);
     }
     // If `prune` argument is true, clear out the existing local refspec roots
     const pruned = [];
@@ -2153,6 +2200,7 @@ class GitRefManager {
   // TODO: make this less crude?
   static async writeRef({ fs, gitdir, ref, value }) {
     // Validate input
+    assertWritableRef(ref);
     if (!value.match(/[0-9a-f]{40}/)) {
       throw new InvalidOidError(value)
     }
@@ -2172,6 +2220,7 @@ class GitRefManager {
    * @returns {Promise<void>}
    */
   static async writeSymbolicRef({ fs, gitdir, ref, value }) {
+    assertWritableRef(ref);
     await acquireLock(ref, async () =>
       fs.write(join(gitdir, ref), 'ref: ' + `${value.trim()}\n`, 'utf8')
     );
@@ -2200,6 +2249,8 @@ class GitRefManager {
    * @returns {Promise<void>}
    */
   static async deleteRefs({ fs, gitdir, refs }) {
+    // Validate input
+    refs.forEach(assertWritableRef);
     // Delete regular ref
     await Promise.all(refs.map(ref => fs.rm(join(gitdir, ref))));
     // Delete any packed ref
@@ -2323,7 +2374,7 @@ class GitRefManager {
     // We need to alternate between the file system and the packed-refs
     const packedMap = await GitRefManager.packedRefs({ fs, gitdir });
     // Look in all the proper paths, in this order
-    const allpaths = refpaths(ref);
+    const allpaths = refpaths(ref).filter(p => !GIT_FILES.includes(p)); // exclude git system files (#709)
     for (const ref of allpaths) {
       const refExists = await acquireLock(ref, async () =>
         fs.exists(`${gitdir}/${ref}`)
@@ -3823,23 +3874,6 @@ class InvalidFilepathError extends BaseError {
 /** @type {'InvalidFilepathError'} */
 InvalidFilepathError.code = 'InvalidFilepathError';
 
-class InvalidRefNameError extends BaseError {
-  /**
-   * @param {string} ref
-   * @param {string} suggestion
-   * @param {boolean} canForce
-   */
-  constructor(ref, suggestion) {
-    super(
-      `"${ref}" would be an invalid git reference. (Hint: a valid alternative would be "${suggestion}".)`
-    );
-    this.code = this.name = InvalidRefNameError.code;
-    this.data = { ref, suggestion };
-  }
-}
-/** @type {'InvalidRefNameError'} */
-InvalidRefNameError.code = 'InvalidRefNameError';
-
 class MaxDepthError extends BaseError {
   /**
    * @param {number} depth
@@ -9523,8 +9557,8 @@ function filterCapabilities(server, client) {
 
 const pkg = {
   name: 'isomorphic-git',
-  version: '1.39.0',
-  agent: 'git/isomorphic-git@1.39.0',
+  version: '1.40.1',
+  agent: 'git/isomorphic-git@1.40.1',
 };
 
 class FIFO {
@@ -13097,7 +13131,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
@@ -13118,6 +13152,7 @@ async function _log({
   since,
   force,
   follow,
+  includeChanges,
 }) {
   const sinceTimestamp =
     typeof since === 'undefined'
@@ -13245,9 +13280,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
 
 /**
@@ -13263,6 +13346,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
@@ -13289,6 +13373,7 @@ async function log({
   since, // Date
   force,
   follow,
+  includeChanges = false,
   cache = {},
 }) {
   try {
@@ -13308,6 +13393,7 @@ async function log({
       since,
       force,
       follow,
+      includeChanges,
     })
   } catch (err) {
     err.caller = 'git.log';

package/index.d.cts

@@ -354,6 +354,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;
@@ -2181,6 +2185,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
@@ -2197,7 +2202,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;
@@ -2207,6 +2212,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>>;
 /**
@@ -4521,6 +4527,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.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;
@@ -2180,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
@@ -2196,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;
@@ -2206,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>>;
 /**
@@ -4520,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
@@ -1324,6 +1325,23 @@ class InvalidOidError extends BaseError {
 /** @type {'InvalidOidError'} */
 InvalidOidError.code = 'InvalidOidError';
 
+class InvalidRefNameError extends BaseError {
+  /**
+   * @param {string} ref
+   * @param {string} suggestion
+   * @param {boolean} canForce
+   */
+  constructor(ref, suggestion) {
+    super(
+      `"${ref}" would be an invalid git reference. (Hint: a valid alternative would be "${suggestion}".)`
+    );
+    this.code = this.name = InvalidRefNameError.code;
+    this.data = { ref, suggestion };
+  }
+}
+/** @type {'InvalidRefNameError'} */
+InvalidRefNameError.code = 'InvalidRefNameError';
+
 class NoRefspecError extends BaseError {
   /**
    * @param {string} remote
@@ -1995,6 +2013,16 @@ const refpaths = ref => [
 // @see https://git-scm.com/docs/gitrepository-layout
 const GIT_FILES = ['config', 'description', 'index', 'shallow', 'commondir'];
 
+// These names are legal one-level ref names, so nothing upstream of here
+// rejects them, and writing to one lands on the repository file itself.
+// Canonical git refuses too: `git update-ref index <oid>` fails with
+// "cannot lock ref 'index': reference broken" and leaves the file alone.
+function assertWritableRef(ref) {
+  if (GIT_FILES.includes(ref)) {
+    throw new InvalidRefNameError(ref, `refs/heads/${ref}`)
+  }
+}
+
 let lock$1;
 
 async function acquireLock(ref, callback) {
@@ -2049,6 +2077,31 @@ class GitRefManager {
     }
     const refspec = GitRefSpecSet.from(refspecs);
     const actualRefsToWrite = new Map();
+    // Work out every destination this call will write, before touching the
+    // repository. Translating is pure, so it can happen up here; the writes
+    // themselves stay at the end of the function.
+    const refTranslations = refspec.translate([...refs.keys()]);
+    const symrefTranslations = [];
+    for (const [serverRef, translatedRef] of refspec.translate([
+      ...symrefs.keys(),
+    ])) {
+      const symtarget = refspec.translateOne(symrefs.get(serverRef));
+      if (symtarget) {
+        symrefTranslations.push([translatedRef, `ref: ${symtarget}`]);
+      }
+    }
+    // The local side of a refspec is whatever `remote.<name>.fetch` says, so a
+    // config like `+refs/heads/main:index` lands a write on `.git/index`.
+    // Refuse it here rather than at the write loop: `pruneTags` and `prune`
+    // delete refs in between, so a later throw leaves the repository pruned
+    // and not updated. The tags added below are always `refs/tags/...`, which
+    // is never a system file, so nothing is missed by checking this early.
+    for (const [, translatedRef] of refTranslations) {
+      assertWritableRef(translatedRef);
+    }
+    for (const [translatedRef] of symrefTranslations) {
+      assertWritableRef(translatedRef);
+    }
     // Delete all current tags if the pruneTags argument is true.
     if (pruneTags) {
       const tags = await GitRefManager.listRefs({
@@ -2076,18 +2129,12 @@ class GitRefManager {
       }
     }
     // Combine refs and symrefs giving symrefs priority
-    const refTranslations = refspec.translate([...refs.keys()]);
     for (const [serverRef, translatedRef] of refTranslations) {
       const value = refs.get(serverRef);
       actualRefsToWrite.set(translatedRef, value);
     }
-    const symrefTranslations = refspec.translate([...symrefs.keys()]);
-    for (const [serverRef, translatedRef] of symrefTranslations) {
-      const value = symrefs.get(serverRef);
-      const symtarget = refspec.translateOne(value);
-      if (symtarget) {
-        actualRefsToWrite.set(translatedRef, `ref: ${symtarget}`);
-      }
+    for (const [translatedRef, value] of symrefTranslations) {
+      actualRefsToWrite.set(translatedRef, value);
     }
     // If `prune` argument is true, clear out the existing local refspec roots
     const pruned = [];
@@ -2146,6 +2193,7 @@ class GitRefManager {
   // TODO: make this less crude?
   static async writeRef({ fs, gitdir, ref, value }) {
     // Validate input
+    assertWritableRef(ref);
     if (!value.match(/[0-9a-f]{40}/)) {
       throw new InvalidOidError(value)
     }
@@ -2165,6 +2213,7 @@ class GitRefManager {
    * @returns {Promise<void>}
    */
   static async writeSymbolicRef({ fs, gitdir, ref, value }) {
+    assertWritableRef(ref);
     await acquireLock(ref, async () =>
       fs.write(join(gitdir, ref), 'ref: ' + `${value.trim()}\n`, 'utf8')
     );
@@ -2193,6 +2242,8 @@ class GitRefManager {
    * @returns {Promise<void>}
    */
   static async deleteRefs({ fs, gitdir, refs }) {
+    // Validate input
+    refs.forEach(assertWritableRef);
     // Delete regular ref
     await Promise.all(refs.map(ref => fs.rm(join(gitdir, ref))));
     // Delete any packed ref
@@ -2316,7 +2367,7 @@ class GitRefManager {
     // We need to alternate between the file system and the packed-refs
     const packedMap = await GitRefManager.packedRefs({ fs, gitdir });
     // Look in all the proper paths, in this order
-    const allpaths = refpaths(ref);
+    const allpaths = refpaths(ref).filter(p => !GIT_FILES.includes(p)); // exclude git system files (#709)
     for (const ref of allpaths) {
       const refExists = await acquireLock(ref, async () =>
         fs.exists(`${gitdir}/${ref}`)
@@ -3810,23 +3861,6 @@ class InvalidFilepathError extends BaseError {
 /** @type {'InvalidFilepathError'} */
 InvalidFilepathError.code = 'InvalidFilepathError';
 
-class InvalidRefNameError extends BaseError {
-  /**
-   * @param {string} ref
-   * @param {string} suggestion
-   * @param {boolean} canForce
-   */
-  constructor(ref, suggestion) {
-    super(
-      `"${ref}" would be an invalid git reference. (Hint: a valid alternative would be "${suggestion}".)`
-    );
-    this.code = this.name = InvalidRefNameError.code;
-    this.data = { ref, suggestion };
-  }
-}
-/** @type {'InvalidRefNameError'} */
-InvalidRefNameError.code = 'InvalidRefNameError';
-
 class MaxDepthError extends BaseError {
   /**
    * @param {number} depth
@@ -9510,8 +9544,8 @@ function filterCapabilities(server, client) {
 
 const pkg = {
   name: 'isomorphic-git',
-  version: '1.39.0',
-  agent: 'git/isomorphic-git@1.39.0',
+  version: '1.40.1',
+  agent: 'git/isomorphic-git@1.40.1',
 };
 
 class FIFO {
@@ -13084,7 +13118,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
@@ -13105,6 +13139,7 @@ async function _log({
   since,
   force,
   follow,
+  includeChanges,
 }) {
   const sinceTimestamp =
     typeof since === 'undefined'
@@ -13232,9 +13267,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
 
 /**
@@ -13250,6 +13333,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
@@ -13276,6 +13360,7 @@ async function log({
   since, // Date
   force,
   follow,
+  includeChanges = false,
   cache = {},
 }) {
   try {
@@ -13295,6 +13380,7 @@ async function log({
       since,
       force,
       follow,
+      includeChanges,
     })
   } catch (err) {
     err.caller = 'git.log';

package/index.umd.min.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;
@@ -2180,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
@@ -2196,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;
@@ -2206,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>>;
 /**
@@ -4520,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