view-ignored 0.7.1 → 0.8.1

package/README.md

@@ -43,7 +43,11 @@ const ctx = await vign.scan({ target })
 ctx.paths.has(".git/HEAD") // false
 ctx.paths.has("src") // true
 
-ctx.paths.get("src") // { ignored, match, kind, ... }
+const match = ctx.paths.get("src")
+if (match.kind === "external") {
+	console.log(match.source.path) // ".gitignore"
+	console.log(match.pattern) // "src/**"
+}
 ```
 
 ### Using custom target
@@ -107,6 +111,7 @@ stream.on("end", (ctx) => {
 	ctx.paths.has("node_modules/") // false
 	ctx.paths.has("package.json") // true
 })
+stream.start() // important
 ```
 
 ### Browser and custom FS
@@ -133,36 +138,37 @@ vign.scan({ target, cwd, fs })
 
 ## Targets
 
-> [!NOTE]
-> Each scanner expects minimal configurations, but the actual tool can have
-> more/less complex rules. Refer to the documentation of each tool for details.
-
 The following built-in scanners are available:
 
-- Git
+- Git ([implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/git.ts))
   - Reads `.gitignore` and `.git/info/exclude` but does not consider global settings.
   - Starts searching from `/`.
   - Check this scanner by running `git ls-files --others --exclude-standard --cached`.
-  - See the implementation of [Git target](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/git.ts) for details.
-- NPM (compatible with Bun, PNPM, and others)
-  - Reads `.npmignore` and `package.json` `files` field.
+- NPM ([implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/npm.ts))
+  - Expecting to be compatible with PNPM, and others.
+  - Reads `package.json` `files` field, `.npmignore` and `.gitignore`.
   - Starts searching from `.` (current working directory).
   - No additional checks for `name`, `version` or `publishConfig`.
   - Check this scanner by running `npm pack --dry-run`.
-  - See the implementation of [NPM target](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/npm.ts) for details.
-- Yarn
-  - Same behavior as `npm`, but also reads `.yarnignore`.
+- Bun ([implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/bun.ts))
+  - Bun tries to mimic NPM, but that does not mean it behaves the same way.
+  - Check this scanner by running `bun pm pack --dry-run`.
+- Yarn ([implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/yarn.ts))
+  - Modern Berry behavior.
+  - Reads `package.json` `files` field, `.npmignore` and `.gitignore`.
+  - Requires `package.json`: includes paths from `main`, `module`, `browser` and `bin`.
   - Starts searching from `.` (current working directory).
-  - See the implementation of [Yarn target](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/yarn.ts) for details.
-- VSCE
+  - `YarnClassic` is available. ([implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/yarnClassic.ts))
+- VSCE ([implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/vsce.ts))
   - Reads `package.json` `files` field, `.vscodeignore` and `.gitignore`.
   - Starts searching from `.` (current working directory).
   - Check this scanner by running `vsce ls`.
-  - See the implementation of [VSCE target](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/vsce.ts) for details.
-- JSR (compatible with Deno)
+- JSR ([implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/jsr.ts))
+  - Reads `jsr.json(c)` `include` and `exclude` fields.
+  - Starts searching from `.` (current working directory).
+- Deno ([implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/deno.ts))
   - Reads `jsr.json(c)` and `deno.json(c)` `include` and `exclude` fields.
   - Starts searching from `.` (current working directory).
-  - See the implementation of [JSR target](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/jsr.ts) for details.
 
 ## See also
 

package/out/browser_scan.d.ts

@@ -4,7 +4,7 @@ export type * from "./types.js";
 /**
  * Scan the directory for included files based on the provided targets.
  *
- * Note that this function uses `fs/promises.readFile` and `fs/promises.opendir` without options within
+ * Note that this function uses `fs.promises.readFile` and `fs.promises.opendir` without options within
  * custom recursion, instead of `fs.promises.readdir` with `{ withFileTypes: true }.
  * It also normalizes paths to use forward slashes.
  * Please report any issues if you encounter problems related to this behavior.

package/out/browser_scan.js

@@ -1,12 +1,10 @@
-import { resolve } from "node:path";
-import { relative } from "node:path/posix";
-import { normalizeCwd } from "./normalizeCwd.js";
 import { opendir } from "./opendir.js";
+import { unixify, relative, join } from "./unixify.js";
 import { walkIncludes } from "./walk.js";
 /**
  * Scan the directory for included files based on the provided targets.
  *
- * Note that this function uses `fs/promises.readFile` and `fs/promises.opendir` without options within
+ * Note that this function uses `fs.promises.readFile` and `fs.promises.opendir` without options within
  * custom recursion, instead of `fs.promises.readdir` with `{ withFileTypes: true }.
  * It also normalizes paths to use forward slashes.
  * Please report any issues if you encounter problems related to this behavior.
@@ -30,7 +28,7 @@ export function scan(options) {
         totalMatchedFiles: 0,
         totalDirs: 0,
     };
-    const normalCwd = normalizeCwd(cwd);
+    const normalCwd = unixify(cwd);
     const scanOptions = {
         cwd: normalCwd,
         within,
@@ -42,18 +40,19 @@ export function scan(options) {
         signal,
         target,
     };
-    const result = opendir(fs, normalizeCwd(resolve(normalCwd, within)), (entry) => {
-        const path = relative(normalCwd, normalizeCwd(entry.parentPath) + "/" + entry.name);
-        return walkIncludes({
-            path,
-            entry,
-            ctx,
-            stream: undefined,
-            scanOptions,
-        });
-    });
     return (async () => {
-        await result;
+        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);
+            return walkIncludes({
+                path,
+                entry,
+                ctx,
+                stream: undefined,
+                scanOptions,
+            });
+        });
         return ctx;
     })();
 }

package/out/browser_stream.js

@@ -1,51 +1,9 @@
-import { resolve } from "node:path";
-import { relative } from "node:path/posix";
-import { normalizeCwd } from "./normalizeCwd.js";
-import { opendir } from "./opendir.js";
 import { MatcherStream } from "./patterns/matcherStream.js";
-import { walkIncludes } from "./walk.js";
 /**
  * @see {@link browserScan}
  *
  * @since 0.6.0
  */
 export function scanStream(options) {
-    const { target, cwd, within = ".", invert = false, depth: maxDepth = Infinity, signal = null, fastDepth = false, fastInternal = false, fs, } = options;
-    const ctx = {
-        paths: new Map(),
-        external: new Map(),
-        failed: [],
-        depthPaths: new Map(),
-        totalFiles: 0,
-        totalMatchedFiles: 0,
-        totalDirs: 0,
-    };
-    const stream = new MatcherStream({ captureRejections: false });
-    const normalCwd = normalizeCwd(cwd);
-    const scanOptions = {
-        cwd: normalCwd,
-        within,
-        depth: maxDepth,
-        fastDepth,
-        fastInternal,
-        fs,
-        invert,
-        signal,
-        target,
-    };
-    const result = opendir(fs, normalizeCwd(resolve(normalCwd, within)), (entry) => {
-        const path = relative(normalCwd, normalizeCwd(entry.parentPath) + "/" + entry.name);
-        return walkIncludes({
-            path,
-            entry,
-            ctx,
-            stream,
-            scanOptions,
-        });
-    });
-    void (async () => {
-        await result;
-        stream.emit("end", ctx);
-    })();
-    return stream;
+    return new MatcherStream(options);
 }

package/out/patterns/gitignore.d.ts

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

package/out/patterns/gitignore.js

@@ -8,6 +8,22 @@ import { sourcePushNegatable } from "./source.js";
  * @since 0.6.0
  */
 export function extractGitignore(source, content) {
+    extract(source, content);
+    signedPatternCompile(source.pattern);
+}
+/**
+ * Extracts and compiles patterns from the file.
+ *
+ * @see {@link signedPatternCompile}
+ *
+ * @since 0.6.0
+ */
+export function extractGitignoreNocase(source, content) {
+    extract(source, content);
+    signedPatternCompile(source.pattern, { nocase: true });
+}
+extractGitignore;
+function extract(source, content) {
     for (let line of content.toString().split("\n")) {
         line = line.trim();
         if (line === "" || line.startsWith("#")) {
@@ -19,6 +35,4 @@ export function extractGitignore(source, content) {
         }
         sourcePushNegatable(source, line);
     }
-    signedPatternCompile(source.pattern);
 }
-extractGitignore;

package/out/patterns/ignores.d.ts

@@ -1,40 +1,17 @@
-import type { MatcherContext } from "../patterns/matcherContext.js";
 import type { SignedPatternMatch } from "../patterns/signedPattern.js";
-import type { FsAdapter } from "../types.js";
+import type { InitState } from "./initState.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;
+export interface IgnoresOptions extends InitState {
     /**
      * 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/index.d.ts

@@ -1,6 +1,8 @@
 export * from "./extractor.js";
 export * from "./gitignore.js";
 export * from "./ignores.js";
+export * from "./init.js";
+export * from "./initState.js";
 export * from "./jsrjson.js";
 export * from "./matcherContext.js";
 export * from "./matcherContextPatch.js";
@@ -11,3 +13,4 @@ export * from "./patternMatcher.js";
 export * from "./resolveSources.js";
 export * from "./signedPattern.js";
 export * from "./source.js";
+export * from "./stringCompile.js";

package/out/patterns/index.js

@@ -1,6 +1,8 @@
 export * from "./extractor.js";
 export * from "./gitignore.js";
 export * from "./ignores.js";
+export * from "./init.js";
+export * from "./initState.js";
 export * from "./jsrjson.js";
 export * from "./matcherContext.js";
 export * from "./matcherContextPatch.js";
@@ -11,3 +13,4 @@ export * from "./patternMatcher.js";
 export * from "./resolveSources.js";
 export * from "./signedPattern.js";
 export * from "./source.js";
+export * from "./stringCompile.js";

package/out/patterns/init.d.ts

@@ -0,0 +1,9 @@
+import type { InitState } from "./initState.js";
+/**
+ * Initializes the target. For example,
+ * Yarn reads `package.json` to find `main` and `bin` values,
+ * so it can forcefully include them.
+ *
+ * @since 0.8.0
+ */
+export type Init = (options: InitState) => Promise<void>;

package/out/patterns/init.js

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

package/out/patterns/initState.d.ts

@@ -0,0 +1,31 @@
+import type { FsAdapter } from "../types.js";
+import type { MatcherContext } from "./matcherContext.js";
+/**
+ * Used in {@link IgnoresOptions}.
+ *
+ * @since 0.8.0
+ */
+export interface InitState {
+    /**
+     * The file system adapter for directory walking and reading files.
+     *
+     * @since 0.6.0
+     */
+    fs: FsAdapter;
+    /**
+     * @since 0.6.0
+     */
+    cwd: string;
+    /**
+     * The context to populate.
+     *
+     * @since 0.6.0
+     */
+    ctx: MatcherContext;
+    /**
+     * Return as soon as possible.
+     *
+     * @since 0.7.1
+     */
+    signal: AbortSignal | null;
+}

package/out/patterns/initState.js

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

package/out/patterns/matcherContextPatch.js

@@ -1,8 +1,7 @@
 import { resolve, dirname } from "node:path";
-import { relative } from "node:path/posix";
 import { getDepth } from "../getDepth.js";
-import { normalizeCwd } from "../normalizeCwd.js";
 import { opendir } from "../opendir.js";
+import { unixify, relative } from "../unixify.js";
 import { walkIncludes } from "../walk.js";
 /**
  * Provides patching abilities for the given {@link MatcherContext}.
@@ -141,9 +140,9 @@ export async function matcherContextRemovePath(ctx, options, entry) {
     return true;
 }
 async function rescan(ctx, options) {
-    const normalCwd = normalizeCwd(options.cwd);
+    const normalCwd = unixify(options.cwd);
     await opendir(options.fs, resolve(normalCwd, options.within), (entry) => {
-        const path = relative(normalCwd, normalizeCwd(entry.parentPath) + "/" + entry.name);
+        const path = relative(normalCwd, unixify(entry.parentPath) + "/" + entry.name);
         return walkIncludes({
             path,
             entry,

package/out/patterns/matcherStream.d.ts

@@ -1,6 +1,7 @@
 import { EventEmitter } from "node:events";
 import type { Dirent } from "node:fs";
 import type { MatcherContext } from "../patterns/matcherContext.js";
+import type { ScanOptions, FsAdapter } from "../types.js";
 import type { SignedPatternMatch } from "./signedPattern.js";
 /**
  * Post-scan entry information.
@@ -61,4 +62,18 @@ export type EventMap = {
  * @since 0.6.0
  */
 export declare class MatcherStream extends EventEmitter<EventMap> {
+    #private;
+    constructor(options: ScanOptions & {
+        fs: FsAdapter;
+        cwd: string;
+        noTimeout?: boolean;
+    } & {
+        captureRejections?: boolean;
+    });
+    /**
+     * Resolves when everything is scanned.
+     *
+     * @since 0.8.0
+     */
+    start(): Promise<void>;
 }

package/out/patterns/matcherStream.js

@@ -1,4 +1,7 @@
 import { EventEmitter } from "node:events";
+import { opendir } from "../opendir.js";
+import { join, relative, unixify } from "../unixify.js";
+import { walkIncludes } from "../walk.js";
 /**
  * Event emitter.
  * @extends EventEmitter
@@ -6,4 +9,58 @@ import { EventEmitter } from "node:events";
  * @since 0.6.0
  */
 export class MatcherStream extends EventEmitter {
+    #timeout;
+    #options;
+    constructor(options) {
+        super({ captureRejections: options.captureRejections });
+        this.#options = options;
+        if (!options.noTimeout) {
+            this.#timeout = setTimeout(() => {
+                throw new Error("Stream did not start within 5 seconds. Call MatcherStream.start() or enable noTimeout.");
+            }, 5e3);
+        }
+    }
+    /**
+     * Resolves when everything is scanned.
+     *
+     * @since 0.8.0
+     */
+    async start() {
+        clearTimeout(this.#timeout);
+        const { target, cwd, within = ".", invert = false, depth: maxDepth = Infinity, signal = null, fastDepth = false, fastInternal = false, fs, } = this.#options;
+        const ctx = {
+            paths: new Map(),
+            external: new Map(),
+            failed: [],
+            depthPaths: new Map(),
+            totalFiles: 0,
+            totalMatchedFiles: 0,
+            totalDirs: 0,
+        };
+        const normalCwd = unixify(cwd);
+        const scanOptions = {
+            cwd: normalCwd,
+            within,
+            depth: maxDepth,
+            fastDepth,
+            fastInternal,
+            fs,
+            invert,
+            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);
+            return walkIncludes({
+                path,
+                entry,
+                ctx,
+                stream: this,
+                scanOptions,
+            });
+        });
+        this.emit("end", ctx);
+    }
 }

package/out/patterns/packagejson.d.ts

@@ -7,3 +7,11 @@ import { type Source } from "./source.js";
  * @since 0.6.0
  */
 export declare function extractPackageJson(source: Source, content: Buffer): void | "none";
+/**
+ * Extracts and compiles patterns from the file.
+ *
+ * @see {@link signedPatternCompile}
+ *
+ * @since 0.8.0
+ */
+export declare function extractPackageJsonNocase(source: Source, content: Buffer): void | "none";

package/out/patterns/packagejson.js

@@ -1,12 +1,12 @@
 import { type } from "arktype";
 import { signedPatternCompile } from "./resolveSources.js";
 import { sourcePushNegatable } from "./source.js";
-const nodeJsManifest = type({
-    files: "string[]?",
+const npmManifest = type({
+    "files?": "string[]",
 });
 const parse = type("string")
     .pipe((s) => JSON.parse(s))
-    .pipe(nodeJsManifest);
+    .pipe(npmManifest);
 /**
  * Extracts and compiles patterns from the file.
  *
@@ -15,11 +15,34 @@ const parse = type("string")
  * @since 0.6.0
  */
 export function extractPackageJson(source, content) {
+    const result = extract(source, content);
+    if (result === undefined)
+        signedPatternCompile(source.pattern);
+    if (result === "error")
+        return;
+    return result;
+}
+/**
+ * Extracts and compiles patterns from the file.
+ *
+ * @see {@link signedPatternCompile}
+ *
+ * @since 0.8.0
+ */
+export function extractPackageJsonNocase(source, content) {
+    const result = extract(source, content);
+    if (result === undefined)
+        signedPatternCompile(source.pattern, { nocase: true });
+    if (result === "error")
+        return;
+    return result;
+}
+function extract(source, content) {
     source.inverted = true;
     const dist = parse(content.toString());
     if (dist instanceof type.errors) {
         source.error = new Error("Invalid '" + source.path + "': " + dist.summary, { cause: dist });
-        return;
+        return "error";
     }
     if (!dist.files) {
         return "none";
@@ -27,6 +50,5 @@ export function extractPackageJson(source, content) {
     for (const pattern of dist.files) {
         sourcePushNegatable(source, pattern);
     }
-    signedPatternCompile(source.pattern);
 }
 extractPackageJson;

package/out/patterns/pattern.d.ts

@@ -1,3 +1,4 @@
+import { type StringCompileOptions } from "./stringCompile.js";
 /**
  * Compiled pattern.
  *
@@ -41,4 +42,4 @@ export type Pattern = string[];
  *
  * @since 0.6.0
  */
-export declare function patternCompile(pattern: Pattern): PatternMinimatch[];
+export declare function patternCompile(pattern: Pattern, options?: StringCompileOptions): PatternMinimatch[];

package/out/patterns/pattern.js

@@ -16,6 +16,6 @@ export function patternMinimatchTest(pattern, path) {
  *
  * @since 0.6.0
  */
-export function patternCompile(pattern) {
-    return pattern.map(stringCompile);
+export function patternCompile(pattern, options) {
+    return pattern.map((p, _, pattern) => stringCompile(p, pattern, options));
 }

package/out/patterns/resolveSources.d.ts

@@ -1,5 +1,6 @@
 import type { PatternFinderOptions } from "./extractor.js";
 import type { SignedPattern } from "./signedPattern.js";
+import type { StringCompileOptions } from "./stringCompile.js";
 /**
  * Compiles the {@link SignedPattern} (forced).
  * Can be compiled at any time.
@@ -9,7 +10,7 @@ import type { SignedPattern } from "./signedPattern.js";
  *
  * @since 0.6.0
  */
-export declare function signedPatternCompile(signedPattern: SignedPattern): SignedPattern;
+export declare function signedPatternCompile(signedPattern: SignedPattern, options?: StringCompileOptions): SignedPattern;
 /**
  * @see {@link resolveSources}
  *

package/out/patterns/resolveSources.js

@@ -1,4 +1,5 @@
-import { dirname, relative, resolve } from "node:path";
+import { dirname } from "node:path";
+import { unixify, relative, join } from "../unixify.js";
 import { patternCompile } from "./pattern.js";
 /**
  * Compiles the {@link SignedPattern} (forced).
@@ -9,10 +10,10 @@ import { patternCompile } from "./pattern.js";
  *
  * @since 0.6.0
  */
-export function signedPatternCompile(signedPattern) {
+export function signedPatternCompile(signedPattern, options) {
     signedPattern.compiled = {
-        include: patternCompile(signedPattern.include),
-        exclude: patternCompile(signedPattern.exclude),
+        include: patternCompile(signedPattern.include, options),
+        exclude: patternCompile(signedPattern.exclude, options),
     };
     return signedPattern;
 }
@@ -73,8 +74,8 @@ export async function resolveSources(options) {
             ctx.external.set(noSourceDir, source);
         }
     }
-    const rels = noSourceDirList.map((rel) => resolve(cwd, rel).replaceAll("\\", "/").replace(/\w:/, ""));
-    source = await findSourceForAbsoluteDirs(rels, ctx, fs, target, signal);
+    const absPaths = noSourceDirList.map((rel) => join(cwd, rel));
+    source = await findSourceForAbsoluteDirs(absPaths, ctx, fs, target, signal);
     if (source !== undefined) {
         for (const noSourceDir of noSourceDirList) {
             signal?.throwIfAborted();
@@ -99,7 +100,13 @@ async function findSourceForAbsoluteDirs(paths, ctx, fs, target, signal) {
     return "none";
 }
 async function tryExtractor(cwd, fs, ctx, extractor) {
-    const abs = resolve(cwd, extractor.path);
+    let abs = unixify(cwd);
+    if (abs.endsWith("/")) {
+        abs += extractor.path;
+    }
+    else {
+        abs += "/" + extractor.path;
+    }
     const path = relative(cwd, abs);
     const name = path.substring(path.lastIndexOf("/") + 1);
     const newSource = {

package/out/patterns/stringCompile.d.ts

@@ -1,9 +1,22 @@
 import type { PatternMinimatch, Pattern } from "./pattern.js";
+/**
+ * @since 0.8.0
+ */
+export type StringCompileOptions = {
+    /**
+     * Disables case sensitivity.
+     *
+     * @default false
+     *
+     * @since 0.8.0
+     */
+    nocase?: boolean;
+};
 /**
  * Compiles a string of the {@link Pattern}.
  *
  * @see {@link patternCompile}
  *
- * @since 0.6.0
+ * @since 0.8.0
  */
-export declare function stringCompile(pattern: string, _?: number, array?: Pattern): PatternMinimatch;
+export declare function stringCompile(pattern: string, context?: Pattern, options?: StringCompileOptions): PatternMinimatch;