view-ignored 0.5.1 → 0.6.0

package/out/walk.js

@@ -1,19 +1,107 @@
-import * as fsp from 'node:fs/promises';
-export async function opendir(path, cb) {
-    const dir = await fsp.opendir(path);
-    for await (const entry of dir) {
-        const r = await cb(entry);
-        if (r === 2) {
-            return 2;
+import { relative } from "node:path/posix";
+import { getDepth } from "./getDepth.js";
+import { normalizeCwd } from "./normalizeCwd.js";
+export async function walkIncludes(options) {
+    const { entry, ctx, stream, scanOptions } = options;
+    const { fs, target, cwd, depth: maxDepth, invert, signal, fastDepth, fastInternal } = scanOptions;
+    signal?.throwIfAborted();
+    const path = relative(cwd, normalizeCwd(entry.parentPath) + "/" + entry.name);
+    const isDir = entry.isDirectory();
+    let direntPath;
+    if (isDir) {
+        direntPath = path + "/";
+        ctx.totalDirs++;
+    }
+    else {
+        direntPath = path;
+        ctx.totalFiles++;
+    }
+    if (fastDepth) {
+        const { depth, depthSlash } = getDepth(path, maxDepth);
+        if (depth > maxDepth) {
+            const failedPrev = ctx.failed.length;
+            let match = await target.ignores({ fs, cwd, entry: path, ctx });
+            if (invert) {
+                match.ignored = !match.ignored;
+            }
+            if (failedPrev < ctx.failed.length) {
+                if (stream) {
+                    stream.emit("dirent", { dirent: entry, match, path: direntPath, ctx });
+                }
+                return 2;
+            }
+            if (match.ignored) {
+                if (isDir && fastInternal && match.kind === "internal") {
+                    return 1;
+                }
+                return 0;
+            }
+            if (isDir) {
+                // ctx.totalMatchedDirs++;
+                // ctx.depthPaths.set(path, (ctx.depthPaths.get(path) ?? 0) + 1);
+                return 0;
+            }
+            ctx.totalMatchedFiles++;
+            const dir = path.substring(0, depthSlash);
+            ctx.depthPaths.set(dir, (ctx.depthPaths.get(dir) ?? 0) + 1);
+            return 1;
         }
-        if (r === 1) {
-            continue;
+    }
+    const failedPrev = ctx.failed.length;
+    let match = await target.ignores({ fs, cwd, entry: path, ctx });
+    if (invert) {
+        match.ignored = !match.ignored;
+    }
+    if (failedPrev < ctx.failed.length) {
+        if (stream) {
+            stream.emit("dirent", { dirent: entry, match, path: direntPath, ctx });
         }
-        if (entry.isDirectory()) {
-            const r = await opendir(path + '/' + entry.name, cb);
-            if (r === 2) {
-                return 2;
+        return 2;
+    }
+    if (match.ignored) {
+        if (stream) {
+            stream.emit("dirent", { dirent: entry, match, path: direntPath, ctx });
+        }
+        if (isDir && fastInternal && match.kind === "internal") {
+            return 1;
+        }
+        return 0;
+    }
+    if (isDir) {
+        // ctx.totalMatchedDirs++;
+        // ctx.depthPaths.set(path, (ctx.depthPaths.get(path) ?? 0) + 1);
+        const { depth } = getDepth(path, maxDepth);
+        if (depth <= maxDepth) {
+            ctx.paths.set(direntPath, match);
+            if (stream) {
+                stream.emit("dirent", { dirent: entry, match, path: direntPath, ctx });
             }
         }
+        return 0;
+    }
+    ctx.totalMatchedFiles++;
+    const { depth, depthSlash } = getDepth(path, maxDepth);
+    if (depth > maxDepth) {
+        const dir = path.substring(0, depthSlash);
+        ctx.depthPaths.set(dir, (ctx.depthPaths.get(dir) ?? 0) + 1);
+        return 0;
+    }
+    if (depth <= maxDepth) {
+        const lastSlash = path.lastIndexOf("/");
+        if (lastSlash >= 0) {
+            const dir = path.substring(0, lastSlash) + "/";
+            const dirMatch = ctx.paths.get(dir);
+            if (!dirMatch || dirMatch.ignored) {
+                ctx.paths.set(dir, match);
+                if (stream) {
+                    stream.emit("dirent", { dirent: entry, match, path: direntPath, ctx });
+                }
+            }
+        }
+        ctx.paths.set(path, match);
+        if (stream) {
+            stream.emit("dirent", { dirent: entry, match, path: direntPath, ctx });
+        }
     }
+    return 0;
 }

package/package.json

@@ -1,80 +1,115 @@
 {
-  "name": "view-ignored",
-  "version": "0.5.1",
-  "description": "Retrieve list of files ignored/included by Git, NPM, Yarn, JSR, VSCE or other tools.",
-  "type": "module",
-  "scripts": {
-    "prerelease": "bun run test && bun run build:prod && bun run lint",
-    "test": "bun run build && node --test out/**/*.test.js",
-    "build": "rm -rf out && tsgo -p .",
-    "build:prod": "rm -rf out && tsgo -p tsconfig.prod.json",
-    "lint": "bun run eslint .",
-    "release:major": "bun run release-it --increment=major",
-    "release:minor": "bun run release-it --increment=minor",
-    "release:patch": "bun run release-it --increment=patch"
-  },
-  "author": "Mopsgamer",
-  "license": "MIT",
-  "files": [
-    "/out"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Mopsgamer/view-ignored.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Mopsgamer/view-ignored/issues"
-  },
-  "engines": {
-    "node": ">=18"
-  },
-  "exports": {
-    ".": {
-      "default": "./out/index.js",
-      "types": "./out/index.d.ts"
-    },
-    "./patterns": {
-      "default": "./out/patterns/index.js",
-      "types": "./out/patterns/index.d.ts"
-    },
-    "./targets": {
-      "default": "./out/targets/index.js",
-      "types": "./out/targets/index.d.ts"
-    }
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "directories": {
-    "lib": "out"
-  },
-  "dependencies": {
-    "arktype": "^2.1.29",
-    "minimatch": "^10.1.1",
-    "strip-json-comments": "^5.0.3"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.39.2",
-    "@release-it/keep-a-changelog": "^7.0.0",
-    "@stylistic/eslint-plugin": "^5.6.1",
-    "@types/node": "22",
-    "@typescript/native-preview": "^7.0.0-dev.20251214.1",
-    "eslint": "^9.39.2",
-    "fs-fixture": "^2.11.0",
-    "release-it": "^19.1.0",
-    "typescript-eslint": "^8.49.0"
-  },
-  "keywords": [
-    "tree",
-    "ls-tree",
-    "ignore",
-    "match",
-    "gitignore",
-    "npmignore",
-    "yarnignore",
-    "vscodeignore",
-    "fs",
-    "files",
-    "migration"
-  ]
+	"name": "view-ignored",
+	"version": "0.6.0",
+	"description": "Retrieve list of files ignored/included by Git, NPM, Yarn, JSR, VSCE or other tools.",
+	"keywords": [
+		".gitignore",
+		".npmignore",
+		".vscodeignore",
+		".yarnignore",
+		"file",
+		"files",
+		"fs",
+		"gitignore",
+		"ignore",
+		"ignorefile",
+		"ls-files",
+		"ls-tree",
+		"match",
+		"migration",
+		"npmignore",
+		"tree",
+		"vscodeignore",
+		"yarnignore"
+	],
+	"bugs": {
+		"url": "https://github.com/Mopsgamer/view-ignored/issues"
+	},
+	"license": "MIT",
+	"author": "Mopsgamer",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/Mopsgamer/view-ignored.git"
+	},
+	"directories": {
+		"lib": "out"
+	},
+	"files": [
+		"/out"
+	],
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./out/index.d.ts",
+			"default": "./out/index.js"
+		},
+		"./scan": {
+			"types": "./out/scan.d.ts",
+			"default": "./out/scan.js"
+		},
+		"./stream": {
+			"types": "./out/stream.d.ts",
+			"default": "./out/stream.js"
+		},
+		"./browser": {
+			"types": "./out/browser.d.ts",
+			"default": "./out/browser.js"
+		},
+		"./browser/scan": {
+			"types": "./out/browser_scan.d.ts",
+			"default": "./out/browser_scan.js"
+		},
+		"./browser/stream": {
+			"types": "./out/browser_stream.d.ts",
+			"default": "./out/browser_stream.js"
+		},
+		"./patterns": {
+			"types": "./out/patterns/index.d.ts",
+			"default": "./out/patterns/index.js"
+		},
+		"./targets": {
+			"types": "./out/targets/index.d.ts",
+			"default": "./out/targets/index.js"
+		}
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"prerelease": "bun run test && bun run prod && bun run lint && bun run fmt --check && bun publint --pack bun --strict",
+		"test": "bun test src",
+		"test:patterns": "bun test src/patterns",
+		"test:targets": "bun test src/targets",
+		"test:noself": "TEST_NO_SELF=1 bun test src",
+		"test:self": "bun test src/testSelf*.test.ts",
+		"test:self:git": "bun test src/testSelfGit.test.ts",
+		"test:self:npm": "bun test src/testSelfNPM.test.ts",
+		"lint": "bun run oxlint --type-aware",
+		"fmt": "bun run oxfmt",
+		"check": "bun tsgo -p . --noEmit",
+		"prod": "rm -rf out && tsgo -p tsconfig.prod.json",
+		"release:major": "bun run release-it --increment=major",
+		"release:minor": "bun run release-it --increment=minor",
+		"release:patch": "bun run release-it --increment=patch"
+	},
+	"dependencies": {
+		"arktype": "^2.1.29",
+		"minimatch": "^10.1.2",
+		"strip-json-comments": "^5.0.3"
+	},
+	"devDependencies": {
+		"@release-it/keep-a-changelog": "^7.0.1",
+		"@types/bun": "^1.3.8",
+		"@types/node": "^18.19.130",
+		"@typescript/native-preview": "^7.0.0-dev.20260209.1",
+		"memfs": "^4.56.10",
+		"oxfmt": "^0.28.0",
+		"oxlint": "^1.43.0",
+		"oxlint-tsgolint": "^0.11.5",
+		"publint": "^0.3.17",
+		"release-it": "^19.2.4"
+	},
+	"engines": {
+		"node": ">=18"
+	}
 }

package/out/patterns/matcher.d.ts

@@ -1,102 +0,0 @@
-/**
- * The results and statistics of a scanning operation.
- */
-export type MatcherContext = {
-    /**
-     * `Set` can be sorted, but `view-ignored`
-     * does not sort paths.
-     * @example
-     * new Set(sort(new Set(['a/b', 'a/a'])))
-     */
-    paths: Set<string>;
-    /**
-     * Maps directory paths to their corresponding sources.
-     * @example
-     * "src" => Source
-     */
-    external: Map<string, Source>;
-    /**
-     * Maps directory paths to the quantity of path segments they contain.
-     * @example
-     * "src/components" => 2
-     */
-    depthPaths: Map<string, number>;
-    /**
-     * Any errors encountered while processing source files.
-     */
-    sourceErrors: Error[];
-    /**
-     * Total number of files scanned.
-     */
-    totalFiles: number;
-    /**
-     * Total number of files matched by the target.
-     */
-    totalMatchedFiles: number;
-    /**
-     * Total number of directories scanned.
-     */
-    totalDirs: number;
-};
-/**
- * Represents a list of positive minimatch patterns.
- */
-export type Pattern = string[];
-export declare function patternMatches(pattern: Pattern, path: string): boolean;
-/**
- * Represents a set of include and exclude patterns.
- * These patterns are positive minimatch patterns.
- */
-export type SignedPattern = {
-    include: Pattern;
-    exclude: Pattern;
-};
-/**
- * Combined internal and external patterns for matching.
- * Used in {@link signedPatternIgnores} function.
- */
-export type PatternMatcher = {
-    internal: SignedPattern;
-    external: SignedPattern;
-};
-/**
- * Checks whether a given path should be ignored based on its patterns.
- * @see {@link findAndExtract}
- * @see {@link signedPatternIgnores}
- * @see {@link https://github.com/Mopsgamer/view-ignored/tree/main/src/targets} for usage examples.
- */
-export type PathChecker = (path: string, isDir: boolean, ctx: MatcherContext) => Promise<boolean>;
-/**
- * Represents a source of patterns for matching paths.
- */
-export type Source = {
-    /**
-     * Patterns defined within the source file.
-     * Those patterns are for ignoring files.
-     */
-    pattern: SignedPattern;
-    /**
-     * Name of the source file.
-     */
-    name: string;
-    /**
-     * Indicates if the matching logic is inverted.
-     * For example, `package.json` `files` field inverts the matching logic,
-     * because it specifies files to include rather than exclude.
-     */
-    inverted: boolean;
-};
-/**
- * Populates a `Source` object from the content of a source file.
- * @see {@link Source.pattern} for more details.
- */
-export type SourceExtractor = (source: Source, content: Buffer<ArrayBuffer>) => void;
-/**
- * Populates the {@link MatcherContext.external} map with {@link Source} objects.
- */
-export declare function findAndExtract(directory: string, sources: string[], matcher: Map<string, SourceExtractor>, ctx: MatcherContext): Promise<void>;
-/**
- * Checks whether a given file should be ignored based on internal and external patterns.
- * Populates unknown sources using {@link findAndExtract}.
- */
-export declare function signedPatternIgnores(internal: SignedPattern, file: string, sources: string[], sourceMap: Map<string, SourceExtractor>, ctx: MatcherContext): Promise<boolean>;

package/out/patterns/matcher.js

@@ -1,125 +0,0 @@
-import * as fsp from 'node:fs/promises';
-import { dirname } from 'node:path';
-import { gitignoreMatch } from './gitignore.js';
-export function patternMatches(pattern, path) {
-    for (const p of pattern) {
-        const matched = gitignoreMatch(p, path);
-        if (matched) {
-            return true;
-        }
-    }
-    return false;
-}
-/**
- * Populates the {@link MatcherContext.external} map with {@link Source} objects.
- */
-export async function findAndExtract(directory, sources, matcher, ctx) {
-    const keys = [];
-    for (const sourceFileName of sources) {
-        for (;;) {
-            let buff;
-            try {
-                buff = await fsp.readFile(directory + '/' + sourceFileName);
-            }
-            catch (err) {
-                const error = err;
-                if (error.code !== 'ENOENT') {
-                    ctx.sourceErrors.push(error);
-                    return;
-                }
-            }
-            const dir = dirname(directory);
-            if (!ctx.external.has(directory)) {
-                keys.push(directory);
-            }
-            if (!buff) {
-                if (directory === '.') {
-                    break;
-                }
-                directory = dir;
-                continue;
-            }
-            if (directory === '.' && !keys.length) {
-                break;
-            }
-            const sourceExtractor = matcher.get(sourceFileName);
-            if (!sourceExtractor) {
-                const err = new Error('No extractor for source file: ' + sourceFileName);
-                ctx.sourceErrors.push(err);
-                break;
-            }
-            const source = {
-                inverted: false,
-                name: sourceFileName,
-                pattern: {
-                    exclude: [],
-                    include: [],
-                },
-            };
-            try {
-                sourceExtractor(source, buff);
-            }
-            catch (err) {
-                ctx.sourceErrors.push(err);
-                break;
-            }
-            for (const key of keys) {
-                const m = ctx.external.get(key);
-                if (!m) {
-                    ctx.external.set(key, source);
-                }
-            }
-            if (directory === '.') {
-                return;
-            }
-            keys.length = 0;
-            directory = dir;
-        }
-    }
-}
-/**
- * Checks whether a given file should be ignored based on internal and external patterns.
- * Populates unknown sources using {@link findAndExtract}.
- */
-export async function signedPatternIgnores(internal, file, sources, sourceMap, ctx) {
-    const parent = dirname(file);
-    let source = ctx.external.get(parent);
-    if (!source) {
-        await findAndExtract(parent, sources, sourceMap, ctx);
-        if (ctx.sourceErrors.length) {
-            return false;
-        }
-        source = ctx.external.get(parent);
-        if (!source) {
-            return false;
-        }
-    }
-    const matcher = {
-        internal,
-        external: source.pattern,
-    };
-    try {
-        let check = false;
-        check = patternMatches(matcher.internal.exclude, file);
-        if (check) {
-            return true;
-        }
-        check = patternMatches(matcher.internal.include, file);
-        if (check) {
-            return false;
-        }
-        check = patternMatches(matcher.external.exclude, file);
-        if (check) {
-            return true;
-        }
-        check = patternMatches(matcher.external.include, file);
-        if (check) {
-            return false;
-        }
-    }
-    catch (err) {
-        ctx.sourceErrors.push(err);
-        return false;
-    }
-    return source.inverted;
-}