es-git 0.5.0-next.163 → 0.5.0-next.165

package/index.d.ts

@@ -1083,6 +1083,28 @@ export declare class Deltas extends Iterator<DiffDelta, void, void> {
   next(value?: void): IteratorResult<DiffDelta, void>
 }
 
+/**
+ * The result of a `describe` operation on either an `Describe` or a
+ * `Repository`.
+ */
+export declare class Describe {
+  /**
+   * Prints this describe result, returning the result as a string.
+   *
+   * @category Describe/Methods
+   * @signature
+   * ```ts
+   * class Describe {
+   *   format(options?: DescribeFormatOptions | null | undefined): string;
+   * }
+   * ```
+   *
+   * @param {DescribeFormatOptions} [options] - Options for formatting describe.
+   * @returns Formatted string for this describe.
+   */
+  format(options?: DescribeFormatOptions | undefined | null): string
+}
+
 /**
  * The diff object that contains all individual file deltas.
  *
@@ -1530,6 +1552,23 @@ export declare class GitObject {
    * @returns Returns `null` if the object is not actually a commit.
    */
   asCommit(): Commit | null
+  /**
+   * Describes a commit
+   *
+   * Performs a describe operation on this commitish object.
+   *
+   * @category GitObject/Methods
+   * @signature
+   * ```ts
+   * class Object {
+   *   describe(options?: DescribeOptions | null | undefined): Describe;
+   * }
+   * ```
+   *
+   * @param {DescribeOptions} [options] - Options for describe operation.
+   * @returns Instance of describe.
+   */
+  describe(options?: DescribeOptions | undefined | null): Describe
 }
 
 /**
@@ -4545,6 +4584,25 @@ export declare class Repository {
    * @returns If it does not exist, returns `null`.
    */
   findTree(oid: string): Tree | null
+  /**
+   * Describes a commit
+   *
+   * Performs a describe operation on the current commit and the worktree.
+   * After performing a describe on `HEAD`, a status is run and description is
+   * considered to be dirty if there are.
+   *
+   * @category Repository/Methods
+   * @signature
+   * ```ts
+   * class Repository {
+   *   describe(options?: DescribeOptions | null | undefined): Describe;
+   * }
+   * ```
+   *
+   * @param {DescribeOptions} [options] - Options for describe operation.
+   * @returns Instance of describe.
+   */
+  describe(options?: DescribeOptions | undefined | null): Describe
 }
 
 /**
@@ -6091,6 +6149,54 @@ export type DeltaType =  'Unmodified'|
 'Unreadable'|
 'Conflicted';
 
+export interface DescribeFormatOptions {
+  /**
+   * Sets the size of the abbreviated commit id to use.
+   *
+   * The value is the lower bound for the length of the abbreviated string,
+   * and the default is 7.
+   */
+  abbreviatedSize?: number
+  /**
+   * Sets whether or not the long format is used even when a shorter name
+   * could be used.
+   */
+  alwaysUseLongFormat?: boolean
+  /**
+   * If the workdir is dirty and this is set, this string will be appended to
+   * the description string.
+   */
+  dirtySuffix?: string
+}
+
+export interface DescribeOptions {
+  maxCandidatesTags?: number
+  /**
+   * Sets the reference lookup strategy
+   *
+   * This behaves like the `--tags` option to git-describe.
+   */
+  describeTags?: boolean
+  /**
+   * Sets the reference lookup strategy
+   *
+   * This behaves like the `--all` option to git-describe.
+   */
+  describeAll?: boolean
+  /**
+   * Indicates when calculating the distance from the matching tag or
+   * reference whether to only walk down the first-parent ancestry.
+   */
+  onlyFollowFirstParent?: boolean
+  /**
+   * If no matching tag or reference is found whether a describe option would
+   * normally fail. This option indicates, however, that it will instead fall
+   * back to showing the full id of the commit.
+   */
+  showCommitOidAsFallback?: boolean
+  pattern?: string
+}
+
 export interface DiffFindOptions {
   /** Look for renames? */
   renames?: boolean

package/index.js

@@ -583,6 +583,7 @@ module.exports.Commit = nativeBinding.Commit
 module.exports.Config = nativeBinding.Config
 module.exports.ConfigEntries = nativeBinding.ConfigEntries
 module.exports.Deltas = nativeBinding.Deltas
+module.exports.Describe = nativeBinding.Describe
 module.exports.Diff = nativeBinding.Diff
 module.exports.DiffDelta = nativeBinding.DiffDelta
 module.exports.DiffFile = nativeBinding.DiffFile

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "es-git",
-  "version": "0.5.0-next.163+9aa9566",
+  "version": "0.5.0-next.165+a053e66",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
@@ -54,15 +54,15 @@
     "vitest": "^3.0.5"
   },
   "optionalDependencies": {
-    "es-git-darwin-x64": "0.5.0-next.163+9aa9566",
-    "es-git-darwin-arm64": "0.5.0-next.163+9aa9566",
-    "es-git-win32-x64-msvc": "0.5.0-next.163+9aa9566",
-    "es-git-win32-arm64-msvc": "0.5.0-next.163+9aa9566",
-    "es-git-linux-x64-gnu": "0.5.0-next.163+9aa9566",
-    "es-git-linux-x64-musl": "0.5.0-next.163+9aa9566",
-    "es-git-android-arm64": "0.5.0-next.163+9aa9566",
-    "es-git-linux-arm64-gnu": "0.5.0-next.163+9aa9566",
-    "es-git-linux-arm64-musl": "0.5.0-next.163+9aa9566",
-    "es-git-android-arm-eabi": "0.5.0-next.163+9aa9566"
+    "es-git-darwin-x64": "0.5.0-next.165+a053e66",
+    "es-git-darwin-arm64": "0.5.0-next.165+a053e66",
+    "es-git-win32-x64-msvc": "0.5.0-next.165+a053e66",
+    "es-git-win32-arm64-msvc": "0.5.0-next.165+a053e66",
+    "es-git-linux-x64-gnu": "0.5.0-next.165+a053e66",
+    "es-git-linux-x64-musl": "0.5.0-next.165+a053e66",
+    "es-git-android-arm64": "0.5.0-next.165+a053e66",
+    "es-git-linux-arm64-gnu": "0.5.0-next.165+a053e66",
+    "es-git-linux-arm64-musl": "0.5.0-next.165+a053e66",
+    "es-git-android-arm-eabi": "0.5.0-next.165+a053e66"
   }
 }