isomorphic-git 1.14.0 → 1.15.0

package/README.md

@@ -195,6 +195,7 @@ unless there is a major version bump.
 - [status](https://isomorphic-git.github.io/docs/status.html)
 - [statusMatrix](https://isomorphic-git.github.io/docs/statusMatrix.html)
 - [tag](https://isomorphic-git.github.io/docs/tag.html)
+- [updateIndex](https://isomorphic-git.github.io/docs/updateIndex.html)
 - [version](https://isomorphic-git.github.io/docs/version.html)
 - [walk](https://isomorphic-git.github.io/docs/walk.html)
 - [writeBlob](https://isomorphic-git.github.io/docs/writeBlob.html)

package/browser-tests.json

@@ -3,6 +3,6 @@
   "Firefox 97.0.0 (Ubuntu 0.0.0)",
   "Chrome Mobile 96.0.4664 (Android 0.0.0)",
   "Chrome 79.0.3945 (Windows 10 0.0.0)",
-  "Safari 13.1.0 (Mac OS X 10.15.4)",
-  "Mobile Safari 13.0.0 (iOS 13.0.0)"
+  "Mobile Safari 13.0.0 (iOS 13.0.0)",
+  "Safari 13.1.0 (Mac OS X 10.15.4)"
 ]

package/index.cjs

@@ -762,6 +762,10 @@ class GitIndex {
     this._dirty = true;
   }
 
+  has({ filepath }) {
+    return this._entries.has(filepath)
+  }
+
   render() {
     return this.entries
       .map(entry => `${entry.mode.toString(8)} ${entry.oid}    ${entry.path}`)
@@ -3119,12 +3123,14 @@ HttpError.code = 'HttpError';
 
 class InvalidFilepathError extends BaseError {
   /**
-   * @param {'leading-slash'|'trailing-slash'} [reason]
+   * @param {'leading-slash'|'trailing-slash'|'directory'} [reason]
    */
   constructor(reason) {
     let message = 'invalid filepath';
     if (reason === 'leading-slash' || reason === 'trailing-slash') {
       message = `"filepath" parameter should not include leading or trailing directory separators because these can cause problems on some platforms.`;
+    } else if (reason === 'directory') {
+      message = `"filepath" should not be a directory.`;
     }
     super(message);
     this.code = this.name = InvalidFilepathError.code;
@@ -6912,8 +6918,8 @@ function filterCapabilities(server, client) {
 
 const pkg = {
   name: 'isomorphic-git',
-  version: '1.14.0',
-  agent: 'git/isomorphic-git@1.14.0',
+  version: '1.15.0',
+  agent: 'git/isomorphic-git@1.15.0',
 };
 
 class FIFO {
@@ -13489,6 +13495,162 @@ async function tag({
 
 // @ts-check
 
+/**
+ * Register file contents in the working tree or object database to the git index (aka staging area).
+ *
+ * @param {object} args
+ * @param {FsClient} args.fs - a file system client
+ * @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.filepath - File to act upon.
+ * @param {string} [args.oid] - OID of the object in the object database to add to the index with the specified filepath.
+ * @param {number} [args.mode = 100644] - The file mode to add the file to the index.
+ * @param {boolean} [args.add] - Adds the specified file to the index if it does not yet exist in the index.
+ * @param {boolean} [args.remove] - Remove the specified file from the index if it does not exist in the workspace anymore.
+ * @param {boolean} [args.force] - Remove the specified file from the index, even if it still exists in the workspace.
+ * @param {object} [args.cache] - a [cache](cache.md) object
+ *
+ * @returns {Promise<string | void>} Resolves successfully with the SHA-1 object id of the object written or updated in the index, or nothing if the file was removed.
+ *
+ * @example
+ * await git.updateIndex({
+ *   fs,
+ *   dir: '/tutorial',
+ *   filepath: 'readme.md'
+ * })
+ *
+ * @example
+ * // Manually create a blob in the object database.
+ * let oid = await git.writeBlob({
+ *   fs,
+ *   dir: '/tutorial',
+ *   blob: new Uint8Array([])
+ * })
+ *
+ * // Write the object in the object database to the index.
+ * await git.updateIndex({
+ *   fs,
+ *   dir: '/tutorial',
+ *   add: true,
+ *   filepath: 'readme.md',
+ *   oid
+ * })
+ */
+async function updateIndex({
+  fs: _fs,
+  dir,
+  gitdir = join(dir, '.git'),
+  cache = {},
+  filepath,
+  oid,
+  mode,
+  add,
+  remove,
+  force,
+}) {
+  try {
+    assertParameter('fs', _fs);
+    assertParameter('gitdir', gitdir);
+    assertParameter('filepath', filepath);
+
+    const fs = new FileSystem(_fs);
+
+    if (remove) {
+      return await GitIndexManager.acquire(
+        { fs, gitdir, cache },
+        async function(index) {
+          let fileStats;
+
+          if (!force) {
+            // Check if the file is still present in the working directory
+            fileStats = await fs.lstat(join(dir, filepath));
+
+            if (fileStats) {
+              // 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,
+          });
+        }
+      )
+    }
+
+    // Test if it is a file and exists on disk if `remove` is not provided, only of no oid is provided
+    let fileStats;
+
+    if (!oid) {
+      fileStats = await fs.lstat(join(dir, filepath));
+
+      if (!fileStats) {
+        throw new NotFoundError(
+          `file at "${filepath}" on disk and "remove" not set`
+        )
+      }
+
+      if (fileStats.isDirectory()) {
+        throw new InvalidFilepathError('directory')
+      }
+    }
+
+    return await GitIndexManager.acquire({ fs, gitdir, cache }, async function(
+      index
+    ) {
+      if (!add && !index.has({ filepath })) {
+        // If the index does not contain the filepath yet and `add` is not set, we should throw
+        throw new NotFoundError(
+          `file at "${filepath}" in index and "add" not set`
+        )
+      }
+
+      // By default we use 0 for the stats of the index file
+      let stats = {
+        ctime: new Date(0),
+        mtime: new Date(0),
+        dev: 0,
+        ino: 0,
+        mode,
+        uid: 0,
+        gid: 0,
+        size: 0,
+      };
+
+      if (!oid) {
+        stats = fileStats;
+
+        // Write the file to the object database
+        const object = stats.isSymbolicLink()
+          ? await fs.readlink(join(dir, filepath))
+          : await fs.read(join(dir, filepath));
+
+        oid = await _writeObject({
+          fs,
+          gitdir,
+          type: 'blob',
+          format: 'content',
+          object,
+        });
+      }
+
+      index.insert({
+        filepath,
+        oid: oid,
+        stats,
+      });
+
+      return oid
+    })
+  } catch (err) {
+    err.caller = 'git.updateIndex';
+    throw err
+  }
+}
+
+// @ts-check
+
 /**
  * Return the version number of isomorphic-git
  *
@@ -14259,6 +14421,7 @@ var index = {
   removeNote,
   renameBranch,
   resetIndex,
+  updateIndex,
   resolveRef,
   status,
   statusMatrix,
@@ -14332,6 +14495,7 @@ exports.setConfig = setConfig;
 exports.status = status;
 exports.statusMatrix = statusMatrix;
 exports.tag = tag;
+exports.updateIndex = updateIndex;
 exports.version = version;
 exports.walk = walk;
 exports.writeBlob = writeBlob;

package/index.d.ts

@@ -685,6 +685,7 @@ declare namespace index {
     export { removeNote };
     export { renameBranch };
     export { resetIndex };
+    export { updateIndex };
     export { resolveRef };
     export { status };
     export { statusMatrix };
@@ -3107,6 +3108,59 @@ export function tag({ fs: _fs, dir, gitdir, ref, object, force, }: {
     object?: string;
     force?: boolean;
 }): Promise<void>;
+/**
+ * Register file contents in the working tree or object database to the git index (aka staging area).
+ *
+ * @param {object} args
+ * @param {FsClient} args.fs - a file system client
+ * @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.filepath - File to act upon.
+ * @param {string} [args.oid] - OID of the object in the object database to add to the index with the specified filepath.
+ * @param {number} [args.mode = 100644] - The file mode to add the file to the index.
+ * @param {boolean} [args.add] - Adds the specified file to the index if it does not yet exist in the index.
+ * @param {boolean} [args.remove] - Remove the specified file from the index if it does not exist in the workspace anymore.
+ * @param {boolean} [args.force] - Remove the specified file from the index, even if it still exists in the workspace.
+ * @param {object} [args.cache] - a [cache](cache.md) object
+ *
+ * @returns {Promise<string | void>} Resolves successfully with the SHA-1 object id of the object written or updated in the index, or nothing if the file was removed.
+ *
+ * @example
+ * await git.updateIndex({
+ *   fs,
+ *   dir: '/tutorial',
+ *   filepath: 'readme.md'
+ * })
+ *
+ * @example
+ * // Manually create a blob in the object database.
+ * let oid = await git.writeBlob({
+ *   fs,
+ *   dir: '/tutorial',
+ *   blob: new Uint8Array([])
+ * })
+ *
+ * // Write the object in the object database to the index.
+ * await git.updateIndex({
+ *   fs,
+ *   dir: '/tutorial',
+ *   add: true,
+ *   filepath: 'readme.md',
+ *   oid
+ * })
+ */
+export function updateIndex({ fs: _fs, dir, gitdir, cache, filepath, oid, mode, add, remove, force, }: {
+    fs: CallbackFsClient | PromiseFsClient;
+    dir: string;
+    gitdir?: string;
+    filepath: string;
+    oid?: string;
+    mode?: number;
+    add?: boolean;
+    remove?: boolean;
+    force?: boolean;
+    cache?: any;
+}): Promise<string | void>;
 /**
  * Return the version number of isomorphic-git
  *
@@ -3735,13 +3789,13 @@ declare namespace InternalError {
 }
 declare class InvalidFilepathError extends BaseError {
     /**
-     * @param {'leading-slash'|'trailing-slash'} [reason]
+     * @param {'leading-slash'|'trailing-slash'|'directory'} [reason]
      */
-    constructor(reason?: "leading-slash" | "trailing-slash" | undefined);
+    constructor(reason?: "leading-slash" | "trailing-slash" | "directory" | undefined);
     code: "InvalidFilepathError";
     name: "InvalidFilepathError";
     data: {
-        reason: "leading-slash" | "trailing-slash" | undefined;
+        reason: "leading-slash" | "trailing-slash" | "directory" | undefined;
     };
 }
 declare namespace InvalidFilepathError {

package/index.js

@@ -756,6 +756,10 @@ class GitIndex {
     this._dirty = true;
   }
 
+  has({ filepath }) {
+    return this._entries.has(filepath)
+  }
+
   render() {
     return this.entries
       .map(entry => `${entry.mode.toString(8)} ${entry.oid}    ${entry.path}`)
@@ -3113,12 +3117,14 @@ HttpError.code = 'HttpError';
 
 class InvalidFilepathError extends BaseError {
   /**
-   * @param {'leading-slash'|'trailing-slash'} [reason]
+   * @param {'leading-slash'|'trailing-slash'|'directory'} [reason]
    */
   constructor(reason) {
     let message = 'invalid filepath';
     if (reason === 'leading-slash' || reason === 'trailing-slash') {
       message = `"filepath" parameter should not include leading or trailing directory separators because these can cause problems on some platforms.`;
+    } else if (reason === 'directory') {
+      message = `"filepath" should not be a directory.`;
     }
     super(message);
     this.code = this.name = InvalidFilepathError.code;
@@ -6906,8 +6912,8 @@ function filterCapabilities(server, client) {
 
 const pkg = {
   name: 'isomorphic-git',
-  version: '1.14.0',
-  agent: 'git/isomorphic-git@1.14.0',
+  version: '1.15.0',
+  agent: 'git/isomorphic-git@1.15.0',
 };
 
 class FIFO {
@@ -13483,6 +13489,162 @@ async function tag({
 
 // @ts-check
 
+/**
+ * Register file contents in the working tree or object database to the git index (aka staging area).
+ *
+ * @param {object} args
+ * @param {FsClient} args.fs - a file system client
+ * @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.filepath - File to act upon.
+ * @param {string} [args.oid] - OID of the object in the object database to add to the index with the specified filepath.
+ * @param {number} [args.mode = 100644] - The file mode to add the file to the index.
+ * @param {boolean} [args.add] - Adds the specified file to the index if it does not yet exist in the index.
+ * @param {boolean} [args.remove] - Remove the specified file from the index if it does not exist in the workspace anymore.
+ * @param {boolean} [args.force] - Remove the specified file from the index, even if it still exists in the workspace.
+ * @param {object} [args.cache] - a [cache](cache.md) object
+ *
+ * @returns {Promise<string | void>} Resolves successfully with the SHA-1 object id of the object written or updated in the index, or nothing if the file was removed.
+ *
+ * @example
+ * await git.updateIndex({
+ *   fs,
+ *   dir: '/tutorial',
+ *   filepath: 'readme.md'
+ * })
+ *
+ * @example
+ * // Manually create a blob in the object database.
+ * let oid = await git.writeBlob({
+ *   fs,
+ *   dir: '/tutorial',
+ *   blob: new Uint8Array([])
+ * })
+ *
+ * // Write the object in the object database to the index.
+ * await git.updateIndex({
+ *   fs,
+ *   dir: '/tutorial',
+ *   add: true,
+ *   filepath: 'readme.md',
+ *   oid
+ * })
+ */
+async function updateIndex({
+  fs: _fs,
+  dir,
+  gitdir = join(dir, '.git'),
+  cache = {},
+  filepath,
+  oid,
+  mode,
+  add,
+  remove,
+  force,
+}) {
+  try {
+    assertParameter('fs', _fs);
+    assertParameter('gitdir', gitdir);
+    assertParameter('filepath', filepath);
+
+    const fs = new FileSystem(_fs);
+
+    if (remove) {
+      return await GitIndexManager.acquire(
+        { fs, gitdir, cache },
+        async function(index) {
+          let fileStats;
+
+          if (!force) {
+            // Check if the file is still present in the working directory
+            fileStats = await fs.lstat(join(dir, filepath));
+
+            if (fileStats) {
+              // 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,
+          });
+        }
+      )
+    }
+
+    // Test if it is a file and exists on disk if `remove` is not provided, only of no oid is provided
+    let fileStats;
+
+    if (!oid) {
+      fileStats = await fs.lstat(join(dir, filepath));
+
+      if (!fileStats) {
+        throw new NotFoundError(
+          `file at "${filepath}" on disk and "remove" not set`
+        )
+      }
+
+      if (fileStats.isDirectory()) {
+        throw new InvalidFilepathError('directory')
+      }
+    }
+
+    return await GitIndexManager.acquire({ fs, gitdir, cache }, async function(
+      index
+    ) {
+      if (!add && !index.has({ filepath })) {
+        // If the index does not contain the filepath yet and `add` is not set, we should throw
+        throw new NotFoundError(
+          `file at "${filepath}" in index and "add" not set`
+        )
+      }
+
+      // By default we use 0 for the stats of the index file
+      let stats = {
+        ctime: new Date(0),
+        mtime: new Date(0),
+        dev: 0,
+        ino: 0,
+        mode,
+        uid: 0,
+        gid: 0,
+        size: 0,
+      };
+
+      if (!oid) {
+        stats = fileStats;
+
+        // Write the file to the object database
+        const object = stats.isSymbolicLink()
+          ? await fs.readlink(join(dir, filepath))
+          : await fs.read(join(dir, filepath));
+
+        oid = await _writeObject({
+          fs,
+          gitdir,
+          type: 'blob',
+          format: 'content',
+          object,
+        });
+      }
+
+      index.insert({
+        filepath,
+        oid: oid,
+        stats,
+      });
+
+      return oid
+    })
+  } catch (err) {
+    err.caller = 'git.updateIndex';
+    throw err
+  }
+}
+
+// @ts-check
+
 /**
  * Return the version number of isomorphic-git
  *
@@ -14253,6 +14415,7 @@ var index = {
   removeNote,
   renameBranch,
   resetIndex,
+  updateIndex,
   resolveRef,
   status,
   statusMatrix,
@@ -14268,4 +14431,4 @@ var index = {
 };
 
 export default index;
-export { Errors, STAGE, TREE, WORKDIR, add, addNote, addRemote, annotatedTag, branch, checkout, clone, commit, currentBranch, deleteBranch, deleteRef, deleteRemote, deleteTag, expandOid, expandRef, fastForward, fetch, findMergeBase, findRoot, getConfig, getConfigAll, getRemoteInfo, getRemoteInfo2, hashBlob, indexPack, init, isDescendent, isIgnored, listBranches, listFiles, listNotes, listRemotes, listServerRefs, listTags, log, merge, packObjects, pull, push, readBlob, readCommit, readNote, readObject, readTag, readTree, remove, removeNote, renameBranch, resetIndex, resolveRef, setConfig, status, statusMatrix, tag, version, walk, writeBlob, writeCommit, writeObject, writeRef, writeTag, writeTree };
+export { Errors, STAGE, TREE, WORKDIR, add, addNote, addRemote, annotatedTag, branch, checkout, clone, commit, currentBranch, deleteBranch, deleteRef, deleteRemote, deleteTag, expandOid, expandRef, fastForward, fetch, findMergeBase, findRoot, getConfig, getConfigAll, getRemoteInfo, getRemoteInfo2, hashBlob, indexPack, init, isDescendent, isIgnored, listBranches, listFiles, listNotes, listRemotes, listServerRefs, listTags, log, merge, packObjects, pull, push, readBlob, readCommit, readNote, readObject, readTag, readTree, remove, removeNote, renameBranch, resetIndex, resolveRef, setConfig, status, statusMatrix, tag, updateIndex, version, walk, writeBlob, writeCommit, writeObject, writeRef, writeTag, writeTree };

package/index.umd.min.d.ts

@@ -685,6 +685,7 @@ declare namespace index {
     export { removeNote };
     export { renameBranch };
     export { resetIndex };
+    export { updateIndex };
     export { resolveRef };
     export { status };
     export { statusMatrix };
@@ -3107,6 +3108,59 @@ export function tag({ fs: _fs, dir, gitdir, ref, object, force, }: {
     object?: string;
     force?: boolean;
 }): Promise<void>;
+/**
+ * Register file contents in the working tree or object database to the git index (aka staging area).
+ *
+ * @param {object} args
+ * @param {FsClient} args.fs - a file system client
+ * @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.filepath - File to act upon.
+ * @param {string} [args.oid] - OID of the object in the object database to add to the index with the specified filepath.
+ * @param {number} [args.mode = 100644] - The file mode to add the file to the index.
+ * @param {boolean} [args.add] - Adds the specified file to the index if it does not yet exist in the index.
+ * @param {boolean} [args.remove] - Remove the specified file from the index if it does not exist in the workspace anymore.
+ * @param {boolean} [args.force] - Remove the specified file from the index, even if it still exists in the workspace.
+ * @param {object} [args.cache] - a [cache](cache.md) object
+ *
+ * @returns {Promise<string | void>} Resolves successfully with the SHA-1 object id of the object written or updated in the index, or nothing if the file was removed.
+ *
+ * @example
+ * await git.updateIndex({
+ *   fs,
+ *   dir: '/tutorial',
+ *   filepath: 'readme.md'
+ * })
+ *
+ * @example
+ * // Manually create a blob in the object database.
+ * let oid = await git.writeBlob({
+ *   fs,
+ *   dir: '/tutorial',
+ *   blob: new Uint8Array([])
+ * })
+ *
+ * // Write the object in the object database to the index.
+ * await git.updateIndex({
+ *   fs,
+ *   dir: '/tutorial',
+ *   add: true,
+ *   filepath: 'readme.md',
+ *   oid
+ * })
+ */
+export function updateIndex({ fs: _fs, dir, gitdir, cache, filepath, oid, mode, add, remove, force, }: {
+    fs: CallbackFsClient | PromiseFsClient;
+    dir: string;
+    gitdir?: string;
+    filepath: string;
+    oid?: string;
+    mode?: number;
+    add?: boolean;
+    remove?: boolean;
+    force?: boolean;
+    cache?: any;
+}): Promise<string | void>;
 /**
  * Return the version number of isomorphic-git
  *
@@ -3735,13 +3789,13 @@ declare namespace InternalError {
 }
 declare class InvalidFilepathError extends BaseError {
     /**
-     * @param {'leading-slash'|'trailing-slash'} [reason]
+     * @param {'leading-slash'|'trailing-slash'|'directory'} [reason]
      */
-    constructor(reason?: "leading-slash" | "trailing-slash" | undefined);
+    constructor(reason?: "leading-slash" | "trailing-slash" | "directory" | undefined);
     code: "InvalidFilepathError";
     name: "InvalidFilepathError";
     data: {
-        reason: "leading-slash" | "trailing-slash" | undefined;
+        reason: "leading-slash" | "trailing-slash" | "directory" | undefined;
     };
 }
 declare namespace InvalidFilepathError {