view-ignored 0.7.0 → 0.7.1

package/out/patterns/extractor.d.ts

@@ -77,4 +77,10 @@ export interface PatternFinderOptions {
      * @since 0.6.0
      */
     root: string;
+    /**
+     * Return as soon as possible.
+     *
+     * @since 0.7.1
+     */
+    signal: AbortSignal | null;
 }

package/out/patterns/ignores.d.ts

@@ -1,11 +1,40 @@
 import type { MatcherContext } from "../patterns/matcherContext.js";
 import type { SignedPatternMatch } from "../patterns/signedPattern.js";
 import type { FsAdapter } from "../types.js";
+/**
+ * Used in {@link Ignores}.
+ *
+ * @since 0.6.0
+ */
 export interface IgnoresOptions {
+    /**
+     * The file system adapter for directory walking and reading files.
+     *
+     * @since 0.6.0
+     */
     fs: FsAdapter;
+    /**
+     * @since 0.6.0
+     */
     cwd: string;
+    /**
+     * File or directory without the slash suffix.
+     *
+     * @since 0.6.0
+     */
     entry: string;
+    /**
+     * The context to populate.
+     *
+     * @since 0.6.0
+     */
     ctx: MatcherContext;
+    /**
+     * Return as soon as possible.
+     *
+     * @since 0.7.1
+     */
+    signal: AbortSignal | null;
 }
 /**
  * Checks whether a given entry path should be ignored based on its patterns.

package/out/patterns/matcherContextPatch.js

@@ -14,7 +14,7 @@ export async function matcherContextAddPath(ctx, options, entry) {
     if (ctx.paths.has(entry)) {
         return false;
     }
-    const { target, fs, cwd } = options;
+    const { target, fs, cwd, signal } = options;
     const isDir = entry.endsWith("/");
     if (isDir) {
         // recursive parent population
@@ -22,7 +22,7 @@ export async function matcherContextAddPath(ctx, options, entry) {
         if (direntPath === ".") {
             return true;
         }
-        ctx.paths.set(entry, await target.ignores({ fs, cwd, entry: direntPath, ctx }));
+        ctx.paths.set(entry, await target.ignores({ fs, cwd, entry: direntPath, ctx, signal }));
         if (ctx.totalFiles >= 0) {
             ctx.totalDirs++;
         }
@@ -43,7 +43,7 @@ export async function matcherContextAddPath(ctx, options, entry) {
     // 1. recursively populate parents
     await matcherContextAddPath(ctx, options, parent + "/");
     // 2. if ignored, remove, otherwise add
-    const match = await target.ignores({ fs, cwd, entry, ctx });
+    const match = await target.ignores({ fs, cwd, entry, ctx, signal });
     if (match.ignored) {
         // 2.1. remove
         await matcherContextRemovePath(ctx, options, entry);

package/out/patterns/resolveSources.js

@@ -22,7 +22,7 @@ export function signedPatternCompile(signedPattern) {
  * @since 0.6.0
  */
 export async function resolveSources(options) {
-    const { fs, ctx, cwd, target, root } = options;
+    const { fs, ctx, cwd, target, root, signal } = options;
     let dir = options.dir;
     if (ctx.external.has(dir)) {
         return;
@@ -33,6 +33,7 @@ export async function resolveSources(options) {
         dir = dirname(dir);
         // find source from an ancestor [dir < ... < cwd]
         while (true) {
+            signal?.throwIfAborted();
             source = ctx.external.get(dir);
             if (source !== undefined) {
                 // if cache is found populate descendants [cwd > ... > dir]
@@ -56,6 +57,7 @@ export async function resolveSources(options) {
     {
         let c = dirname(cwd);
         while (true) {
+            signal?.throwIfAborted();
             preCwdSegments.push(c);
             if (c === "/" || c === root)
                 break;
@@ -64,23 +66,26 @@ export async function resolveSources(options) {
         }
         preCwdSegments.reverse();
     }
-    source = await findSourceForAbsoluteDirs(preCwdSegments, ctx, fs, target);
+    source = await findSourceForAbsoluteDirs(preCwdSegments, ctx, fs, target, signal);
     if (typeof source === "object") {
         for (const noSourceDir of noSourceDirList) {
+            signal?.throwIfAborted();
             ctx.external.set(noSourceDir, source);
         }
     }
     const rels = noSourceDirList.map((rel) => resolve(cwd, rel).replaceAll("\\", "/").replace(/\w:/, ""));
-    source = await findSourceForAbsoluteDirs(rels, ctx, fs, target);
+    source = await findSourceForAbsoluteDirs(rels, ctx, fs, target, signal);
     if (source !== undefined) {
         for (const noSourceDir of noSourceDirList) {
+            signal?.throwIfAborted();
             ctx.external.set(noSourceDir, source);
         }
     }
 }
-async function findSourceForAbsoluteDirs(paths, ctx, fs, target) {
+async function findSourceForAbsoluteDirs(paths, ctx, fs, target, signal) {
     for (const parent of paths) {
         for (const extractor of target.extractors) {
+            signal?.throwIfAborted();
             const s = await tryExtractor(parent, fs, ctx, extractor);
             if (typeof s === "object" && s.error) {
                 ctx.failed.push(s);

package/out/walk.js

@@ -17,7 +17,7 @@ export async function walkIncludes(options) {
         const { depth, depthSlash } = getDepth(path, maxDepth);
         if (depth > maxDepth) {
             const failedPrev = ctx.failed.length;
-            let match = await target.ignores({ fs, cwd, entry: path, ctx });
+            let match = await target.ignores({ fs, cwd, entry: path, ctx, signal });
             if (invert) {
                 match.ignored = !match.ignored;
             }
@@ -45,7 +45,7 @@ export async function walkIncludes(options) {
         }
     }
     const failedPrev = ctx.failed.length;
-    let match = await target.ignores({ fs, cwd, entry: path, ctx });
+    let match = await target.ignores({ fs, cwd, entry: path, ctx, signal });
     if (invert) {
         match.ignored = !match.ignored;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "view-ignored",
-	"version": "0.7.0",
+	"version": "0.7.1",
 	"description": "Retrieve list of files ignored/included by Git, NPM, Yarn, JSR, VSCE or other tools.",
 	"keywords": [
 		".gitignore",