view-ignored 0.9.1 → 0.10.1

package/README.md

@@ -18,7 +18,9 @@ Node.js 18 or later
   readers, not command-line wrappers.
 - **Plugins.** Built-in [targets](#targets) for popular tools. Use custom
   targets by implementing/extending the `Target` interface.
-- **TypeScript.** Written in TypeScript with type definitions included.
+- **Streaming.** Native `scanStream` support for processing massive file trees with minimal memory overhead.
+- **Execution Control.** Use `fastDepth` and `fastInternal` options to fine-tune traversal depth and skip unnecessary directory checks.
+- **Abortable.** Full support for `AbortSignal` to cancel long-running scans instantly.
 - **Lightweight.** Minimal dependencies for fast performance and small bundle size.
 - **Easy-to-modify.** Well-written and MIT-licensed.
 - **Browser.** Can be bundled for browser use. See `ScanOptions.fs` and `import ... "view-ignored/browser"`.
@@ -56,9 +58,9 @@ if (match.kind === "external") {
 import {
 	type Extractor,
 	extractGitignore,
-	signedPatternIgnores,
-	signedPatternCompile,
-	type SignedPattern,
+	ruleTest,
+	ruleCompile,
+	type Rule,
 } from "view-ignored/patterns"
 
 import type { Target } from "view-ignored/targets"
@@ -74,24 +76,21 @@ const extractors: Extractor[] = [
 	},
 ]
 
-const internal: SignedPattern = {
-	exclude: [".git", ".DS_Store"],
-	include: [],
-	compiled: null,
-}
-
-signedPatternCompile(internal)
+const internal: Rule[] = [
+	ruleCompile({
+		excludes: true,
+		pattern: [".git", ".DS_Store"],
+		compiled: null,
+	}),
+]
 
 export const Git: Target = {
+	internalRules: internal,
 	extractors,
-	ignores(o) {
-		return signedPatternIgnores({
-			...o,
-			internal,
-			root: "/",
-			target: Git,
-		})
-	},
+	root: "/",
+	// TODO: Git should read configs
+	init() {},
+	ignores: ruleTest,
 }
 
 const ctx = await vign.scan({ target })

package/out/browser_scan.js

@@ -1,5 +1,5 @@
 import { opendir } from "./opendir.js";
-import { unixify, relative, join } from "./unixify.js";
+import { unixify, join } from "./unixify.js";
 import { walkIncludes } from "./walk.js";
 /**
  * Scan the directory for included files based on the provided targets.
@@ -41,13 +41,13 @@ export function scan(options) {
         target,
     };
     return (async () => {
-        await target.init?.({ ctx, cwd, fs, signal });
-        let from = join(unixify(normalCwd), within);
-        await opendir(fs, from, (entry) => {
-            const path = relative(normalCwd, unixify(entry.parentPath) + "/" + entry.name);
+        await target.init?.({ ctx, cwd, fs, signal, target });
+        let from = join(normalCwd, within);
+        await opendir({ ctx, cwd: normalCwd, fs, signal, target }, from, (entry, parentPath, path) => {
             return walkIncludes({
                 path,
                 entry,
+                parentPath,
                 ctx,
                 stream: undefined,
                 scanOptions,

package/out/opendir.d.ts

@@ -1,3 +1,3 @@
-import type { Dirent, PathLike } from "node:fs";
-import type { FsAdapter } from "./types.js";
-export declare function opendir(fs: FsAdapter, path: PathLike, cb: (entry: Dirent) => Promise<0 | 1 | 2>): Promise<void | 2>;
+import type { Dirent } from "node:fs";
+import type { PatternFinderOptions } from "./patterns/extractor.js";
+export declare function opendir(options: PatternFinderOptions, place: string, cb: (dirent: Dirent, parentPath: string, path: string) => Promise<0 | 1 | 2>): Promise<boolean>;

package/out/opendir.js

@@ -1,18 +1,28 @@
-export async function opendir(fs, path, cb) {
-    const dir = await fs.promises.opendir(path);
+import { resolveSources } from "./patterns/resolveSources.js";
+export async function opendir(options, place, cb) {
+    const { ctx, cwd, fs, signal, target } = options;
+    const dir = await fs.promises.opendir(place);
+    const tasks = [];
+    const normalParentPath = place;
+    const substr = normalParentPath.substring(cwd.length + 1);
+    const isRootDir = normalParentPath.length === cwd.length;
+    const parentPath = isRootDir ? "." : substr;
+    await resolveSources({ ctx, cwd, fs, signal, target, dir: parentPath });
+    let stop = false;
     for await (const entry of dir) {
-        const r = await cb(entry);
-        if (r === 2) {
-            return 2;
-        }
-        if (r === 1) {
-            continue;
-        }
-        if (entry.isDirectory()) {
-            const r = await opendir(fs, path + "/" + entry.name, cb);
-            if (r === 2) {
-                return 2;
+        const from = place + "/" + entry.name;
+        const path = isRootDir ? entry.name : substr + "/" + entry.name;
+        const task = (async () => {
+            const r = await cb(entry, parentPath, path);
+            if (r === 1)
+                return;
+            if (r === 2 || (entry.isDirectory() && (await opendir(options, from, cb)))) {
+                stop = true;
+                return;
             }
-        }
+        })();
+        tasks.push(task);
     }
+    await Promise.all(tasks);
+    return stop;
 }

package/out/patterns/extractor.d.ts

@@ -41,7 +41,7 @@ export interface Extractor {
  * Options for finding and extracting patterns from source files.
  *
  * @see {@link resolveSources}
- * @see {@link signedPatternIgnores}
+ * @see {@link ruleTest}
  *
  * @since 0.6.0
  */
@@ -70,13 +70,6 @@ export interface PatternFinderOptions {
      * @since 0.6.0
      */
     target: Target;
-    /**
-     * Initial search directory.
-     * Relative to the `cwd` path or absolute path.
-     *
-     * @since 0.6.0
-     */
-    root: string;
     /**
      * Return as soon as possible.
      *

package/out/patterns/gitignore.d.ts

@@ -2,7 +2,7 @@ import { type Source } from "./source.js";
 /**
  * Extracts and compiles patterns from the file.
  *
- * @see {@link signedPatternCompile}
+ * @see {@link ruleCompile}
  *
  * @since 0.6.0
  */
@@ -10,8 +10,8 @@ export declare function extractGitignore(source: Source, content: Buffer): void;
 /**
  * Extracts and compiles patterns from the file.
  *
- * @see {@link signedPatternCompile}
+ * @see {@link ruleCompile}
  *
- * @since 0.6.0
+ * @since 0.8.0
  */
 export declare function extractGitignoreNocase(source: Source, content: Buffer): void;

package/out/patterns/gitignore.js

@@ -1,29 +1,29 @@
-import { signedPatternCompile } from "./resolveSources.js";
-import { sourcePushNegatable } from "./source.js";
+import { ruleCompile } from "./resolveSources.js";
+import { resolveNegatable } from "./source.js";
 /**
  * Extracts and compiles patterns from the file.
  *
- * @see {@link signedPatternCompile}
+ * @see {@link ruleCompile}
  *
  * @since 0.6.0
  */
 export function extractGitignore(source, content) {
     extract(source, content);
     for (const element of source.pattern) {
-        signedPatternCompile(element);
+        ruleCompile(element);
     }
 }
 /**
  * Extracts and compiles patterns from the file.
  *
- * @see {@link signedPatternCompile}
+ * @see {@link ruleCompile}
  *
- * @since 0.6.0
+ * @since 0.8.0
  */
 export function extractGitignoreNocase(source, content) {
     extract(source, content);
     for (const element of source.pattern) {
-        signedPatternCompile(element, { nocase: true });
+        ruleCompile(element, { nocase: true });
     }
 }
 extractGitignore;
@@ -39,7 +39,7 @@ function extract(source, content) {
         if (cdx >= 0) {
             line = line.substring(-cdx);
         }
-        sourcePushNegatable(line, false, include, exclude);
+        resolveNegatable(line, false, include, exclude);
     }
     source.pattern.push(include, exclude);
 }

package/out/patterns/ignores.d.ts

@@ -1,5 +1,5 @@
-import type { SignedPatternMatch } from "../patterns/signedPattern.js";
 import type { InitState } from "./initState.js";
+import type { RuleMatch } from "./rule.js";
 /**
  * Used in {@link Ignores}.
  *
@@ -12,14 +12,20 @@ export interface IgnoresOptions extends InitState {
      * @since 0.6.0
      */
     entry: string;
+    /**
+     * Result of the `dirname(entry)` call.
+     *
+     * @since 0.10.1
+     */
+    parentPath: string;
 }
 /**
  * Checks whether a given entry path should be ignored based on its patterns.
  *
  * @see {@link resolveSources}
- * @see {@link signedPatternIgnores}
+ * @see {@link ruleTest}
  * @see {@link https://github.com/Mopsgamer/view-ignored/tree/main/src/targets} for usage examples.
  *
  * @since 0.6.0
  */
-export type Ignores = (options: IgnoresOptions) => Promise<SignedPatternMatch>;
+export type Ignores = (options: IgnoresOptions) => Promise<RuleMatch>;

package/out/patterns/index.d.ts

@@ -8,8 +8,8 @@ export * from "./matcherContext.js";
 export * from "./matcherContextPatch.js";
 export * from "./matcherStream.js";
 export * from "./packagejson.js";
-export * from "./pattern.js";
+export * from "./patternList.js";
 export * from "./resolveSources.js";
-export * from "./signedPattern.js";
+export * from "./rule.js";
 export * from "./source.js";
-export * from "./stringCompile.js";
+export * from "./patternCompile.js";

package/out/patterns/index.js

@@ -8,8 +8,8 @@ export * from "./matcherContext.js";
 export * from "./matcherContextPatch.js";
 export * from "./matcherStream.js";
 export * from "./packagejson.js";
-export * from "./pattern.js";
+export * from "./patternList.js";
 export * from "./resolveSources.js";
-export * from "./signedPattern.js";
+export * from "./rule.js";
 export * from "./source.js";
-export * from "./stringCompile.js";
+export * from "./patternCompile.js";

package/out/patterns/initState.d.ts

@@ -1,3 +1,4 @@
+import type { Target } from "../targets/target.js";
 import type { FsAdapter } from "../types.js";
 import type { MatcherContext } from "./matcherContext.js";
 /**
@@ -22,6 +23,12 @@ export interface InitState {
      * @since 0.6.0
      */
     ctx: MatcherContext;
+    /**
+     * The target implementation.
+     *
+     * @since 0.10.0
+     */
+    target: Target;
     /**
      * Return as soon as possible.
      *

package/out/patterns/jsrjson.d.ts

@@ -9,7 +9,7 @@ export declare function extractJsrJson(source: Source, content: Buffer, ctx: Mat
 /**
  * Extracts and compiles patterns from the file.
  *
- * @see {@link signedPatternCompile}
+ * @see {@link ruleCompile}
  *
  * @since 0.6.0
  */

package/out/patterns/jsrjson.js

@@ -1,7 +1,7 @@
 import { type } from "arktype";
 import stripJsonComments from "strip-json-comments";
-import { signedPatternCompile } from "./resolveSources.js";
-import { sourcePushNegatable } from "./source.js";
+import { ruleCompile } from "./resolveSources.js";
+import { resolveNegatable } from "./source.js";
 const jsrManifest = type({
     exclude: "string[]?",
     include: "string[]?",
@@ -21,14 +21,14 @@ const parse = type("string")
 export function extractJsrJson(source, content, ctx) {
     extract(source, content, ctx);
     for (const element of source.pattern) {
-        signedPatternCompile(element);
+        ruleCompile(element);
     }
 }
 extractJsrJson;
 /**
  * Extracts and compiles patterns from the file.
  *
- * @see {@link signedPatternCompile}
+ * @see {@link ruleCompile}
  *
  * @since 0.6.0
  */
@@ -63,7 +63,7 @@ function extract(source, content, ctx) {
     }
     for (const si of [include, exclude]) {
         for (const pattern of si.pattern) {
-            sourcePushNegatable(pattern, true, include, exclude);
+            resolveNegatable(pattern, true, include, exclude);
         }
     }
     source.pattern.push(include, exclude);

package/out/patterns/matcherContext.d.ts

@@ -1,4 +1,4 @@
-import type { SignedPatternMatch } from "./signedPattern.js";
+import type { RuleMatch } from "./rule.js";
 import type { Source } from "./source.js";
 /**
  * Post-scan results.
@@ -12,7 +12,7 @@ export interface MatcherContext {
      *
      * @since 0.6.0
      */
-    paths: Map<string, SignedPatternMatch>;
+    paths: Map<string, RuleMatch>;
     /**
      * Maps directory paths to their corresponding sources.
      *

package/out/patterns/matcherContextPatch.js

@@ -1,8 +1,9 @@
-import { resolve, dirname } from "node:path";
+import { dirname } from "node:path";
 import { getDepth } from "../getDepth.js";
 import { opendir } from "../opendir.js";
-import { unixify, relative } from "../unixify.js";
+import { unixify, join } from "../unixify.js";
 import { walkIncludes } from "../walk.js";
+import { resolveSources } from "./resolveSources.js";
 /**
  * Provides patching abilities for the given {@link MatcherContext}.
  * Directories should have the slash suffix.
@@ -21,28 +22,29 @@ export async function matcherContextAddPath(ctx, options, entry) {
         if (direntPath === ".") {
             return true;
         }
-        ctx.paths.set(entry, await target.ignores({ fs, cwd, entry: direntPath, ctx, signal }));
+        const parentPath = dirname(direntPath);
+        await resolveSources({ ctx, cwd, dir: direntPath, fs, signal, target });
+        ctx.paths.set(entry, await target.ignores({ fs, cwd, entry: direntPath, ctx, signal, target, parentPath }));
         if (ctx.totalFiles >= 0) {
             ctx.totalDirs++;
         }
-        const parent = dirname(direntPath);
-        if (parent !== ".") {
-            void (await matcherContextAddPath(ctx, options, parent + "/"));
+        if (parentPath !== ".") {
+            void (await matcherContextAddPath(ctx, options, parentPath + "/"));
         }
         return true;
     }
-    const parent = dirname(entry);
+    const parentPath = dirname(entry);
     const isSource = target.extractors.some((e) => e.path === entry);
     if (isSource) {
         // add pattern sources
-        await matcherContextRemovePath(ctx, options, parent + "/");
-        await rescan(ctx, { ...options, within: parent });
+        await matcherContextRemovePath(ctx, options, parentPath + "/");
+        await rescan(ctx, { ...options, within: parentPath });
     }
     // add paths
     // 1. recursively populate parents
-    await matcherContextAddPath(ctx, options, parent + "/");
+    await matcherContextAddPath(ctx, options, parentPath + "/");
     // 2. if ignored, remove, otherwise add
-    const match = await target.ignores({ fs, cwd, entry, ctx, signal });
+    const match = await target.ignores({ fs, cwd, entry, ctx, signal, target, parentPath });
     if (match.ignored) {
         // 2.1. remove
         await matcherContextRemovePath(ctx, options, entry);
@@ -140,11 +142,13 @@ export async function matcherContextRemovePath(ctx, options, entry) {
     return true;
 }
 async function rescan(ctx, options) {
-    const normalCwd = unixify(options.cwd);
-    await opendir(options.fs, resolve(normalCwd, options.within), (entry) => {
-        const path = relative(normalCwd, unixify(entry.parentPath) + "/" + entry.name);
+    const { cwd, within, fs, signal, target } = options;
+    const normalCwd = unixify(cwd);
+    let from = join(normalCwd, within);
+    await opendir({ ctx, cwd: normalCwd, fs, signal, target }, from, (entry, parentPath, path) => {
         return walkIncludes({
             path,
+            parentPath,
             entry,
             ctx,
             stream: undefined,

package/out/patterns/matcherStream.d.ts

@@ -2,7 +2,7 @@ import type { Dirent } from "node:fs";
 import { EventEmitter } from "node:events";
 import type { MatcherContext } from "../patterns/matcherContext.js";
 import type { ScanOptions, FsAdapter } from "../types.js";
-import type { SignedPatternMatch } from "./signedPattern.js";
+import type { RuleMatch } from "./rule.js";
 /**
  * Post-scan entry information.
  *
@@ -26,7 +26,7 @@ export type EntryInfo = {
      *
      * @since 0.6.0
      */
-    match: SignedPatternMatch;
+    match: RuleMatch;
     /**
      * The matcher context.
      *

package/out/patterns/matcherStream.js

@@ -1,6 +1,6 @@
 import { EventEmitter } from "node:events";
 import { opendir } from "../opendir.js";
-import { join, relative, unixify } from "../unixify.js";
+import { join, unixify } from "../unixify.js";
 import { walkIncludes } from "../walk.js";
 /**
  * Event emitter.
@@ -49,12 +49,12 @@ export class MatcherStream extends EventEmitter {
             signal,
             target,
         };
-        await target.init?.({ ctx, cwd, fs, signal });
-        let from = join(unixify(normalCwd), within);
-        await opendir(fs, from, (entry) => {
-            const path = relative(normalCwd, unixify(entry.parentPath) + "/" + entry.name);
+        await target.init?.({ ctx, cwd, fs, signal, target });
+        let from = join(normalCwd, within);
+        await opendir({ ctx, cwd: normalCwd, fs, signal, target }, from, (entry, parentPath, path) => {
             return walkIncludes({
                 path,
+                parentPath,
                 entry,
                 ctx,
                 stream: this,

package/out/patterns/packagejson.d.ts

@@ -2,7 +2,7 @@ import { type Source } from "./source.js";
 /**
  * Extracts and compiles patterns from the file.
  *
- * @see {@link signedPatternCompile}
+ * @see {@link ruleCompile}
  *
  * @since 0.6.0
  */
@@ -10,7 +10,7 @@ export declare function extractPackageJson(source: Source, content: Buffer): voi
 /**
  * Extracts and compiles patterns from the file.
  *
- * @see {@link signedPatternCompile}
+ * @see {@link ruleCompile}
  *
  * @since 0.8.0
  */

package/out/patterns/packagejson.js

@@ -1,11 +1,11 @@
 import { type } from "arktype";
 import { npmManifestParse } from "../targets/npmManifest.js";
-import { signedPatternCompile } from "./resolveSources.js";
-import { sourcePushNegatable } from "./source.js";
+import { ruleCompile } from "./resolveSources.js";
+import { resolveNegatable } from "./source.js";
 /**
  * Extracts and compiles patterns from the file.
  *
- * @see {@link signedPatternCompile}
+ * @see {@link ruleCompile}
  *
  * @since 0.6.0
  */
@@ -13,7 +13,7 @@ export function extractPackageJson(source, content) {
     const result = extract(source, content);
     if (result === undefined) {
         for (const element of source.pattern) {
-            signedPatternCompile(element);
+            ruleCompile(element);
         }
     }
     if (result === "error")
@@ -23,7 +23,7 @@ export function extractPackageJson(source, content) {
 /**
  * Extracts and compiles patterns from the file.
  *
- * @see {@link signedPatternCompile}
+ * @see {@link ruleCompile}
  *
  * @since 0.8.0
  */
@@ -31,7 +31,7 @@ export function extractPackageJsonNocase(source, content) {
     const result = extract(source, content);
     if (result === undefined) {
         for (const element of source.pattern) {
-            signedPatternCompile(element, { nocase: true });
+            ruleCompile(element, { nocase: true });
         }
     }
     if (result === "error")
@@ -51,7 +51,7 @@ function extract(source, content) {
         return "none";
     }
     for (const pattern of dist.files) {
-        sourcePushNegatable(pattern, true, include, exclude);
+        resolveNegatable(pattern, true, include, exclude);
     }
     source.pattern.push(include, exclude);
 }

package/out/patterns/patternCompile.d.ts

@@ -0,0 +1,22 @@
+import type { PatternCache, PatternList } from "./patternList.js";
+/**
+ * @since 0.8.0
+ */
+export type PatternCompileOptions = {
+    /**
+     * Disables case sensitivity.
+     *
+     * @default false
+     *
+     * @since 0.8.0
+     */
+    nocase?: boolean;
+};
+/**
+ * Compiles a string of the {@link PatternList}.
+ *
+ * @see {@link patternCompile}
+ *
+ * @since 0.8.0
+ */
+export declare function patternCompile(pattern: string, context?: PatternList, options?: PatternCompileOptions): PatternCache;

package/out/patterns/patternCompile.js

@@ -0,0 +1,62 @@
+import glob from "micromatch";
+/**
+ * Compiles a string of the {@link PatternList}.
+ *
+ * @see {@link patternCompile}
+ *
+ * @since 0.8.0
+ */
+export function patternCompile(pattern, context = [], options) {
+    const original = pattern;
+    const isRoot = pattern.startsWith("/");
+    const nocase = !!options?.nocase;
+    let cleaned = pattern;
+    if (cleaned.endsWith("/"))
+        cleaned = cleaned.slice(0, -1);
+    if (isRoot)
+        cleaned = cleaned.slice(1);
+    const lowerCleaned = nocase ? cleaned.toLowerCase() : cleaned;
+    const prefix = lowerCleaned + "/";
+    const hasGlob = cleaned.includes("*");
+    const matchBase = !isRoot && !cleaned.includes("/");
+    const matcherOpts = {
+        dot: true,
+        nonegate: true,
+        nocomment: true,
+        nobrace: true,
+        nocase,
+        matchBase,
+        optimizationLevel: 2,
+    };
+    const re = {
+        test(str) {
+            const lowerStr = nocase ? str.toLowerCase() : str;
+            if (lowerStr === lowerCleaned || lowerStr.startsWith(prefix)) {
+                return true;
+            }
+            if (matchBase) {
+                if (str.includes(cleaned)) {
+                    const segments = str.split("/");
+                    for (const seg of segments) {
+                        if (seg === lowerCleaned)
+                            return true;
+                    }
+                }
+            }
+            if (hasGlob) {
+                if (glob.isMatch(str, cleaned, matcherOpts))
+                    return true;
+                // Check parents only if there's a glob
+                let lastSlash = str.lastIndexOf("/");
+                while (lastSlash !== -1) {
+                    const parent = str.substring(0, lastSlash);
+                    if (glob.isMatch(parent, cleaned, matcherOpts))
+                        return true;
+                    lastSlash = str.lastIndexOf("/", lastSlash - 1);
+                }
+            }
+            return false;
+        },
+    };
+    return { re, pattern: original, patternContext: context };
+}