view-ignored 0.5.2 → 0.7.0

package/out/stream.d.ts

@@ -0,0 +1,9 @@
+import type { MatcherStream } from "./patterns/matcherStream.js";
+import type { ScanOptions } from "./types.js";
+export type * from "./types.js";
+/**
+ * @see {@link scan}
+ *
+ * @since 0.6.0
+ */
+export declare function scanStream(options: ScanOptions): MatcherStream;

package/out/stream.js

@@ -0,0 +1,12 @@
+import * as nodefs from "node:fs";
+import * as process from "node:process";
+import { scanStream as browserStream } from "./browser_stream.js";
+/**
+ * @see {@link scan}
+ *
+ * @since 0.6.0
+ */
+export function scanStream(options) {
+    const { cwd = process.cwd(), fs = nodefs } = options;
+    return browserStream({ fs, cwd, ...options });
+}

package/out/targets/git.d.ts

@@ -1,2 +1,5 @@
-import type { Target } from './target.js';
+import type { Target } from "./target.js";
+/**
+ * @since 0.6.0
+ */
 export declare const Git: Target;

package/out/targets/git.js

@@ -1,22 +1,31 @@
-import { signedPatternIgnores, findAndExtract } from '../patterns/matcher.js';
-import { extractGitignore } from '../patterns/gitignore.js';
-const gitSources = ['.gitignore'];
-const gitSourceMap = new Map([
-    ['.gitignore', extractGitignore],
-]);
-const gitPattern = {
-    exclude: [
-        '.git',
-        '.DS_Store',
-    ],
+import { extractGitignore, signedPatternIgnores, signedPatternCompile, } from "../patterns/index.js";
+const extractors = [
+    {
+        extract: extractGitignore,
+        path: ".gitignore",
+    },
+    {
+        extract: extractGitignore,
+        path: ".git/info/exclude",
+    },
+];
+const internal = {
+    exclude: [".git", ".DS_Store"],
     include: [],
+    compiled: null,
 };
+signedPatternCompile(internal);
+/**
+ * @since 0.6.0
+ */
 export const Git = {
-    async matcher(entry, isDir, ctx) {
-        if (isDir) {
-            await findAndExtract(entry, gitSources, gitSourceMap, ctx);
-            return true;
-        }
-        return await signedPatternIgnores(gitPattern, entry, gitSources, gitSourceMap, ctx);
+    extractors,
+    ignores(o) {
+        return signedPatternIgnores({
+            ...o,
+            internal,
+            root: "/",
+            target: Git,
+        });
     },
 };

package/out/targets/index.d.ts

@@ -1,6 +1,6 @@
-export * from './git.js';
-export * from './jsr.js';
-export * from './npm.js';
-export * from './target.js';
-export * from './vsce.js';
-export * from './yarn.js';
+export * from "./git.js";
+export * from "./jsr.js";
+export * from "./npm.js";
+export * from "./target.js";
+export * from "./vsce.js";
+export * from "./yarn.js";

package/out/targets/index.js

@@ -1,6 +1,6 @@
-export * from './git.js';
-export * from './jsr.js';
-export * from './npm.js';
-export * from './target.js';
-export * from './vsce.js';
-export * from './yarn.js';
+export * from "./git.js";
+export * from "./jsr.js";
+export * from "./npm.js";
+export * from "./target.js";
+export * from "./vsce.js";
+export * from "./yarn.js";

package/out/targets/jsr.d.ts

@@ -1,2 +1,5 @@
-import type { Target } from './target.js';
+import type { Target } from "./target.js";
+/**
+ * @since 0.6.0
+ */
 export declare const JSR: Target;

package/out/targets/jsr.js

@@ -1,25 +1,39 @@
-import { signedPatternIgnores, findAndExtract } from '../patterns/matcher.js';
-import { extractJsrJson, extractJsrJsonc } from '../patterns/jsrjson.js';
-const jsrSources = ['deno.json', 'deno.jsonc', 'jsr.json', 'jsr.jsonc'];
-const jsrSourceMap = new Map([
-    ['deno.json', extractJsrJson],
-    ['deno.jsonc', extractJsrJsonc],
-    ['jsr.json', extractJsrJson],
-    ['jsr.jsonc', extractJsrJsonc],
-]);
-const vscePattern = {
-    exclude: [
-        '.git',
-        '.DS_Store',
-    ],
+import { signedPatternIgnores, signedPatternCompile, extractJsrJson, extractJsrJsonc, } from "../patterns/index.js";
+const extractors = [
+    {
+        extract: extractJsrJson,
+        path: "deno.json",
+    },
+    {
+        extract: extractJsrJsonc,
+        path: "deno.jsonc",
+    },
+    {
+        extract: extractJsrJson,
+        path: "jsr.json",
+    },
+    {
+        extract: extractJsrJsonc,
+        path: "jsr.jsonc",
+    },
+];
+const internal = {
+    exclude: [".git", ".DS_Store"],
     include: [],
+    compiled: null,
 };
+signedPatternCompile(internal);
+/**
+ * @since 0.6.0
+ */
 export const JSR = {
-    async matcher(entry, isDir, ctx) {
-        if (isDir) {
-            await findAndExtract(entry, jsrSources, jsrSourceMap, ctx);
-            return true;
-        }
-        return await signedPatternIgnores(vscePattern, entry, jsrSources, jsrSourceMap, ctx);
+    extractors,
+    ignores(o) {
+        return signedPatternIgnores({
+            ...o,
+            internal,
+            root: ".",
+            target: JSR,
+        });
     },
 };

package/out/targets/npm.d.ts

@@ -1,2 +1,5 @@
-import type { Target } from './target.js';
+import type { Target } from "./target.js";
+/**
+ * @since 0.6.0
+ */
 export declare const NPM: Target;

package/out/targets/npm.js

@@ -1,46 +1,53 @@
-import { signedPatternIgnores, findAndExtract } from '../patterns/matcher.js';
-import { extractGitignore } from '../patterns/gitignore.js';
-import { extractPackageJson } from '../patterns/packagejson.js';
-const npmSources = ['package.json', '.npmignore', '.gitignore'];
-const npmSourceMap = new Map([
-    ['package.json', extractPackageJson],
-    ['.npmignore', extractGitignore],
-    ['.gitignore', extractGitignore],
-]);
-const npmPattern = {
+import { signedPatternIgnores, signedPatternCompile, extractPackageJson, extractGitignore, } from "../patterns/index.js";
+const extractors = [
+    {
+        extract: extractPackageJson,
+        path: "package.json",
+    },
+    {
+        extract: extractGitignore,
+        path: ".npmignore",
+    },
+    {
+        extract: extractGitignore,
+        path: ".gitignore",
+    },
+];
+const internal = {
     exclude: [
-        '.git',
-        '.DS_Store',
-        'node_modules',
-        '.*.swp',
-        '._*',
-        '.DS_Store',
-        '.git',
-        '.gitignore',
-        '.hg',
-        '.npmignore',
-        '.npmrc',
-        '.lock-wscript',
-        '.svn',
-        '.wafpickle-*',
-        'config.gypi',
-        'CVS',
-        'npm-debug.log',
-    ],
-    include: [
-        'bin',
-        'package.json',
-        'README*',
-        'LICENSE*',
-        'LICENCE*',
+        ".git",
+        ".DS_Store",
+        "node_modules",
+        ".*.swp",
+        "._*",
+        ".DS_Store",
+        ".git",
+        ".gitignore",
+        ".hg",
+        ".npmignore",
+        ".npmrc",
+        ".lock-wscript",
+        ".svn",
+        ".wafpickle-*",
+        "config.gypi",
+        "CVS",
+        "npm-debug.log",
     ],
+    include: ["bin", "package.json", "README*", "LICENSE*", "LICENCE*"],
+    compiled: null,
 };
+signedPatternCompile(internal);
+/**
+ * @since 0.6.0
+ */
 export const NPM = {
-    async matcher(entry, isDir, ctx) {
-        if (isDir) {
-            await findAndExtract(entry, npmSources, npmSourceMap, ctx);
-            return true;
-        }
-        return await signedPatternIgnores(npmPattern, entry, npmSources, npmSourceMap, ctx);
+    extractors,
+    ignores(o) {
+        return signedPatternIgnores({
+            ...o,
+            internal,
+            root: ".",
+            target: NPM,
+        });
     },
 };

package/out/targets/target.d.ts

@@ -1,10 +1,24 @@
-import type { PathChecker } from '../patterns/matcher.js';
+import type { Extractor } from "../patterns/extractor.js";
+import type { Ignores } from "../patterns/ignores.js";
 /**
- * Contains the matcher used for target scanning.
+ * Contains the matcher used for scanning.
+ *
+ * @since 0.6.0
  */
 export interface Target {
+    /**
+     * The set of extractors.
+     * Required for context-patching APIs (ctx add/remove path).
+     *
+     * @since 0.6.0
+     */
+    extractors: Extractor[];
     /**
      * Glob-pattern parser.
+     *
+     * @see {@link Ignores}
+     *
+     * @since 0.6.0
      */
-    matcher: PathChecker;
+    ignores: Ignores;
 }

package/out/targets/vsce.d.ts

@@ -1,2 +1,5 @@
-import type { Target } from './target.js';
+import type { Target } from "./target.js";
+/**
+ * @since 0.6.0
+ */
 export declare const VSCE: Target;

package/out/targets/vsce.js

@@ -1,24 +1,35 @@
-import { signedPatternIgnores, findAndExtract } from '../patterns/matcher.js';
-import { extractGitignore } from '../patterns/gitignore.js';
-import { extractPackageJson } from '../patterns/packagejson.js';
-const vsceSources = ['package.json', '.vscodeignore'];
-const vsceSourceMap = new Map([
-    ['package.json', extractPackageJson],
-    ['.vscodeignore', extractGitignore],
-]);
-const vscePattern = {
-    exclude: [
-        '.git',
-        '.DS_Store',
-    ],
+import { signedPatternIgnores, signedPatternCompile, extractPackageJson, extractGitignore, } from "../patterns/index.js";
+const extractors = [
+    {
+        extract: extractPackageJson,
+        path: "package.json",
+    },
+    {
+        extract: extractGitignore,
+        path: ".vscodeignore",
+    },
+    {
+        extract: extractGitignore,
+        path: ".gitignore",
+    },
+];
+const internal = {
+    exclude: [".git", ".DS_Store"],
     include: [],
+    compiled: null,
 };
+signedPatternCompile(internal);
+/**
+ * @since 0.6.0
+ */
 export const VSCE = {
-    async matcher(entry, isDir, ctx) {
-        if (isDir) {
-            await findAndExtract(entry, vsceSources, vsceSourceMap, ctx);
-            return true;
-        }
-        return await signedPatternIgnores(vscePattern, entry, vsceSources, vsceSourceMap, ctx);
+    extractors,
+    ignores(o) {
+        return signedPatternIgnores({
+            ...o,
+            internal,
+            root: ".",
+            target: VSCE,
+        });
     },
 };

package/out/targets/yarn.d.ts

@@ -1,2 +1,5 @@
-import type { Target } from './target.js';
+import type { Target } from "./target.js";
+/**
+ * @since 0.6.0
+ */
 export declare const Yarn: Target;

package/out/targets/yarn.js

@@ -1,49 +1,59 @@
-import { signedPatternIgnores, findAndExtract } from '../patterns/matcher.js';
-import { extractGitignore } from '../patterns/gitignore.js';
-import { extractPackageJson } from '../patterns/packagejson.js';
-const yarnSources = ['package.json', '.yarnignore', '.npmignore', '.gitignore'];
-const yarnSourceMap = new Map([
-    ['package.json', extractPackageJson],
-    ['.yarnignore', extractGitignore],
-    ['.npmignore', extractGitignore],
-    ['.gitignore', extractGitignore],
-]);
-const yarnPattern = {
+import { signedPatternIgnores, signedPatternCompile, extractPackageJson, extractGitignore, } from "../patterns/index.js";
+const extractors = [
+    {
+        extract: extractPackageJson,
+        path: "package.json",
+    },
+    {
+        extract: extractGitignore,
+        path: ".yarnignore",
+    },
+    {
+        extract: extractGitignore,
+        path: ".npmignore",
+    },
+    {
+        extract: extractGitignore,
+        path: ".gitignore",
+    },
+];
+const internal = {
     exclude: [
-        '.git',
-        '.DS_Store',
-        'node_modules',
-        '.*.swp',
-        '._*',
-        '.DS_Store',
-        '.git',
-        '.gitignore',
-        '.hg',
-        '.npmignore',
-        '.npmrc',
-        '.lock-wscript',
-        '.svn',
-        '.wafpickle-*',
-        'config.gypi',
-        'CVS',
-        'npm-debug.log',
-        '.yarnignore',
-        '.yarnrc',
-    ],
-    include: [
-        'bin',
-        'package.json',
-        'README*',
-        'LICENSE*',
-        'LICENCE*',
+        ".git",
+        ".DS_Store",
+        "node_modules",
+        ".*.swp",
+        "._*",
+        ".DS_Store",
+        ".git",
+        ".gitignore",
+        ".hg",
+        ".npmignore",
+        ".npmrc",
+        ".lock-wscript",
+        ".svn",
+        ".wafpickle-*",
+        "config.gypi",
+        "CVS",
+        "npm-debug.log",
+        ".yarnignore",
+        ".yarnrc",
     ],
+    include: ["bin", "package.json", "README*", "LICENSE*", "LICENCE*"],
+    compiled: null,
 };
+signedPatternCompile(internal);
+/**
+ * @since 0.6.0
+ */
 export const Yarn = {
-    async matcher(entry, isDir, ctx) {
-        if (isDir) {
-            await findAndExtract(entry, yarnSources, yarnSourceMap, ctx);
-            return true;
-        }
-        return await signedPatternIgnores(yarnPattern, entry, yarnSources, yarnSourceMap, ctx);
+    extractors,
+    ignores(o) {
+        return signedPatternIgnores({
+            ...o,
+            internal,
+            root: ".",
+            target: Yarn,
+        });
     },
 };

package/out/types.d.ts

@@ -0,0 +1,116 @@
+import type * as fs from "node:fs";
+import type { Target } from "./targets/target.js";
+/**
+ * Minimal FS implementation needed for `scan`, `scanStream`, and their browser versions.
+ *
+ * @since 0.6.0
+ */
+export interface FsAdapter {
+    promises: {
+        opendir: typeof fs.promises.opendir;
+        readFile: typeof fs.promises.readFile;
+    };
+}
+/**
+ * Used in multiple methods, primarily `scan`, `scanStream`, and their browser versions.
+ *
+ * @since 0.6.0
+ */
+export type ScanOptions = {
+    /**
+     * Provides the matcher to use for scanning.
+     *
+     * @since 0.6.0
+     */
+    target: Target;
+    /**
+     * Current working directory to start the scan from.
+     *
+     * @default `normalizeCwd(process.cwd())`
+     *
+     * @since 0.6.0
+     */
+    cwd?: string;
+    /**
+     * Limits the scan to a subdirectory of `cwd`.
+     * Traversal starts from this subdirectory, but returned paths
+     * remain relative to `cwd`, and ignore files from `cwd`
+     * are still applied.
+     *
+     * @default `"."`
+     *
+     * @since 0.6.0
+     */
+    within?: string;
+    /**
+     * If enabled, the scan will return files that are ignored by the target matcher.
+     *
+     * @default `false`
+     *
+     * @since 0.6.0
+     */
+    invert?: boolean;
+    /**
+     * Starting from depth `0` means you will see
+     * children of the current working directory.
+     *
+     * @default `Infinity`
+     *
+     * @since 0.6.0
+     */
+    depth?: number;
+    /**
+     * Return as soon as possible.
+     *
+     * @default `undefined`
+     *
+     * @since 0.6.0
+     */
+    signal?: AbortSignal | null;
+    /**
+     * Works together with {@link ScanOptions.depth}.
+     * If enabled, directories will be processed faster
+     * by skipping files after first match.
+     *
+     * This makes the scan faster but affects
+     * {@link MatcherContext.totalDirs},
+     * {@link MatcherContext.totalFiles},
+     * {@link MatcherContext.totalMatchedFiles}
+     * and {@link MatcherContext.depthPaths}.
+     *
+     * It's recommended to use this option unless you
+     * need precise statistics
+     *
+     * @default `false`
+     *
+     * @since 0.6.0
+     */
+    fastDepth?: boolean;
+    /**
+     * Enables skipping entire directories for internal matches.
+     * For example, when scanning a Git repository,
+     * '.git' directory will be skipped without reading its contents.
+     *
+     * This makes the scan faster but affects
+     * {@link MatcherContext.totalDirs},
+     * {@link MatcherContext.totalFiles},
+     * and {@link MatcherContext.depthPaths}.
+     *
+     * It's recommended to use this option unless the target
+     * allows overriding internal patterns.
+     * This option should never affect {@link MatcherContext.totalMatchedFiles}.
+     *
+     * @default `false`
+     *
+     * @since 0.6.0
+     */
+    fastInternal?: boolean;
+    /**
+     * File system interface.
+     *
+     * @default `await import("node:fs")`
+     *
+     * @since 0.6.0
+     */
+    fs?: FsAdapter;
+};

package/out/types.js

@@ -0,0 +1 @@
+export {};

package/out/walk.d.ts

@@ -1,2 +1,12 @@
-import type { Dirent, PathLike } from 'node:fs';
-export declare function opendir(path: PathLike, cb: (entry: Dirent) => Promise<0 | 1 | 2>): Promise<void | 2>;
+import type { Dirent } from "node:fs";
+import type { MatcherContext } from "./patterns/matcherContext.js";
+import type { MatcherStream } from "./patterns/matcherStream.js";
+import type { ScanOptions } from "./types.js";
+export type WalkOptions = {
+    path: string;
+    entry: Dirent;
+    ctx: MatcherContext;
+    stream: MatcherStream | undefined;
+    scanOptions: Required<ScanOptions>;
+};
+export declare function walkIncludes(options: WalkOptions): Promise<0 | 1 | 2>;