es-git 0.2.0-next.116 → 0.2.0-next.118

package/index.d.ts

@@ -3997,6 +3997,84 @@ export declare class Repository {
    * staged deletes, tracked files, etc.
    */
   diffTreeToWorkdirWithIndex(oldTree?: Tree | undefined | null, options?: DiffOptions | undefined | null): Diff
+  /**
+   * Add ignore rules for a repository.
+   *
+   * This adds ignore rules to the repository. The rules will be used
+   * in addition to any existing ignore rules (such as .gitignore files).
+   *
+   * @category Repository/Methods
+   * @signature
+   * ```ts
+   * class Repository {
+   *   addIgnoreRule(rules: string): boolean;
+   * }
+   * ```
+   *
+   * @param {string} rules - Rules to add, separated by newlines.
+   *
+   * @example
+   * ```ts
+   * import { openRepository } from 'es-git';
+   *
+   * const repo = await openRepository('./path/to/repo');
+   * repo.addIgnoreRule("node_modules/");
+   * ```
+   */
+  addIgnoreRule(rules: string): void
+  /**
+   * Clear ignore rules that were explicitly added.
+   *
+   * Resets to the default internal ignore rules.
+   * This will not turn off rules in .gitignore files that actually exist in the filesystem.
+   * The default internal ignores ignore ".", ".." and ".git" entries.
+   *
+   * @category Repository/Methods
+   * @signature
+   * ```ts
+   * class Repository {
+   *   clearIgnoreRules(): void;
+   * }
+   * ```
+   *
+   * @example
+   * ```ts
+   * import { openRepository } from 'es-git';
+   *
+   * const repo = await openRepository('./path/to/repo');
+   * repo.addIgnoreRule("*.log");
+   * // Later, clear all added rules
+   * repo.clearIgnoreRules();
+   * ```
+   */
+  clearIgnoreRules(): void
+  /**
+   * Test if the ignore rules apply to a given path.
+   *
+   * This function checks the ignore rules to see if they would apply to the given file.
+   * This indicates if the file would be ignored regardless of whether the file is already in the index or committed to the repository.
+   *
+   * @category Repository/Methods
+   * @signature
+   * ```ts
+   * class Repository {
+   *   isPathIgnored(path: string): boolean;
+   * }
+   * ```
+   *
+   * @param {string} path - The path to check.
+   * @returns {boolean} - True if the path is ignored, false otherwise.
+   *
+   * @example
+   * ```ts
+   * import { openRepository } from 'es-git';
+   *
+   * const repo = await openRepository('./path/to/repo');
+   * const isIgnored = repo.isPathIgnored("node_modules/some-package");
+   * console.log(`Path is ${isIgnored ? "ignored" : "not ignored"}`);
+   * ```
+   */
+  isPathIgnored(path: string): boolean
   /**
    * Get the Index file for this repository.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "es-git",
-  "version": "0.2.0-next.116+9dca0a0",
+  "version": "0.2.0-next.118+6fb9518",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
@@ -57,15 +57,15 @@
     "vitest": "^3.0.5"
   },
   "optionalDependencies": {
-    "es-git-darwin-x64": "0.2.0-next.116+9dca0a0",
-    "es-git-darwin-arm64": "0.2.0-next.116+9dca0a0",
-    "es-git-win32-x64-msvc": "0.2.0-next.116+9dca0a0",
-    "es-git-win32-arm64-msvc": "0.2.0-next.116+9dca0a0",
-    "es-git-linux-x64-gnu": "0.2.0-next.116+9dca0a0",
-    "es-git-linux-x64-musl": "0.2.0-next.116+9dca0a0",
-    "es-git-android-arm64": "0.2.0-next.116+9dca0a0",
-    "es-git-linux-arm64-gnu": "0.2.0-next.116+9dca0a0",
-    "es-git-linux-arm64-musl": "0.2.0-next.116+9dca0a0",
-    "es-git-android-arm-eabi": "0.2.0-next.116+9dca0a0"
+    "es-git-darwin-x64": "0.2.0-next.118+6fb9518",
+    "es-git-darwin-arm64": "0.2.0-next.118+6fb9518",
+    "es-git-win32-x64-msvc": "0.2.0-next.118+6fb9518",
+    "es-git-win32-arm64-msvc": "0.2.0-next.118+6fb9518",
+    "es-git-linux-x64-gnu": "0.2.0-next.118+6fb9518",
+    "es-git-linux-x64-musl": "0.2.0-next.118+6fb9518",
+    "es-git-android-arm64": "0.2.0-next.118+6fb9518",
+    "es-git-linux-arm64-gnu": "0.2.0-next.118+6fb9518",
+    "es-git-linux-arm64-musl": "0.2.0-next.118+6fb9518",
+    "es-git-android-arm-eabi": "0.2.0-next.118+6fb9518"
   }
 }