isomorphic-git 1.26.4 → 1.27.0

package/index.js

@@ -3573,6 +3573,21 @@ class IndexResetError extends BaseError {
 /** @type {'IndexResetError'} */
 IndexResetError.code = 'IndexResetError';
 
+class NoCommitError extends BaseError {
+  /**
+   * @param {string} ref
+   */
+  constructor(ref) {
+    super(
+      `"${ref}" does not point to any commit. You're maybe working on a repository with no commits yet. `
+    );
+    this.code = this.name = NoCommitError.code;
+    this.data = { ref };
+  }
+}
+/** @type {'NoCommitError'} */
+NoCommitError.code = 'NoCommitError';
+
 
 
 var Errors = /*#__PURE__*/Object.freeze({
@@ -3607,7 +3622,8 @@ var Errors = /*#__PURE__*/Object.freeze({
   UrlParseError: UrlParseError,
   UserCanceledError: UserCanceledError,
   UnmergedPathsError: UnmergedPathsError,
-  IndexResetError: IndexResetError
+  IndexResetError: IndexResetError,
+  NoCommitError: NoCommitError
 });
 
 function formatAuthor({ name, email, timestamp, timezoneOffset }) {
@@ -5165,6 +5181,177 @@ async function addToIndex({
 
 // @ts-check
 
+/**
+ * @param {Object} args
+ * @param {import('../models/FileSystem.js').FileSystem} args.fs
+ * @param {string} args.gitdir
+ * @param {string} args.path
+ *
+ * @returns {Promise<any>} Resolves with the config value
+ *
+ * @example
+ * // Read config value
+ * let value = await git.getConfig({
+ *   dir: '$input((/))',
+ *   path: '$input((user.name))'
+ * })
+ * console.log(value)
+ *
+ */
+async function _getConfig({ fs, gitdir, path }) {
+  const config = await GitConfigManager.get({ fs, gitdir });
+  return config.get(path)
+}
+
+// Like Object.assign but ignore properties with undefined values
+// ref: https://stackoverflow.com/q/39513815
+function assignDefined(target, ...sources) {
+  for (const source of sources) {
+    if (source) {
+      for (const key of Object.keys(source)) {
+        const val = source[key];
+        if (val !== undefined) {
+          target[key] = val;
+        }
+      }
+    }
+  }
+  return target
+}
+
+/**
+ * Return author object by using properties following this priority:
+ * (1) provided author object
+ * -> (2) author of provided commit object
+ * -> (3) Config and current date/time
+ *
+ * @param {Object} args
+ * @param {FsClient} args.fs - a file system implementation
+ * @param {string} [args.gitdir] - The [git directory](dir-vs-gitdir.md) path
+ * @param {Object} [args.author] - The author object.
+ * @param {CommitObject} [args.commit] - A commit object.
+ *
+ * @returns {Promise<void | {name: string, email: string, timestamp: number, timezoneOffset: number }>}
+ */
+async function normalizeAuthorObject({ fs, gitdir, author, commit }) {
+  const timestamp = Math.floor(Date.now() / 1000);
+
+  const defaultAuthor = {
+    name: await _getConfig({ fs, gitdir, path: 'user.name' }),
+    email: (await _getConfig({ fs, gitdir, path: 'user.email' })) || '', // author.email is allowed to be empty string
+    timestamp,
+    timezoneOffset: new Date(timestamp * 1000).getTimezoneOffset(),
+  };
+
+  // Populate author object by using properties with this priority:
+  // (1) provided author object
+  // -> (2) author of provided commit object
+  // -> (3) default author
+  const normalizedAuthor = assignDefined(
+    {},
+    defaultAuthor,
+    commit ? commit.author : undefined,
+    author
+  );
+
+  if (normalizedAuthor.name === undefined) {
+    return undefined
+  }
+
+  return normalizedAuthor
+}
+
+/**
+ * Return committer object by using properties with this priority:
+ * (1) provided committer object
+ * -> (2) provided author object
+ * -> (3) committer of provided commit object
+ * -> (4) Config and current date/time
+ *
+ * @param {Object} args
+ * @param {FsClient} args.fs - a file system implementation
+ * @param {string} [args.gitdir] - The [git directory](dir-vs-gitdir.md) path
+ * @param {Object} [args.author] - The author object.
+ * @param {Object} [args.committer] - The committer object.
+ * @param {CommitObject} [args.commit] - A commit object.
+ *
+ * @returns {Promise<void | {name: string, email: string, timestamp: number, timezoneOffset: number }>}
+ */
+async function normalizeCommitterObject({
+  fs,
+  gitdir,
+  author,
+  committer,
+  commit,
+}) {
+  const timestamp = Math.floor(Date.now() / 1000);
+
+  const defaultCommitter = {
+    name: await _getConfig({ fs, gitdir, path: 'user.name' }),
+    email: (await _getConfig({ fs, gitdir, path: 'user.email' })) || '', // committer.email is allowed to be empty string
+    timestamp,
+    timezoneOffset: new Date(timestamp * 1000).getTimezoneOffset(),
+  };
+
+  const normalizedCommitter = assignDefined(
+    {},
+    defaultCommitter,
+    commit ? commit.committer : undefined,
+    author,
+    committer
+  );
+
+  if (normalizedCommitter.name === undefined) {
+    return undefined
+  }
+  return normalizedCommitter
+}
+
+async function resolveCommit({ fs, cache, gitdir, oid }) {
+  const { type, object } = await _readObject({ fs, cache, gitdir, oid });
+  // Resolve annotated tag objects to whatever
+  if (type === 'tag') {
+    oid = GitAnnotatedTag.from(object).parse().object;
+    return resolveCommit({ fs, cache, gitdir, oid })
+  }
+  if (type !== 'commit') {
+    throw new ObjectTypeError(oid, type, 'commit')
+  }
+  return { commit: GitCommit.from(object), oid }
+}
+
+// @ts-check
+
+/**
+ * @param {object} args
+ * @param {import('../models/FileSystem.js').FileSystem} args.fs
+ * @param {any} args.cache
+ * @param {string} args.gitdir
+ * @param {string} args.oid
+ *
+ * @returns {Promise<ReadCommitResult>} Resolves successfully with a git commit object
+ * @see ReadCommitResult
+ * @see CommitObject
+ *
+ */
+async function _readCommit({ fs, cache, gitdir, oid }) {
+  const { commit, oid: commitOid } = await resolveCommit({
+    fs,
+    cache,
+    gitdir,
+    oid,
+  });
+  const result = {
+    oid: commitOid,
+    commit: commit.parse(),
+    payload: commit.withoutSignature(),
+  };
+  // @ts-ignore
+  return result
+}
+
+// @ts-check
+
 /**
  *
  * @param {Object} args
@@ -5172,18 +5359,19 @@ async function addToIndex({
  * @param {object} args.cache
  * @param {SignCallback} [args.onSign]
  * @param {string} args.gitdir
- * @param {string} args.message
- * @param {Object} args.author
- * @param {string} args.author.name
- * @param {string} args.author.email
- * @param {number} args.author.timestamp
- * @param {number} args.author.timezoneOffset
- * @param {Object} args.committer
- * @param {string} args.committer.name
- * @param {string} args.committer.email
- * @param {number} args.committer.timestamp
- * @param {number} args.committer.timezoneOffset
+ * @param {string} [args.message]
+ * @param {Object} [args.author]
+ * @param {string} [args.author.name]
+ * @param {string} [args.author.email]
+ * @param {number} [args.author.timestamp]
+ * @param {number} [args.author.timezoneOffset]
+ * @param {Object} [args.committer]
+ * @param {string} [args.committer.name]
+ * @param {string} [args.committer.email]
+ * @param {number} [args.committer.timestamp]
+ * @param {number} [args.committer.timezoneOffset]
  * @param {string} [args.signingKey]
+ * @param {boolean} [args.amend = false]
  * @param {boolean} [args.dryRun = false]
  * @param {boolean} [args.noUpdateBranch = false]
  * @param {string} [args.ref]
@@ -5198,15 +5386,18 @@ async function _commit({
   onSign,
   gitdir,
   message,
-  author,
-  committer,
+  author: _author,
+  committer: _committer,
   signingKey,
+  amend = false,
   dryRun = false,
   noUpdateBranch = false,
   ref,
   parent,
   tree,
 }) {
+  // Determine ref and the commit pointed to by ref, and if it is the initial commit
+  let initialCommit = false;
   if (!ref) {
     ref = await GitRefManager.resolve({
       fs,
@@ -5216,6 +5407,50 @@ async function _commit({
     });
   }
 
+  let refOid, refCommit;
+  try {
+    refOid = await GitRefManager.resolve({
+      fs,
+      gitdir,
+      ref,
+    });
+    refCommit = await _readCommit({ fs, gitdir, oid: refOid, cache: {} });
+  } catch {
+    // We assume that there's no commit and this is the initial commit
+    initialCommit = true;
+  }
+
+  if (amend && initialCommit) {
+    throw new NoCommitError(ref)
+  }
+
+  // Determine author and committer information
+  const author = !amend
+    ? await normalizeAuthorObject({ fs, gitdir, author: _author })
+    : await normalizeAuthorObject({
+        fs,
+        gitdir,
+        author: _author,
+        commit: refCommit.commit,
+      });
+  if (!author) throw new MissingNameError('author')
+
+  const committer = !amend
+    ? await normalizeCommitterObject({
+        fs,
+        gitdir,
+        author,
+        committer: _committer,
+      })
+    : await normalizeCommitterObject({
+        fs,
+        gitdir,
+        author,
+        committer: _committer,
+        commit: refCommit.commit,
+      });
+  if (!committer) throw new MissingNameError('committer')
+
   return GitIndexManager.acquire(
     { fs, gitdir, cache, allowUnmerged: false },
     async function(index) {
@@ -5224,18 +5459,13 @@ async function _commit({
       if (!tree) {
         tree = await constructTree({ fs, gitdir, inode, dryRun });
       }
+
+      // Determine parents of this commit
       if (!parent) {
-        try {
-          parent = [
-            await GitRefManager.resolve({
-              fs,
-              gitdir,
-              ref,
-            }),
-          ];
-        } catch (err) {
-          // Probably an initial commit
-          parent = [];
+        if (!amend) {
+          parent = refOid ? [refOid] : [];
+        } else {
+          parent = refCommit.commit.parent;
         }
       } else {
         // ensure that the parents are oids, not refs
@@ -5246,6 +5476,16 @@ async function _commit({
         );
       }
 
+      // Determine message of this commit
+      if (!message) {
+        if (!amend) {
+          throw new MissingParameterError('message')
+        } else {
+          message = refCommit.commit.message;
+        }
+      }
+
+      // Create and write new Commit object
       let comm = GitCommit.from({
         tree,
         parent,
@@ -5545,72 +5785,6 @@ async function _addNote({
 
 // @ts-check
 
-/**
- * @param {Object} args
- * @param {import('../models/FileSystem.js').FileSystem} args.fs
- * @param {string} args.gitdir
- * @param {string} args.path
- *
- * @returns {Promise<any>} Resolves with the config value
- *
- * @example
- * // Read config value
- * let value = await git.getConfig({
- *   dir: '$input((/))',
- *   path: '$input((user.name))'
- * })
- * console.log(value)
- *
- */
-async function _getConfig({ fs, gitdir, path }) {
-  const config = await GitConfigManager.get({ fs, gitdir });
-  return config.get(path)
-}
-
-/**
- *
- * @returns {Promise<void | {name: string, email: string, date: Date, timestamp: number, timezoneOffset: number }>}
- */
-async function normalizeAuthorObject({ fs, gitdir, author = {} }) {
-  let { name, email, timestamp, timezoneOffset } = author;
-  name = name || (await _getConfig({ fs, gitdir, path: 'user.name' }));
-  email = email || (await _getConfig({ fs, gitdir, path: 'user.email' })) || '';
-
-  if (name === undefined) {
-    return undefined
-  }
-
-  timestamp = timestamp != null ? timestamp : Math.floor(Date.now() / 1000);
-  timezoneOffset =
-    timezoneOffset != null
-      ? timezoneOffset
-      : new Date(timestamp * 1000).getTimezoneOffset();
-
-  return { name, email, timestamp, timezoneOffset }
-}
-
-/**
- *
- * @returns {Promise<void | {name: string, email: string, timestamp: number, timezoneOffset: number }>}
- */
-async function normalizeCommitterObject({
-  fs,
-  gitdir,
-  author,
-  committer,
-}) {
-  committer = Object.assign({}, committer || author);
-  // Match committer's date to author's one, if omitted
-  if (author) {
-    committer.timestamp = committer.timestamp || author.timestamp;
-    committer.timezoneOffset = committer.timezoneOffset || author.timezoneOffset;
-  }
-  committer = await normalizeAuthorObject({ fs, gitdir, author: committer });
-  return committer
-}
-
-// @ts-check
-
 /**
  * Add or update an object note
  *
@@ -7446,8 +7620,8 @@ function filterCapabilities(server, client) {
 
 const pkg = {
   name: 'isomorphic-git',
-  version: '1.26.4',
-  agent: 'git/isomorphic-git@1.26.4',
+  version: '1.27.0',
+  agent: 'git/isomorphic-git@1.27.0',
 };
 
 class FIFO {
@@ -8397,7 +8571,6 @@ async function clone({
 }
 
 // @ts-check
-
 /**
  * Create a new commit
  *
@@ -8406,7 +8579,7 @@ async function clone({
  * @param {SignCallback} [args.onSign] - a PGP signing implementation
  * @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.message - The commit message to use.
+ * @param {string} [args.message] - The commit message to use. Required, unless `amend === true`
  * @param {Object} [args.author] - The details about the author.
  * @param {string} [args.author.name] - Default is `user.name` config.
  * @param {string} [args.author.email] - Default is `user.email` config.
@@ -8418,6 +8591,7 @@ async function clone({
  * @param {number} [args.committer.timestamp=Math.floor(Date.now()/1000)] - Set the committer timestamp field. This is the integer number of seconds since the Unix epoch (1970-01-01 00:00:00).
  * @param {number} [args.committer.timezoneOffset] - Set the committer timezone offset field. This is the difference, in minutes, from the current timezone to UTC. Default is `(new Date()).getTimezoneOffset()`.
  * @param {string} [args.signingKey] - Sign the tag object using this private PGP key.
+ * @param {boolean} [args.amend = false] - If true, replaces the last commit pointed to by `ref` with a new commit.
  * @param {boolean} [args.dryRun = false] - If true, simulates making a commit so you can test whether it would succeed. Implies `noUpdateBranch`.
  * @param {boolean} [args.noUpdateBranch = false] - If true, does not update the branch pointer after creating the commit.
  * @param {string} [args.ref] - The fully expanded name of the branch to commit to. Default is the current branch pointed to by HEAD. (TODO: fix it so it can expand branch names without throwing if the branch doesn't exist yet.)
@@ -8446,9 +8620,10 @@ async function commit({
   dir,
   gitdir = join(dir, '.git'),
   message,
-  author: _author,
-  committer: _committer,
+  author,
+  committer,
   signingKey,
+  amend = false,
   dryRun = false,
   noUpdateBranch = false,
   ref,
@@ -8458,23 +8633,14 @@ async function commit({
 }) {
   try {
     assertParameter('fs', _fs);
-    assertParameter('message', message);
+    if (!amend) {
+      assertParameter('message', message);
+    }
     if (signingKey) {
       assertParameter('onSign', onSign);
     }
     const fs = new FileSystem(_fs);
 
-    const author = await normalizeAuthorObject({ fs, gitdir, author: _author });
-    if (!author) throw new MissingNameError('author')
-
-    const committer = await normalizeCommitterObject({
-      fs,
-      gitdir,
-      author,
-      committer: _committer,
-    });
-    if (!committer) throw new MissingNameError('committer')
-
     return await _commit({
       fs,
       cache,
@@ -8484,6 +8650,7 @@ async function commit({
       author,
       committer,
       signingKey,
+      amend,
       dryRun,
       noUpdateBranch,
       ref,
@@ -11209,49 +11376,6 @@ async function listTags({ fs, dir, gitdir = join(dir, '.git') }) {
   }
 }
 
-async function resolveCommit({ fs, cache, gitdir, oid }) {
-  const { type, object } = await _readObject({ fs, cache, gitdir, oid });
-  // Resolve annotated tag objects to whatever
-  if (type === 'tag') {
-    oid = GitAnnotatedTag.from(object).parse().object;
-    return resolveCommit({ fs, cache, gitdir, oid })
-  }
-  if (type !== 'commit') {
-    throw new ObjectTypeError(oid, type, 'commit')
-  }
-  return { commit: GitCommit.from(object), oid }
-}
-
-// @ts-check
-
-/**
- * @param {object} args
- * @param {import('../models/FileSystem.js').FileSystem} args.fs
- * @param {any} args.cache
- * @param {string} args.gitdir
- * @param {string} args.oid
- *
- * @returns {Promise<ReadCommitResult>} Resolves successfully with a git commit object
- * @see ReadCommitResult
- * @see CommitObject
- *
- */
-async function _readCommit({ fs, cache, gitdir, oid }) {
-  const { commit, oid: commitOid } = await resolveCommit({
-    fs,
-    cache,
-    gitdir,
-    oid,
-  });
-  const result = {
-    oid: commitOid,
-    commit: commit.parse(),
-    payload: commit.withoutSignature(),
-  };
-  // @ts-ignore
-  return result
-}
-
 function compareAge(a, b) {
   return a.committer.timestamp - b.committer.timestamp
 }
@@ -12467,7 +12591,12 @@ async function _push({
   }
 
   // Update the local copy of the remote ref
-  if (remote && result.ok && result.refs[fullRemoteRef].ok) {
+  if (
+    remote &&
+    result.ok &&
+    result.refs[fullRemoteRef].ok &&
+    !fullRef.startsWith('refs/tags')
+  ) {
     // TODO: I think this should actually be using a refspec transform rather than assuming 'refs/remotes/{remote}'
     const ref = `refs/remotes/${remote}/${fullRemoteRef.replace(
       'refs/heads',
@@ -12514,7 +12643,7 @@ async function _push({
  * @param {PrePushCallback} [args.onPrePush] - optional pre-push hook callback
  * @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] - Which branch to push. By default this is the currently checked out branch.
+ * @param {string} [args.ref] - Which branch or tag to push. By default this is the currently checked out branch.
  * @param {string} [args.url] - The URL of the remote repository. The default is the value set in the git config for that remote.
  * @param {string} [args.remote] - If URL is not specified, determines which remote to use.
  * @param {string} [args.remoteRef] - The name of the receiving branch on the remote. By default this is the configured remote tracking branch.

package/index.umd.min.d.ts

@@ -789,6 +789,7 @@ export var Errors: Readonly<{
     UserCanceledError: typeof UserCanceledError;
     UnmergedPathsError: typeof UnmergedPathsError;
     IndexResetError: typeof IndexResetError;
+    NoCommitError: typeof NoCommitError;
 }>;
 /**
  * @returns {Walker}
@@ -1180,7 +1181,7 @@ export function clone({ fs, http, onProgress, onMessage, onAuth, onAuthSuccess,
  * @param {SignCallback} [args.onSign] - a PGP signing implementation
  * @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.message - The commit message to use.
+ * @param {string} [args.message] - The commit message to use. Required, unless `amend === true`
  * @param {Object} [args.author] - The details about the author.
  * @param {string} [args.author.name] - Default is `user.name` config.
  * @param {string} [args.author.email] - Default is `user.email` config.
@@ -1192,6 +1193,7 @@ export function clone({ fs, http, onProgress, onMessage, onAuth, onAuthSuccess,
  * @param {number} [args.committer.timestamp=Math.floor(Date.now()/1000)] - Set the committer timestamp field. This is the integer number of seconds since the Unix epoch (1970-01-01 00:00:00).
  * @param {number} [args.committer.timezoneOffset] - Set the committer timezone offset field. This is the difference, in minutes, from the current timezone to UTC. Default is `(new Date()).getTimezoneOffset()`.
  * @param {string} [args.signingKey] - Sign the tag object using this private PGP key.
+ * @param {boolean} [args.amend = false] - If true, replaces the last commit pointed to by `ref` with a new commit.
  * @param {boolean} [args.dryRun = false] - If true, simulates making a commit so you can test whether it would succeed. Implies `noUpdateBranch`.
  * @param {boolean} [args.noUpdateBranch = false] - If true, does not update the branch pointer after creating the commit.
  * @param {string} [args.ref] - The fully expanded name of the branch to commit to. Default is the current branch pointed to by HEAD. (TODO: fix it so it can expand branch names without throwing if the branch doesn't exist yet.)
@@ -1214,12 +1216,12 @@ export function clone({ fs, http, onProgress, onMessage, onAuth, onAuthSuccess,
  * console.log(sha)
  *
  */
-export function commit({ fs: _fs, onSign, dir, gitdir, message, author: _author, committer: _committer, signingKey, dryRun, noUpdateBranch, ref, parent, tree, cache, }: {
+export function commit({ fs: _fs, onSign, dir, gitdir, message, author, committer, signingKey, amend, dryRun, noUpdateBranch, ref, parent, tree, cache, }: {
     fs: CallbackFsClient | PromiseFsClient;
     onSign?: SignCallback;
     dir?: string;
     gitdir?: string;
-    message: string;
+    message?: string;
     author?: {
         name?: string;
         email?: string;
@@ -1233,6 +1235,7 @@ export function commit({ fs: _fs, onSign, dir, gitdir, message, author: _author,
         timezoneOffset?: number;
     };
     signingKey?: string;
+    amend?: boolean;
     dryRun?: boolean;
     noUpdateBranch?: boolean;
     ref?: string;
@@ -2463,7 +2466,7 @@ export function pull({ fs: _fs, http, onProgress, onMessage, onAuth, onAuthSucce
  * @param {PrePushCallback} [args.onPrePush] - optional pre-push hook callback
  * @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] - Which branch to push. By default this is the currently checked out branch.
+ * @param {string} [args.ref] - Which branch or tag to push. By default this is the currently checked out branch.
  * @param {string} [args.url] - The URL of the remote repository. The default is the value set in the git config for that remote.
  * @param {string} [args.remote] - If URL is not specified, determines which remote to use.
  * @param {string} [args.remoteRef] - The name of the receiving branch on the remote. By default this is the configured remote tracking branch.
@@ -4303,6 +4306,21 @@ declare namespace IndexResetError {
     const code_30: 'IndexResetError';
     export { code_30 as code };
 }
+declare class NoCommitError extends BaseError {
+    /**
+     * @param {string} ref
+     */
+    constructor(ref: string);
+    code: "NoCommitError";
+    name: "NoCommitError";
+    data: {
+        ref: string;
+    };
+}
+declare namespace NoCommitError {
+    const code_31: 'NoCommitError';
+    export { code_31 as code };
+}
 /**
  * @typedef {Object} GitProgressEvent
  * @property {string} phase