view-ignored 0.6.0 → 0.7.1

package/out/browser_scan.d.ts

@@ -12,7 +12,7 @@ export type * from "./types.js";
  * @param options Scan options.
  * @returns A promise that resolves to a {@link MatcherContext} containing the scan results.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export declare function scan(options: ScanOptions & {
     fs: FsAdapter;

package/out/browser_scan.js

@@ -1,4 +1,5 @@
 import { resolve } from "node:path";
+import { relative } from "node:path/posix";
 import { normalizeCwd } from "./normalizeCwd.js";
 import { opendir } from "./opendir.js";
 import { walkIncludes } from "./walk.js";
@@ -13,10 +14,10 @@ import { walkIncludes } from "./walk.js";
  * @param options Scan options.
  * @returns A promise that resolves to a {@link MatcherContext} containing the scan results.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export function scan(options) {
-    const { target, cwd, within: select = ".", invert = false, depth: maxDepth = Infinity, signal = null, fastDepth = false, fastInternal = false, fs, } = options;
+    const { target, cwd, within = ".", invert = false, depth: maxDepth = Infinity, signal = null, fastDepth = false, fastInternal = false, fs, } = options;
     if (maxDepth < 0) {
         throw new TypeError("Depth must be a non-negative integer");
     }
@@ -32,7 +33,7 @@ export function scan(options) {
     const normalCwd = normalizeCwd(cwd);
     const scanOptions = {
         cwd: normalCwd,
-        within: select,
+        within,
         depth: maxDepth,
         fastDepth,
         fastInternal,
@@ -41,12 +42,16 @@ export function scan(options) {
         signal,
         target,
     };
-    const result = opendir(fs, resolve(normalCwd, select), (entry) => walkIncludes({
-        entry,
-        ctx,
-        stream: undefined,
-        scanOptions,
-    }));
+    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;
         return ctx;

package/out/browser_stream.d.ts

@@ -4,7 +4,7 @@ export type * from "./types.js";
 /**
  * @see {@link browserScan}
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export declare function scanStream(options: ScanOptions & {
     fs: FsAdapter;

package/out/browser_stream.js

@@ -1,4 +1,5 @@
 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";
@@ -6,10 +7,10 @@ import { walkIncludes } from "./walk.js";
 /**
  * @see {@link browserScan}
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export function scanStream(options) {
-    const { target, cwd, within: select = ".", invert = false, depth: maxDepth = Infinity, signal = null, fastDepth = false, fastInternal = false, fs, } = 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(),
@@ -23,7 +24,7 @@ export function scanStream(options) {
     const normalCwd = normalizeCwd(cwd);
     const scanOptions = {
         cwd: normalCwd,
-        within: select,
+        within,
         depth: maxDepth,
         fastDepth,
         fastInternal,
@@ -32,12 +33,16 @@ export function scanStream(options) {
         signal,
         target,
     };
-    const result = opendir(fs, resolve(normalCwd, select), (entry) => walkIncludes({
-        entry,
-        ctx,
-        stream,
-        scanOptions,
-    }));
+    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);

package/out/patterns/extractor.d.ts

@@ -10,13 +10,13 @@ import type { Source } from "./source.js";
  * @see {@link Source.pattern} for more details.
  * @throws Error if extraction fails. Processing stops.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export type ExtractorFn = (source: Source, content: Buffer, ctx: MatcherContext) => void | "none";
 /**
  * Defines a method for extracting patterns from a specific source file.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export interface Extractor {
     /**
@@ -25,7 +25,7 @@ export interface Extractor {
      * @example
      * ".gitignore"
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     path: string;
     /**
@@ -33,7 +33,7 @@ export interface Extractor {
      *
      * @see {@link ExtractorFn}
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     extract: ExtractorFn;
 }
@@ -43,38 +43,44 @@ export interface Extractor {
  * @see {@link resolveSources}
  * @see {@link signedPatternIgnores}
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export interface PatternFinderOptions {
     /**
      * The file system adapter for directory walking and reading files.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     fs: FsAdapter;
     /**
      * The context to modify.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     ctx: MatcherContext;
     /**
      * The current working directory.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     cwd: string;
     /**
      * The target implementation.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     target: Target;
     /**
      * Initial search directory.
      * Relative to the `cwd` path or absolute path.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     root: string;
+    /**
+     * Return as soon as possible.
+     *
+     * @since 0.7.1
+     */
+    signal: AbortSignal | null;
 }

package/out/patterns/gitignore.d.ts

@@ -4,6 +4,6 @@ import { type Source } from "./source.js";
  *
  * @see {@link signedPatternCompile}
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export declare function extractGitignore(source: Source, content: Buffer): void;

package/out/patterns/gitignore.js

@@ -5,7 +5,7 @@ import { sourcePushNegatable } from "./source.js";
  *
  * @see {@link signedPatternCompile}
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export function extractGitignore(source, content) {
     for (let line of content.toString().split("\n")) {

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.
@@ -14,6 +43,6 @@ export interface IgnoresOptions {
  * @see {@link signedPatternIgnores}
  * @see {@link https://github.com/Mopsgamer/view-ignored/tree/main/src/targets} for usage examples.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export type Ignores = (options: IgnoresOptions) => Promise<SignedPatternMatch>;

package/out/patterns/jsrjson.d.ts

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

package/out/patterns/jsrjson.js

@@ -15,7 +15,7 @@ const parse = type("string")
 /**
  * Extracts and compiles patterns from the file.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export function extractJsrJson(source, content, ctx) {
     const dist = parse(content.toString());
@@ -48,7 +48,7 @@ extractJsrJson;
  *
  * @see {@link signedPatternCompile}
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export function extractJsrJsonc(source, content, ctx) {
     extractJsrJson(source, Buffer.from(stripJsonComments(content.toString())), ctx);

package/out/patterns/matcherContext.d.ts

@@ -3,14 +3,14 @@ import type { Source } from "./source.js";
 /**
  * Post-scan results.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export interface MatcherContext {
     /**
      * Paths and their corresponding sources.
      * Directory paths are having the slash suffix.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     paths: Map<string, SignedPatternMatch>;
     /**
@@ -20,14 +20,14 @@ export interface MatcherContext {
      * "dir" => Source
      * "dir/subdir" => Source
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     external: Map<string, Source | "none">;
     /**
      * If any fatal errors were encountered during source extractions,
      * this property will contain an array of failed sources.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     failed: Source[];
     /**
@@ -47,25 +47,25 @@ export interface MatcherContext {
      * "src/components" => 0
      * "src/views" => 1
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     depthPaths: Map<string, number>;
     /**
      * Total number of files scanned.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     totalFiles: number;
     /**
      * Total number of files matched by the target.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     totalMatchedFiles: number;
     /**
      * Total number of directories scanned.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     totalDirs: number;
 }

package/out/patterns/matcherContextPatch.d.ts

@@ -4,13 +4,13 @@ import type { MatcherContext } from "./matcherContext.js";
  * Provides patching abilities for the given {@link MatcherContext}.
  * Directories should have the slash suffix.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export declare function matcherContextAddPath(ctx: MatcherContext, options: Required<ScanOptions>, entry: string): Promise<boolean>;
 /**
  * Provides patching abilities for the given {@link MatcherContext}.
  * Directories should have the slash suffix.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export declare function matcherContextRemovePath(ctx: MatcherContext, options: Required<ScanOptions>, entry: string): Promise<boolean>;

package/out/patterns/matcherContextPatch.js

@@ -1,4 +1,5 @@
 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";
@@ -7,13 +8,13 @@ import { walkIncludes } from "../walk.js";
  * Provides patching abilities for the given {@link MatcherContext}.
  * Directories should have the slash suffix.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 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
@@ -21,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++;
         }
@@ -42,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);
@@ -60,7 +61,7 @@ export async function matcherContextAddPath(ctx, options, entry) {
  * Provides patching abilities for the given {@link MatcherContext}.
  * Directories should have the slash suffix.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export async function matcherContextRemovePath(ctx, options, entry) {
     const isDir = entry.endsWith("/");
@@ -141,11 +142,15 @@ export async function matcherContextRemovePath(ctx, options, entry) {
 }
 async function rescan(ctx, options) {
     const normalCwd = normalizeCwd(options.cwd);
-    await opendir(options.fs, resolve(normalCwd, options.within), (entry) => walkIncludes({
-        entry,
-        ctx,
-        stream: undefined,
-        scanOptions: { ...options, cwd: normalCwd },
-    }));
+    await opendir(options.fs, resolve(normalCwd, options.within), (entry) => {
+        const path = relative(normalCwd, normalizeCwd(entry.parentPath) + "/" + entry.name);
+        return walkIncludes({
+            path,
+            entry,
+            ctx,
+            stream: undefined,
+            scanOptions: { ...options, cwd: normalCwd },
+        });
+    });
     ctx.totalDirs = ctx.totalFiles = ctx.totalMatchedFiles = -1;
 }

package/out/patterns/matcherStream.d.ts

@@ -5,50 +5,50 @@ import type { SignedPatternMatch } from "./signedPattern.js";
 /**
  * Post-scan entry information.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export type EntryInfo = {
     /**
      * The relative path of the entry.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     path: string;
     /**
      * The directory entry.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     dirent: Dirent;
     /**
      * Whether the entry was ignored.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     match: SignedPatternMatch;
     /**
      * The matcher context.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     ctx: MatcherContext;
 };
 /**
  * @see {@link MatcherStream} uses it for the "dirent" event.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export type EntryListener = (info: EntryInfo) => void;
 /**
  * @see {@link MatcherStream} uses it for the "end" event.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export type EndListener = (ctx: MatcherContext) => void;
 /**
  * @see {@link MatcherStream} uses it for its event map.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export type EventMap = {
     dirent: [EntryInfo];
@@ -58,7 +58,7 @@ export type EventMap = {
  * Event emitter.
  * @extends EventEmitter
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export declare class MatcherStream extends EventEmitter<EventMap> {
 }

package/out/patterns/matcherStream.js

@@ -3,7 +3,7 @@ import { EventEmitter } from "node:events";
  * Event emitter.
  * @extends EventEmitter
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export class MatcherStream extends EventEmitter {
 }

package/out/patterns/packagejson.d.ts

@@ -4,6 +4,6 @@ import { type Source } from "./source.js";
  *
  * @see {@link signedPatternCompile}
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export declare function extractPackageJson(source: Source, content: Buffer): void | "none";

package/out/patterns/packagejson.js

@@ -12,7 +12,7 @@ const parse = type("string")
  *
  * @see {@link signedPatternCompile}
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export function extractPackageJson(source, content) {
     source.inverted = true;

package/out/patterns/pattern.d.ts

@@ -4,33 +4,33 @@
  * @see {@link stringCompile}
  * @see {@link signedPatternCompile}
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export type PatternMinimatch = {
     re: RegExp;
     /**
      * The original pattern string this minimatch was compiled from.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     pattern: string;
     /**
      * The original pattern list this pattern was compiled from.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     patternContext: Pattern;
 };
 /**
  * Safely calls RegExp.test.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export declare function patternMinimatchTest(pattern: PatternMinimatch, path: string): boolean;
 /**
  * Represents a list of positive minimatch patterns.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export type Pattern = string[];
 /**
@@ -39,6 +39,6 @@ export type Pattern = string[];
  * @see {@link stringCompile}
  * @see {@link signedPatternCompile}
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export declare function patternCompile(pattern: Pattern): PatternMinimatch[];

package/out/patterns/pattern.js

@@ -2,7 +2,7 @@ import { stringCompile } from "./stringCompile.js";
 /**
  * Safely calls RegExp.test.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export function patternMinimatchTest(pattern, path) {
     pattern.re.lastIndex = 0;
@@ -14,7 +14,7 @@ export function patternMinimatchTest(pattern, path) {
  * @see {@link stringCompile}
  * @see {@link signedPatternCompile}
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export function patternCompile(pattern) {
     return pattern.map(stringCompile);

package/out/patterns/patternMatcher.d.ts

@@ -4,20 +4,20 @@ import type { SignedPattern } from "./signedPattern.js";
  *
  * @see {@link signedPatternIgnores}
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export type PatternMatcher = {
     /**
      * Internal patterns are provided by the target.
      * Almost always they are predefined.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     internal: SignedPattern;
     /**
      * External patterns are sourced from existing project files at runtime.
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     external: SignedPattern;
 };

package/out/patterns/resolveSources.d.ts

@@ -7,13 +7,13 @@ import type { SignedPattern } from "./signedPattern.js";
  *
  * @see {@link patternCompile}
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export declare function signedPatternCompile(signedPattern: SignedPattern): SignedPattern;
 /**
  * @see {@link resolveSources}
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export interface ResolveSourcesOptions extends PatternFinderOptions {
     /**
@@ -22,13 +22,13 @@ export interface ResolveSourcesOptions extends PatternFinderOptions {
      * @example
      * "dir/subdir"
      *
-     * @since 0.0.6
+     * @since 0.6.0
      */
     dir: string;
 }
 /**
  * Populates the {@link MatcherContext.external} map with {@link Source} objects.
  *
- * @since 0.0.6
+ * @since 0.6.0
  */
 export declare function resolveSources(options: ResolveSourcesOptions): Promise<void>;