isomorphic-git 1.15.1 → 1.17.0

package/browser-tests.json

@@ -1,8 +1,8 @@
 [
   "HeadlessChrome 0.0.0 (Linux 0.0.0)",
-  "Firefox 97.0.0 (Ubuntu 0.0.0)",
-  "Chrome 79.0.3945 (Windows 10 0.0.0)",
-  "Mobile Safari 13.0.0 (iOS 13.0.0)",
+  "Firefox 98.0.0 (Ubuntu 0.0.0)",
+  "Chrome Mobile 96.0.4664 (Android 0.0.0)",
   "Safari 13.1.0 (Mac OS X 10.15.4)",
-  "Chrome Mobile 96.0.4664 (Android 0.0.0)"
+  "Mobile Safari 13.0.0 (iOS 13.0.0)",
+  "Chrome 79.0.3945 (Windows 10 0.0.0)"
 ]

package/index.cjs

@@ -3210,6 +3210,23 @@ class MissingParameterError extends BaseError {
 /** @type {'MissingParameterError'} */
 MissingParameterError.code = 'MissingParameterError';
 
+class MultipleGitError extends BaseError {
+  /**
+   * @param {Error[]} errors
+   * @param {string} message
+   */
+  constructor(errors) {
+    super(
+      `There are multiple errors that were thrown by the method. Please refer to the "errors" property to see more`
+    );
+    this.code = this.name = MultipleGitError.code;
+    this.data = { errors };
+    this.errors = errors;
+  }
+}
+/** @type {'MultipleGitError'} */
+MultipleGitError.code = 'MultipleGitError';
+
 class ParseError extends BaseError {
   /**
    * @param {string} expected
@@ -3335,6 +3352,7 @@ var Errors = /*#__PURE__*/Object.freeze({
   MergeNotSupportedError: MergeNotSupportedError,
   MissingNameError: MissingNameError,
   MissingParameterError: MissingParameterError,
+  MultipleGitError: MultipleGitError,
   NoRefspecError: NoRefspecError,
   NotFoundError: NotFoundError,
   ObjectTypeError: ObjectTypeError,
@@ -4029,23 +4047,6 @@ function WORKDIR() {
 
 // @ts-check
 
-class MultipleGitError extends BaseError {
-  /**
-   * @param {Error[]} errors
-   * @param {string} message
-   */
-  constructor(errors) {
-    super(
-      `There are multiple errors that were thrown by the method. Please refer to the "errors" property to see more`
-    );
-    this.code = this.name = MultipleGitError.code;
-    this.data = { errors };
-    this.errors = errors;
-  }
-}
-/** @type {'MultipleGitError'} */
-MultipleGitError.code = 'MultipleGitError';
-
 // I'm putting this in a Manager because I reckon it could benefit
 // from a LOT of cacheing.
 class GitIgnoreManager {
@@ -4447,6 +4448,7 @@ function assertParameter(name, value) {
  * @param {string} [args.gitdir=join(dir, '.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string|string[]} args.filepath - The path to the file to add to the index
  * @param {object} [args.cache] - a [cache](cache.md) object
+ * @param {boolean} [args.force=false] - add to index even if matches gitignore. Think `git add --force`
  *
  * @returns {Promise<void>} Resolves successfully once the git index has been updated
  *
@@ -4462,6 +4464,7 @@ async function add({
   gitdir = join(dir, '.git'),
   filepath,
   cache = {},
+  force = false,
 }) {
   try {
     assertParameter('fs', _fs);
@@ -4471,7 +4474,7 @@ async function add({
 
     const fs = new FileSystem(_fs);
     await GitIndexManager.acquire({ fs, gitdir, cache }, async index => {
-      return addToIndex({ dir, gitdir, fs, filepath, index })
+      return addToIndex({ dir, gitdir, fs, filepath, index, force })
     });
   } catch (err) {
     err.caller = 'git.add';
@@ -4479,17 +4482,19 @@ async function add({
   }
 }
 
-async function addToIndex({ dir, gitdir, fs, filepath, index }) {
+async function addToIndex({ dir, gitdir, fs, filepath, index, force }) {
   // TODO: Should ignore UNLESS it's already in the index.
   filepath = Array.isArray(filepath) ? filepath : [filepath];
   const promises = filepath.map(async currentFilepath => {
-    const ignored = await GitIgnoreManager.isIgnored({
-      fs,
-      dir,
-      gitdir,
-      filepath: currentFilepath,
-    });
-    if (ignored) return
+    if (!force) {
+      const ignored = await GitIgnoreManager.isIgnored({
+        fs,
+        dir,
+        gitdir,
+        filepath: currentFilepath,
+      });
+      if (ignored) return
+    }
     const stats = await fs.lstat(join(dir, currentFilepath));
     if (!stats) throw new NotFoundError(currentFilepath)
 
@@ -4502,6 +4507,7 @@ async function addToIndex({ dir, gitdir, fs, filepath, index }) {
           fs,
           filepath: [join(currentFilepath, child)],
           index,
+          force,
         })
       );
       await Promise.all(promises);
@@ -6918,8 +6924,8 @@ function filterCapabilities(server, client) {
 
 const pkg = {
   name: 'isomorphic-git',
-  version: '1.15.1',
-  agent: 'git/isomorphic-git@1.15.1',
+  version: '1.17.0',
+  agent: 'git/isomorphic-git@1.17.0',
 };
 
 class FIFO {
@@ -13342,6 +13348,7 @@ async function getHeadTree({ fs, cache, gitdir }) {
  * @param {string[]} [args.filepaths = ['.']] - Limit the query to the given files and directories
  * @param {function(string): boolean} [args.filter] - Filter the results to only those whose filepath matches a function.
  * @param {object} [args.cache] - a [cache](cache.md) object
+ * @param {boolean} [args.ignored = false] - include ignored files in the result
  *
  * @returns {Promise<Array<StatusRow>>} Resolves with a status matrix, described below.
  * @see StatusRow
@@ -13354,6 +13361,7 @@ async function statusMatrix({
   filepaths = ['.'],
   filter,
   cache = {},
+  ignored: shouldIgnore = false,
 }) {
   try {
     assertParameter('fs', _fs);
@@ -13370,14 +13378,15 @@ async function statusMatrix({
       map: async function(filepath, [head, workdir, stage]) {
         // Ignore ignored files, but only if they are not already tracked.
         if (!head && !stage && workdir) {
-          if (
-            await GitIgnoreManager.isIgnored({
+          if (!shouldIgnore) {
+            const isIgnored = await GitIgnoreManager.isIgnored({
               fs,
               dir,
               filepath,
-            })
-          ) {
-            return null
+            });
+            if (isIgnored) {
+              return null
+            }
           }
         }
         // match against base paths
@@ -13566,15 +13575,22 @@ async function updateIndex({
             fileStats = await fs.lstat(join(dir, filepath));
 
             if (fileStats) {
+              if (fileStats.isDirectory()) {
+                // Removing directories should not work
+                throw new InvalidFilepathError('directory')
+              }
+
               // Do nothing if we don't force and the file still exists in the workdir
               return
             }
           }
 
-          // Remove the file from the index if it's forced or the file does not exist
-          index.delete({
-            filepath,
-          });
+          // Directories are not allowed, so we make sure the provided filepath exists in the index
+          if (index.has({ filepath })) {
+            index.delete({
+              filepath,
+            });
+          }
         }
       )
     }

package/index.d.ts

@@ -717,6 +717,7 @@ export var Errors: Readonly<{
     MergeNotSupportedError: typeof MergeNotSupportedError;
     MissingNameError: typeof MissingNameError;
     MissingParameterError: typeof MissingParameterError;
+    MultipleGitError: typeof MultipleGitError;
     NoRefspecError: typeof NoRefspecError;
     NotFoundError: typeof NotFoundError;
     ObjectTypeError: typeof ObjectTypeError;
@@ -754,6 +755,7 @@ export function WORKDIR(): Walker;
  * @param {string} [args.gitdir=join(dir, '.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string|string[]} args.filepath - The path to the file to add to the index
  * @param {object} [args.cache] - a [cache](cache.md) object
+ * @param {boolean} [args.force=false] - add to index even if matches gitignore. Think `git add --force`
  *
  * @returns {Promise<void>} Resolves successfully once the git index has been updated
  *
@@ -763,12 +765,13 @@ export function WORKDIR(): Walker;
  * console.log('done')
  *
  */
-export function add({ fs: _fs, dir, gitdir, filepath, cache, }: {
+export function add({ fs: _fs, dir, gitdir, filepath, cache, force, }: {
     fs: CallbackFsClient | PromiseFsClient;
     dir: string;
     gitdir?: string;
     filepath: string | string[];
     cache?: any;
+    force?: boolean;
 }): Promise<void>;
 /**
  * Add or update an object note
@@ -3069,11 +3072,12 @@ export function status({ fs: _fs, dir, gitdir, filepath, cache, }: {
  * @param {string[]} [args.filepaths = ['.']] - Limit the query to the given files and directories
  * @param {function(string): boolean} [args.filter] - Filter the results to only those whose filepath matches a function.
  * @param {object} [args.cache] - a [cache](cache.md) object
+ * @param {boolean} [args.ignored = false] - include ignored files in the result
  *
  * @returns {Promise<Array<StatusRow>>} Resolves with a status matrix, described below.
  * @see StatusRow
  */
-export function statusMatrix({ fs: _fs, dir, gitdir, ref, filepaths, filter, cache, }: {
+export function statusMatrix({ fs: _fs, dir, gitdir, ref, filepaths, filter, cache, ignored: shouldIgnore, }: {
     fs: CallbackFsClient | PromiseFsClient;
     dir: string;
     gitdir?: string;
@@ -3081,6 +3085,7 @@ export function statusMatrix({ fs: _fs, dir, gitdir, ref, filepaths, filter, cac
     filepaths?: string[];
     filter?: (arg0: string) => boolean;
     cache?: any;
+    ignored?: boolean;
 }): Promise<[string, 0 | 1, 0 | 1 | 2, 0 | 1 | 2 | 3][]>;
 /**
  * Create a lightweight tag
@@ -3889,6 +3894,23 @@ declare namespace MissingParameterError {
     const code_15: 'MissingParameterError';
     export { code_15 as code };
 }
+declare class MultipleGitError extends BaseError {
+    /**
+     * @param {Error[]} errors
+     * @param {string} message
+     */
+    constructor(errors: Error[]);
+    code: "MultipleGitError";
+    name: "MultipleGitError";
+    data: {
+        errors: Error[];
+    };
+    errors: Error[];
+}
+declare namespace MultipleGitError {
+    const code_16: 'MultipleGitError';
+    export { code_16 as code };
+}
 declare class NoRefspecError extends BaseError {
     /**
      * @param {string} remote
@@ -3901,8 +3923,8 @@ declare class NoRefspecError extends BaseError {
     };
 }
 declare namespace NoRefspecError {
-    const code_16: 'NoRefspecError';
-    export { code_16 as code };
+    const code_17: 'NoRefspecError';
+    export { code_17 as code };
 }
 declare class NotFoundError extends BaseError {
     /**
@@ -3916,8 +3938,8 @@ declare class NotFoundError extends BaseError {
     };
 }
 declare namespace NotFoundError {
-    const code_17: 'NotFoundError';
-    export { code_17 as code };
+    const code_18: 'NotFoundError';
+    export { code_18 as code };
 }
 declare class ObjectTypeError extends BaseError {
     /**
@@ -3937,8 +3959,8 @@ declare class ObjectTypeError extends BaseError {
     };
 }
 declare namespace ObjectTypeError {
-    const code_18: 'ObjectTypeError';
-    export { code_18 as code };
+    const code_19: 'ObjectTypeError';
+    export { code_19 as code };
 }
 declare class ParseError extends BaseError {
     /**
@@ -3954,8 +3976,8 @@ declare class ParseError extends BaseError {
     };
 }
 declare namespace ParseError {
-    const code_19: 'ParseError';
-    export { code_19 as code };
+    const code_20: 'ParseError';
+    export { code_20 as code };
 }
 declare class PushRejectedError extends BaseError {
     /**
@@ -3969,8 +3991,8 @@ declare class PushRejectedError extends BaseError {
     };
 }
 declare namespace PushRejectedError {
-    const code_20: 'PushRejectedError';
-    export { code_20 as code };
+    const code_21: 'PushRejectedError';
+    export { code_21 as code };
 }
 declare class RemoteCapabilityError extends BaseError {
     /**
@@ -3986,8 +4008,8 @@ declare class RemoteCapabilityError extends BaseError {
     };
 }
 declare namespace RemoteCapabilityError {
-    const code_21: 'RemoteCapabilityError';
-    export { code_21 as code };
+    const code_22: 'RemoteCapabilityError';
+    export { code_22 as code };
 }
 declare class SmartHttpError extends BaseError {
     /**
@@ -4003,8 +4025,8 @@ declare class SmartHttpError extends BaseError {
     };
 }
 declare namespace SmartHttpError {
-    const code_22: 'SmartHttpError';
-    export { code_22 as code };
+    const code_23: 'SmartHttpError';
+    export { code_23 as code };
 }
 declare class UnknownTransportError extends BaseError {
     /**
@@ -4022,8 +4044,8 @@ declare class UnknownTransportError extends BaseError {
     };
 }
 declare namespace UnknownTransportError {
-    const code_23: 'UnknownTransportError';
-    export { code_23 as code };
+    const code_24: 'UnknownTransportError';
+    export { code_24 as code };
 }
 declare class UnsafeFilepathError extends BaseError {
     /**
@@ -4037,8 +4059,8 @@ declare class UnsafeFilepathError extends BaseError {
     };
 }
 declare namespace UnsafeFilepathError {
-    const code_24: 'UnsafeFilepathError';
-    export { code_24 as code };
+    const code_25: 'UnsafeFilepathError';
+    export { code_25 as code };
 }
 declare class UrlParseError extends BaseError {
     /**
@@ -4052,8 +4074,8 @@ declare class UrlParseError extends BaseError {
     };
 }
 declare namespace UrlParseError {
-    const code_25: 'UrlParseError';
-    export { code_25 as code };
+    const code_26: 'UrlParseError';
+    export { code_26 as code };
 }
 declare class UserCanceledError extends BaseError {
     code: "UserCanceledError";
@@ -4061,8 +4083,8 @@ declare class UserCanceledError extends BaseError {
     data: {};
 }
 declare namespace UserCanceledError {
-    const code_26: 'UserCanceledError';
-    export { code_26 as code };
+    const code_27: 'UserCanceledError';
+    export { code_27 as code };
 }
 /**
  * @typedef {Object} GitProgressEvent

package/index.js

@@ -3204,6 +3204,23 @@ class MissingParameterError extends BaseError {
 /** @type {'MissingParameterError'} */
 MissingParameterError.code = 'MissingParameterError';
 
+class MultipleGitError extends BaseError {
+  /**
+   * @param {Error[]} errors
+   * @param {string} message
+   */
+  constructor(errors) {
+    super(
+      `There are multiple errors that were thrown by the method. Please refer to the "errors" property to see more`
+    );
+    this.code = this.name = MultipleGitError.code;
+    this.data = { errors };
+    this.errors = errors;
+  }
+}
+/** @type {'MultipleGitError'} */
+MultipleGitError.code = 'MultipleGitError';
+
 class ParseError extends BaseError {
   /**
    * @param {string} expected
@@ -3329,6 +3346,7 @@ var Errors = /*#__PURE__*/Object.freeze({
   MergeNotSupportedError: MergeNotSupportedError,
   MissingNameError: MissingNameError,
   MissingParameterError: MissingParameterError,
+  MultipleGitError: MultipleGitError,
   NoRefspecError: NoRefspecError,
   NotFoundError: NotFoundError,
   ObjectTypeError: ObjectTypeError,
@@ -4023,23 +4041,6 @@ function WORKDIR() {
 
 // @ts-check
 
-class MultipleGitError extends BaseError {
-  /**
-   * @param {Error[]} errors
-   * @param {string} message
-   */
-  constructor(errors) {
-    super(
-      `There are multiple errors that were thrown by the method. Please refer to the "errors" property to see more`
-    );
-    this.code = this.name = MultipleGitError.code;
-    this.data = { errors };
-    this.errors = errors;
-  }
-}
-/** @type {'MultipleGitError'} */
-MultipleGitError.code = 'MultipleGitError';
-
 // I'm putting this in a Manager because I reckon it could benefit
 // from a LOT of cacheing.
 class GitIgnoreManager {
@@ -4441,6 +4442,7 @@ function assertParameter(name, value) {
  * @param {string} [args.gitdir=join(dir, '.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string|string[]} args.filepath - The path to the file to add to the index
  * @param {object} [args.cache] - a [cache](cache.md) object
+ * @param {boolean} [args.force=false] - add to index even if matches gitignore. Think `git add --force`
  *
  * @returns {Promise<void>} Resolves successfully once the git index has been updated
  *
@@ -4456,6 +4458,7 @@ async function add({
   gitdir = join(dir, '.git'),
   filepath,
   cache = {},
+  force = false,
 }) {
   try {
     assertParameter('fs', _fs);
@@ -4465,7 +4468,7 @@ async function add({
 
     const fs = new FileSystem(_fs);
     await GitIndexManager.acquire({ fs, gitdir, cache }, async index => {
-      return addToIndex({ dir, gitdir, fs, filepath, index })
+      return addToIndex({ dir, gitdir, fs, filepath, index, force })
     });
   } catch (err) {
     err.caller = 'git.add';
@@ -4473,17 +4476,19 @@ async function add({
   }
 }
 
-async function addToIndex({ dir, gitdir, fs, filepath, index }) {
+async function addToIndex({ dir, gitdir, fs, filepath, index, force }) {
   // TODO: Should ignore UNLESS it's already in the index.
   filepath = Array.isArray(filepath) ? filepath : [filepath];
   const promises = filepath.map(async currentFilepath => {
-    const ignored = await GitIgnoreManager.isIgnored({
-      fs,
-      dir,
-      gitdir,
-      filepath: currentFilepath,
-    });
-    if (ignored) return
+    if (!force) {
+      const ignored = await GitIgnoreManager.isIgnored({
+        fs,
+        dir,
+        gitdir,
+        filepath: currentFilepath,
+      });
+      if (ignored) return
+    }
     const stats = await fs.lstat(join(dir, currentFilepath));
     if (!stats) throw new NotFoundError(currentFilepath)
 
@@ -4496,6 +4501,7 @@ async function addToIndex({ dir, gitdir, fs, filepath, index }) {
           fs,
           filepath: [join(currentFilepath, child)],
           index,
+          force,
         })
       );
       await Promise.all(promises);
@@ -6912,8 +6918,8 @@ function filterCapabilities(server, client) {
 
 const pkg = {
   name: 'isomorphic-git',
-  version: '1.15.1',
-  agent: 'git/isomorphic-git@1.15.1',
+  version: '1.17.0',
+  agent: 'git/isomorphic-git@1.17.0',
 };
 
 class FIFO {
@@ -13336,6 +13342,7 @@ async function getHeadTree({ fs, cache, gitdir }) {
  * @param {string[]} [args.filepaths = ['.']] - Limit the query to the given files and directories
  * @param {function(string): boolean} [args.filter] - Filter the results to only those whose filepath matches a function.
  * @param {object} [args.cache] - a [cache](cache.md) object
+ * @param {boolean} [args.ignored = false] - include ignored files in the result
  *
  * @returns {Promise<Array<StatusRow>>} Resolves with a status matrix, described below.
  * @see StatusRow
@@ -13348,6 +13355,7 @@ async function statusMatrix({
   filepaths = ['.'],
   filter,
   cache = {},
+  ignored: shouldIgnore = false,
 }) {
   try {
     assertParameter('fs', _fs);
@@ -13364,14 +13372,15 @@ async function statusMatrix({
       map: async function(filepath, [head, workdir, stage]) {
         // Ignore ignored files, but only if they are not already tracked.
         if (!head && !stage && workdir) {
-          if (
-            await GitIgnoreManager.isIgnored({
+          if (!shouldIgnore) {
+            const isIgnored = await GitIgnoreManager.isIgnored({
               fs,
               dir,
               filepath,
-            })
-          ) {
-            return null
+            });
+            if (isIgnored) {
+              return null
+            }
           }
         }
         // match against base paths
@@ -13560,15 +13569,22 @@ async function updateIndex({
             fileStats = await fs.lstat(join(dir, filepath));
 
             if (fileStats) {
+              if (fileStats.isDirectory()) {
+                // Removing directories should not work
+                throw new InvalidFilepathError('directory')
+              }
+
               // Do nothing if we don't force and the file still exists in the workdir
               return
             }
           }
 
-          // Remove the file from the index if it's forced or the file does not exist
-          index.delete({
-            filepath,
-          });
+          // Directories are not allowed, so we make sure the provided filepath exists in the index
+          if (index.has({ filepath })) {
+            index.delete({
+              filepath,
+            });
+          }
         }
       )
     }