isomorphic-git 1.39.0 → 1.40.0

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
@@ -9523,8 +9524,8 @@ function filterCapabilities(server, client) {
 
 const pkg = {
   name: 'isomorphic-git',
-  version: '1.39.0',
-  agent: 'git/isomorphic-git@1.39.0',
+  version: '1.40.0',
+  agent: 'git/isomorphic-git@1.40.0',
 };
 
 class FIFO {
@@ -13097,7 +13098,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 +13119,7 @@ async function _log({
   since,
   force,
   follow,
+  includeChanges,
 }) {
   const sinceTimestamp =
     typeof since === 'undefined'
@@ -13245,9 +13247,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 +13313,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 +13340,7 @@ async function log({
   since, // Date
   force,
   follow,
+  includeChanges = false,
   cache = {},
 }) {
   try {
@@ -13308,6 +13360,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
@@ -9510,8 +9511,8 @@ function filterCapabilities(server, client) {
 
 const pkg = {
   name: 'isomorphic-git',
-  version: '1.39.0',
-  agent: 'git/isomorphic-git@1.39.0',
+  version: '1.40.0',
+  agent: 'git/isomorphic-git@1.40.0',
 };
 
 class FIFO {
@@ -13084,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
@@ -13105,6 +13106,7 @@ async function _log({
   since,
   force,
   follow,
+  includeChanges,
 }) {
   const sinceTimestamp =
     typeof since === 'undefined'
@@ -13232,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
 
 /**
@@ -13250,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
@@ -13276,6 +13327,7 @@ async function log({
   since, // Date
   force,
   follow,
+  includeChanges = false,
   cache = {},
 }) {
   try {
@@ -13295,6 +13347,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