isomorphic-git 1.41.3 → 1.41.5

package/index.cjs

@@ -6321,6 +6321,23 @@ async function constructTree({ fs, gitdir, inode, dryRun }) {
 // @ts-check
 
 async function resolveFilepath({ fs, cache, gitdir, oid, filepath }) {
+  const entry = await resolveFilepathEntry({
+    fs,
+    cache,
+    gitdir,
+    oid,
+    filepath,
+  });
+  return entry.oid
+}
+
+async function resolveFilepathEntry({
+  fs,
+  cache,
+  gitdir,
+  oid,
+  filepath,
+}) {
   // Ensure there are no leading or trailing directory separators.
   // I was going to do this automatically, but then found that the Git Terminal for Windows
   // auto-expands --filepath=/src/utils to --filepath=C:/Users/Will/AppData/Local/Programs/Git/src/utils
@@ -6334,10 +6351,10 @@ async function resolveFilepath({ fs, cache, gitdir, oid, filepath }) {
   const result = await resolveTree({ fs, cache, gitdir, oid });
   const tree = result.tree;
   if (filepath === '') {
-    oid = result.oid;
+    return { mode: '040000', oid: result.oid, path: '', type: 'tree' }
   } else {
     const pathArray = filepath.split('/');
-    oid = await _resolveFilepath({
+    return _resolveFilepath({
       fs,
       cache,
       gitdir,
@@ -6345,9 +6362,8 @@ async function resolveFilepath({ fs, cache, gitdir, oid, filepath }) {
       pathArray,
       oid: _oid,
       filepath,
-    });
+    })
   }
-  return oid
 }
 
 async function _resolveFilepath({
@@ -6363,7 +6379,7 @@ async function _resolveFilepath({
   for (const entry of tree) {
     if (entry.path === name) {
       if (pathArray.length === 0) {
-        return entry.oid
+        return entry
       } else {
         const { type, object } = await _readObject({
           fs,
@@ -7093,6 +7109,7 @@ const worthWalking = (filepath, root) => {
  * @param {boolean} [args.dryRun]
  * @param {boolean} [args.force]
  * @param {boolean} [args.track]
+ * @param {boolean} [args.restoreFromIndex]
  * @param {boolean} [args.nonBlocking]
  * @param {number} [args.batchSize]
  *
@@ -7114,6 +7131,7 @@ async function _checkout({
   dryRun,
   force,
   track = true,
+  restoreFromIndex = false,
   nonBlocking = false,
   batchSize = 100,
 }) {
@@ -7173,6 +7191,7 @@ async function _checkout({
         ref,
         force,
         filepaths,
+        restoreFromIndex,
       });
     } catch (err) {
       // Throw a more helpful error message for this common mistake.
@@ -7465,6 +7484,7 @@ async function analyze({
   ref,
   force,
   filepaths,
+  restoreFromIndex,
 }) {
   let count = 0;
   return _walk({
@@ -7472,7 +7492,7 @@ async function analyze({
     cache,
     dir,
     gitdir,
-    trees: [TREE({ ref }), WORKDIR(), STAGE()],
+    trees: [restoreFromIndex ? STAGE() : TREE({ ref }), WORKDIR(), STAGE()],
     map: async function (fullpath, [commit, workdir, stage]) {
       if (fullpath === '.') return
       // match against base paths
@@ -7497,7 +7517,12 @@ async function analyze({
         // Ignore workdir files that are not tracked and not part of the new commit.
         case '001':
           // OK, make an exception for explicitly named files.
-          if (force && filepaths && filepaths.includes(fullpath)) {
+          if (
+            !restoreFromIndex &&
+            force &&
+            filepaths &&
+            filepaths.includes(fullpath)
+          ) {
             return ['delete', fullpath]
           }
           return
@@ -7840,7 +7865,7 @@ async function batchAllSettled(operationName, tasks, onProgress, batchSize) {
  * @param {string} args.dir - The [working tree](dir-vs-gitdir.md) directory path
  * @param {string} [args.gitdir=join(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string} [args.ref = 'HEAD'] - Source to checkout files from
- * @param {string[]} [args.filepaths] - Limit the checkout to the given files and directories
+ * @param {string[]} [args.filepaths] - Limit the checkout to the given files and directories. If `ref` is not provided, restore them from the index.
  * @param {string} [args.remote = 'origin'] - Which remote repository to use
  * @param {boolean} [args.noCheckout = false] - If true, will update HEAD but won't update the working directory
  * @param {boolean} [args.noUpdateHead] - If true, will update the working directory but won't update HEAD. Defaults to `false` when `ref` is provided, and `true` if `ref` is not provided.
@@ -7863,7 +7888,7 @@ async function batchAllSettled(operationName, tasks, onProgress, batchSize) {
  * console.log('done')
  *
  * @example
- * // restore the 'docs' and 'src/docs' folders to the way they were, overwriting any changes
+ * // restore the 'docs' and 'src/docs' folders from the index, overwriting any unstaged changes
  * await git.checkout({
  *   fs,
  *   dir: '/tutorial',
@@ -7908,6 +7933,8 @@ async function checkout({
     assertParameter('gitdir', gitdir);
 
     const ref = _ref || 'HEAD';
+    const restoreFromIndex =
+      _ref === undefined && filepaths != null && filepaths.length > 0;
     const fsp = new FileSystem(fs);
     const updatedGitdir = await discoverGitdir({ fsp, dotgit: gitdir });
     return await _checkout({
@@ -7925,6 +7952,7 @@ async function checkout({
       dryRun,
       force,
       track,
+      restoreFromIndex,
       nonBlocking,
       batchSize,
     })
@@ -9700,8 +9728,8 @@ function filterCapabilities(server, client) {
 
 const pkg = {
   name: 'isomorphic-git',
-  version: '1.41.3',
-  agent: 'git/isomorphic-git@1.41.3',
+  version: '1.41.5',
+  agent: 'git/isomorphic-git@1.41.5',
 };
 
 class FIFO {
@@ -13315,6 +13343,7 @@ async function _log({
   const oid = await GitRefManager.resolve({ fs, gitdir, ref });
   const tips = [await _readCommit({ fs, cache, gitdir, oid })];
   let lastFileOid;
+  let lastFileMode;
   let lastCommit;
   let isOk;
 
@@ -13334,19 +13363,23 @@ async function _log({
     }
 
     if (filepath) {
-      let vFileOid;
+      let vFileEntry;
       try {
-        vFileOid = await resolveFilepath({
+        vFileEntry = await resolveFilepathEntry({
           fs,
           cache,
           gitdir,
           oid: commit.commit.tree,
           filepath,
         });
-        if (lastCommit && lastFileOid !== vFileOid) {
+        if (
+          lastCommit &&
+          (lastFileOid !== vFileEntry.oid || lastFileMode !== vFileEntry.mode)
+        ) {
           commits.push(lastCommit);
         }
-        lastFileOid = vFileOid;
+        lastFileOid = vFileEntry.oid;
+        lastFileMode = vFileEntry.mode;
         lastCommit = commit;
         isOk = true;
       } catch (e) {

package/index.d.cts

@@ -931,7 +931,7 @@ export function branch({ fs, dir, gitdir, ref, object, checkout, force, }: {
  * @param {string} args.dir - The [working tree](dir-vs-gitdir.md) directory path
  * @param {string} [args.gitdir=join(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string} [args.ref = 'HEAD'] - Source to checkout files from
- * @param {string[]} [args.filepaths] - Limit the checkout to the given files and directories
+ * @param {string[]} [args.filepaths] - Limit the checkout to the given files and directories. If `ref` is not provided, restore them from the index.
  * @param {string} [args.remote = 'origin'] - Which remote repository to use
  * @param {boolean} [args.noCheckout = false] - If true, will update HEAD but won't update the working directory
  * @param {boolean} [args.noUpdateHead] - If true, will update the working directory but won't update HEAD. Defaults to `false` when `ref` is provided, and `true` if `ref` is not provided.
@@ -954,7 +954,7 @@ export function branch({ fs, dir, gitdir, ref, object, checkout, force, }: {
  * console.log('done')
  *
  * @example
- * // restore the 'docs' and 'src/docs' folders to the way they were, overwriting any changes
+ * // restore the 'docs' and 'src/docs' folders from the index, overwriting any unstaged changes
  * await git.checkout({
  *   fs,
  *   dir: '/tutorial',

package/index.d.ts

@@ -1003,7 +1003,7 @@ export function branch({ fs, dir, gitdir, ref, object, checkout, force, }: {
  * @param {string} args.dir - The [working tree](dir-vs-gitdir.md) directory path
  * @param {string} [args.gitdir=join(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string} [args.ref = 'HEAD'] - Source to checkout files from
- * @param {string[]} [args.filepaths] - Limit the checkout to the given files and directories
+ * @param {string[]} [args.filepaths] - Limit the checkout to the given files and directories. If `ref` is not provided, restore them from the index.
  * @param {string} [args.remote = 'origin'] - Which remote repository to use
  * @param {boolean} [args.noCheckout = false] - If true, will update HEAD but won't update the working directory
  * @param {boolean} [args.noUpdateHead] - If true, will update the working directory but won't update HEAD. Defaults to `false` when `ref` is provided, and `true` if `ref` is not provided.
@@ -1026,7 +1026,7 @@ export function branch({ fs, dir, gitdir, ref, object, checkout, force, }: {
  * console.log('done')
  *
  * @example
- * // restore the 'docs' and 'src/docs' folders to the way they were, overwriting any changes
+ * // restore the 'docs' and 'src/docs' folders from the index, overwriting any unstaged changes
  * await git.checkout({
  *   fs,
  *   dir: '/tutorial',

package/index.js

@@ -6308,6 +6308,23 @@ async function constructTree({ fs, gitdir, inode, dryRun }) {
 // @ts-check
 
 async function resolveFilepath({ fs, cache, gitdir, oid, filepath }) {
+  const entry = await resolveFilepathEntry({
+    fs,
+    cache,
+    gitdir,
+    oid,
+    filepath,
+  });
+  return entry.oid
+}
+
+async function resolveFilepathEntry({
+  fs,
+  cache,
+  gitdir,
+  oid,
+  filepath,
+}) {
   // Ensure there are no leading or trailing directory separators.
   // I was going to do this automatically, but then found that the Git Terminal for Windows
   // auto-expands --filepath=/src/utils to --filepath=C:/Users/Will/AppData/Local/Programs/Git/src/utils
@@ -6321,10 +6338,10 @@ async function resolveFilepath({ fs, cache, gitdir, oid, filepath }) {
   const result = await resolveTree({ fs, cache, gitdir, oid });
   const tree = result.tree;
   if (filepath === '') {
-    oid = result.oid;
+    return { mode: '040000', oid: result.oid, path: '', type: 'tree' }
   } else {
     const pathArray = filepath.split('/');
-    oid = await _resolveFilepath({
+    return _resolveFilepath({
       fs,
       cache,
       gitdir,
@@ -6332,9 +6349,8 @@ async function resolveFilepath({ fs, cache, gitdir, oid, filepath }) {
       pathArray,
       oid: _oid,
       filepath,
-    });
+    })
   }
-  return oid
 }
 
 async function _resolveFilepath({
@@ -6350,7 +6366,7 @@ async function _resolveFilepath({
   for (const entry of tree) {
     if (entry.path === name) {
       if (pathArray.length === 0) {
-        return entry.oid
+        return entry
       } else {
         const { type, object } = await _readObject({
           fs,
@@ -7080,6 +7096,7 @@ const worthWalking = (filepath, root) => {
  * @param {boolean} [args.dryRun]
  * @param {boolean} [args.force]
  * @param {boolean} [args.track]
+ * @param {boolean} [args.restoreFromIndex]
  * @param {boolean} [args.nonBlocking]
  * @param {number} [args.batchSize]
  *
@@ -7101,6 +7118,7 @@ async function _checkout({
   dryRun,
   force,
   track = true,
+  restoreFromIndex = false,
   nonBlocking = false,
   batchSize = 100,
 }) {
@@ -7160,6 +7178,7 @@ async function _checkout({
         ref,
         force,
         filepaths,
+        restoreFromIndex,
       });
     } catch (err) {
       // Throw a more helpful error message for this common mistake.
@@ -7452,6 +7471,7 @@ async function analyze({
   ref,
   force,
   filepaths,
+  restoreFromIndex,
 }) {
   let count = 0;
   return _walk({
@@ -7459,7 +7479,7 @@ async function analyze({
     cache,
     dir,
     gitdir,
-    trees: [TREE({ ref }), WORKDIR(), STAGE()],
+    trees: [restoreFromIndex ? STAGE() : TREE({ ref }), WORKDIR(), STAGE()],
     map: async function (fullpath, [commit, workdir, stage]) {
       if (fullpath === '.') return
       // match against base paths
@@ -7484,7 +7504,12 @@ async function analyze({
         // Ignore workdir files that are not tracked and not part of the new commit.
         case '001':
           // OK, make an exception for explicitly named files.
-          if (force && filepaths && filepaths.includes(fullpath)) {
+          if (
+            !restoreFromIndex &&
+            force &&
+            filepaths &&
+            filepaths.includes(fullpath)
+          ) {
             return ['delete', fullpath]
           }
           return
@@ -7827,7 +7852,7 @@ async function batchAllSettled(operationName, tasks, onProgress, batchSize) {
  * @param {string} args.dir - The [working tree](dir-vs-gitdir.md) directory path
  * @param {string} [args.gitdir=join(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string} [args.ref = 'HEAD'] - Source to checkout files from
- * @param {string[]} [args.filepaths] - Limit the checkout to the given files and directories
+ * @param {string[]} [args.filepaths] - Limit the checkout to the given files and directories. If `ref` is not provided, restore them from the index.
  * @param {string} [args.remote = 'origin'] - Which remote repository to use
  * @param {boolean} [args.noCheckout = false] - If true, will update HEAD but won't update the working directory
  * @param {boolean} [args.noUpdateHead] - If true, will update the working directory but won't update HEAD. Defaults to `false` when `ref` is provided, and `true` if `ref` is not provided.
@@ -7850,7 +7875,7 @@ async function batchAllSettled(operationName, tasks, onProgress, batchSize) {
  * console.log('done')
  *
  * @example
- * // restore the 'docs' and 'src/docs' folders to the way they were, overwriting any changes
+ * // restore the 'docs' and 'src/docs' folders from the index, overwriting any unstaged changes
  * await git.checkout({
  *   fs,
  *   dir: '/tutorial',
@@ -7895,6 +7920,8 @@ async function checkout({
     assertParameter('gitdir', gitdir);
 
     const ref = _ref || 'HEAD';
+    const restoreFromIndex =
+      _ref === undefined && filepaths != null && filepaths.length > 0;
     const fsp = new FileSystem(fs);
     const updatedGitdir = await discoverGitdir({ fsp, dotgit: gitdir });
     return await _checkout({
@@ -7912,6 +7939,7 @@ async function checkout({
       dryRun,
       force,
       track,
+      restoreFromIndex,
       nonBlocking,
       batchSize,
     })
@@ -9687,8 +9715,8 @@ function filterCapabilities(server, client) {
 
 const pkg = {
   name: 'isomorphic-git',
-  version: '1.41.3',
-  agent: 'git/isomorphic-git@1.41.3',
+  version: '1.41.5',
+  agent: 'git/isomorphic-git@1.41.5',
 };
 
 class FIFO {
@@ -13302,6 +13330,7 @@ async function _log({
   const oid = await GitRefManager.resolve({ fs, gitdir, ref });
   const tips = [await _readCommit({ fs, cache, gitdir, oid })];
   let lastFileOid;
+  let lastFileMode;
   let lastCommit;
   let isOk;
 
@@ -13321,19 +13350,23 @@ async function _log({
     }
 
     if (filepath) {
-      let vFileOid;
+      let vFileEntry;
       try {
-        vFileOid = await resolveFilepath({
+        vFileEntry = await resolveFilepathEntry({
           fs,
           cache,
           gitdir,
           oid: commit.commit.tree,
           filepath,
         });
-        if (lastCommit && lastFileOid !== vFileOid) {
+        if (
+          lastCommit &&
+          (lastFileOid !== vFileEntry.oid || lastFileMode !== vFileEntry.mode)
+        ) {
           commits.push(lastCommit);
         }
-        lastFileOid = vFileOid;
+        lastFileOid = vFileEntry.oid;
+        lastFileMode = vFileEntry.mode;
         lastCommit = commit;
         isOk = true;
       } catch (e) {

package/index.umd.min.d.ts

@@ -1003,7 +1003,7 @@ export function branch({ fs, dir, gitdir, ref, object, checkout, force, }: {
  * @param {string} args.dir - The [working tree](dir-vs-gitdir.md) directory path
  * @param {string} [args.gitdir=join(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string} [args.ref = 'HEAD'] - Source to checkout files from
- * @param {string[]} [args.filepaths] - Limit the checkout to the given files and directories
+ * @param {string[]} [args.filepaths] - Limit the checkout to the given files and directories. If `ref` is not provided, restore them from the index.
  * @param {string} [args.remote = 'origin'] - Which remote repository to use
  * @param {boolean} [args.noCheckout = false] - If true, will update HEAD but won't update the working directory
  * @param {boolean} [args.noUpdateHead] - If true, will update the working directory but won't update HEAD. Defaults to `false` when `ref` is provided, and `true` if `ref` is not provided.
@@ -1026,7 +1026,7 @@ export function branch({ fs, dir, gitdir, ref, object, checkout, force, }: {
  * console.log('done')
  *
  * @example
- * // restore the 'docs' and 'src/docs' folders to the way they were, overwriting any changes
+ * // restore the 'docs' and 'src/docs' folders from the index, overwriting any unstaged changes
  * await git.checkout({
  *   fs,
  *   dir: '/tutorial',