view-ignored 0.10.1 → 0.11.0

package/README.md

@@ -1,29 +1,52 @@
-# view-ignored
+<div align="center">
+<h1>view-ignored</h1>
 
-[![npm version](https://img.shields.io/npm/v/view-ignored.svg?style=flat)](https://www.npmjs.com/package/view-ignored)
-[![npm downloads](https://img.shields.io/npm/dm/view-ignored.svg?style=flat)](https://www.npmjs.com/package/view-ignored)
-[![github](https://img.shields.io/github/stars/Mopsgamer/view-ignored.svg?style=flat)](https://github.com/Mopsgamer/view-ignored)
-[![github issues](https://img.shields.io/github/issues/Mopsgamer/view-ignored.svg?style=flat)](https://github.com/Mopsgamer/view-ignored/issues)
+[![npm version](https://img.shields.io/npm/v/view-ignored.svg)](https://www.npmjs.com/package/view-ignored)
+[![npm downloads](https://img.shields.io/npm/dm/view-ignored.svg)](https://www.npmjs.com/package/view-ignored)
+![node-v-18-or-later](https://img.shields.io/badge/node->=18-salad?repo=Mopsgamer/view-ignored)
+[![speed-fast](https://img.shields.io/badge/speed-fast-salad?repo=Mopsgamer/view-ignored)](https://github.com/Mopsgamer/view-ignored/tree/main/benchmarks)
+
+[![github issues](https://img.shields.io/github/issues/Mopsgamer/view-ignored.svg)](https://github.com/Mopsgamer/view-ignored/issues)
+[![github](https://img.shields.io/github/stars/Mopsgamer/view-ignored.svg)](https://github.com/Mopsgamer/view-ignored)
 
 Retrieve list of files ignored/included
-by Git, NPM, Yarn, JSR, VSCE or other tools.
+by Git, NPM, Yarn, JSR, Deno, Bun, VSCode extension CLI and other tools.
+
+---
+
+### `view-ignored` scans for
+
+<img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/git/git-original.svg" width="32" height="32" alt="git" />
+<img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/npm/npm-original-wordmark.svg" width="32" height="32" alt="npm" />
+<img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/yarn/yarn-original.svg" width="32" height="32" alt="yarn" />
+<img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/bun/bun-original.svg" width="32" height="32" alt="bun" />
+<img src="https://unpkg.com/simple-icons@v14/icons/deno.svg" width="32" height="32" alt="deno" />
+<img src="https://jsr.io/logo.svg" width="32" height="32" alt="jsr" />
+<img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/vscode/vscode-original.svg" width="32" height="32" alt="vsce" />
 
-## Requirements
+and more!
 
-Node.js 18 or later
+[![issues](https://img.shields.io/github/issues-search?query=repo%3AMopsgamer%2Fview-ignored%20label%3Atargets%20type%3Aissue&label=issues)](https://github.com/search?q=repo%3AMopsgamer%2Fview-ignored+label%3Atargets+type%3Aissue&type=issues&query=repo%3AMopsgamer%2Fview-ignored+label%3Atargets)
+[![suggest](https://img.shields.io/badge/suggest-salad?repo=Mopsgamer/view-ignored)](https://github.com/Mopsgamer/view-ignored/issues/new)
+[![details](https://img.shields.io/badge/details-gray?repo=Mopsgamer/view-ignored)](#targets)
+
+</div>
 
 ## Highlights
 
+<!-- - **Faster alternative for `npm-packlist`, `ignore-walk` and `ignore`.** -->
+
 - **Reader.** Get a list of included files using configuration file
   readers, not command-line wrappers.
+- **Reasoning.** Understand why certain files are included or excluded.
+- **Fast.** Optimized for performance with minimal memory overhead.
 - **Plugins.** Built-in [targets](#targets) for popular tools. Use custom
   targets by implementing/extending the `Target` interface.
 - **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.
+- **Execution Control.** Use `fastDepth` and `fastInternal` options to fine-tune traversal depth and skip unnecessary directory checks. You can also enable them if you don't care about stats.
 - **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"`.
+- **Browser.** Can be bundled for browser use.
 - **Windows.** Windows paths are converted to Unix paths for compatibility with `memfs` based tests and browsers.
 
 > [!NOTE]
@@ -33,12 +56,32 @@ Node.js 18 or later
 > You can invert the results if you need the ignored files
 > by setting the `invert` option to `true`.
 
+## v1 Roadmap
+
+- [x] Works for common use cases.
+- [ ] Follow `.gitignore` spec. (`ignore` does.)
+- [ ] Handle Git config.
+- [ ] Include node_modules bundled dependencies correctly. Missing: NPM, Yarn + Classic, Bun, Deno, JSR.
+- [ ] \*Move targets into separate packages (or not).
+- [ ] Import and pass upstream source tests.
+- [ ] \*Make it standard: NPM cli, VS Code file tree, VSCE, GitHub.
+- [ ] \*Upstream to Bun, PNPM and other package managers.
+
+<sub>\* - Optional.</sub>
+
+## Why this library exists?
+
+Incorrect VS Code file tree git status, huge `npm-packlist` package, missing Git's wildmatch algorithm in JS ecosistem, and the fact that there's no lightweight way to get a list of ignored files, which would explain why specific files are being included or excluded.
+
 ## Usage
 
 ### Basic example
 
 ```ts
 import * as vign from "view-ignored"
+// also available:
+// "/scan", "/stream"
+// "/browser", "/browser/scan", "/browser/stream"
 import { Git as target } from "view-ignored/targets"
 
 const ctx = await vign.scan({ target })
@@ -54,7 +97,11 @@ if (match.kind === "external") {
 
 ### Using custom target
 
+This is the internal implementation for the Git target:
+
 ```ts
+import type { Target } from "view-ignored/targets"
+
 import {
 	type Extractor,
 	extractGitignore,
@@ -63,8 +110,6 @@ import {
 	type Rule,
 } from "view-ignored/patterns"
 
-import type { Target } from "view-ignored/targets"
-
 const extractors: Extractor[] = [
 	{
 		extract: extractGitignore,
@@ -78,38 +123,43 @@ const extractors: Extractor[] = [
 
 const internal: Rule[] = [
 	ruleCompile({
+		compiled: null,
 		excludes: true,
 		pattern: [".git", ".DS_Store"],
-		compiled: null,
 	}),
 ]
 
-export const Git: Target = {
-	internalRules: internal,
+export const Git: Target = <Target>{
 	extractors,
-	root: "/",
 	// TODO: Git should read configs
-	init() {},
 	ignores: ruleTest,
+	internalRules: internal,
+	root: "/",
 }
-
-const ctx = await vign.scan({ target })
 ```
 
 ### Streaming results
 
 ```ts
 import * as vign from "view-ignored"
+// or import * as vign from "view-ignored/stream"
 import { NPM as target } from "view-ignored/targets"
 
-const stream = await vign.scanStream({ target })
-
-stream.on("dirent", console.log)
-stream.on("end", (ctx) => {
-	ctx.paths.has(".git/HEAD") // false
-	ctx.paths.has("node_modules/") // false
-	ctx.paths.has("package.json") // true
-})
+const stream = vign.scanStream({ target })
+
+stream.addEventListener("dirent", console.log)
+stream.addEventListener(
+	"end",
+	(ctx) => {
+		ctx.paths.has(".git/HEAD")
+		// false
+		ctx.paths.has("node_modules/")
+		// false
+		ctx.paths.has("package.json")
+		// true
+	},
+	{ once: true },
+)
 stream.start() // important
 ```
 
@@ -124,14 +174,7 @@ import * as vign from "view-ignored/browser"
 import { Git as target } from "view-ignored/targets"
 
 export const cwd = process.cwd()
-
-const customFs = {
-	promises: {
-		opendir,
-		readFile,
-	},
-}
-
+const customFs = { readdir, readFile }
 vign.scan({ target, cwd, fs })
 ```
 
@@ -139,41 +182,52 @@ vign.scan({ target, cwd, fs })
 
 The following built-in scanners are available:
 
-- 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 `/`.
+- Git ([our implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/git.ts))
+  - `view-ignored` handles Git-specific ignoring almost identically to Git: does not consider config.
+  - Reads `.gitignore` and `.git/info/exclude`.
+  - Searches from `/`. (system's root)
   - Check this scanner by running `git ls-files --others --exclude-standard --cached`.
-- NPM ([implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/npm.ts))
-  - Expecting to be compatible with PNPM, and others.
-  - Validates `package.json`.
-  - Reads `package.json` `files` field, `.npmignore` and `.gitignore`.
-  - Starts searching from `.` (current working directory).
+- NPM ([our implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/npm.ts))
+  - `view-ignored` should be compatible with NPM, PNPM, and others.
+  - Reads `package.json` `files` field or `.npmignore` or `.gitignore`.
+  - Searches from `.` (current working directory).
+  - Requires `package.json`: `name`, `version`.
   - Check this scanner by running `npm pack --dry-run`.
-- Bun ([implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/bun.ts))
+- Bun ([our 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.
+  - Searches from `.` (current working directory).
+  - Requires `package.json`: `name`, `version`. Forces paths from `bin` to be included.
   - 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.
-  - Validates `package.json`.
-  - 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).
-  - `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))
-  - Validates `package.json`.
-  - Reads `package.json` `files` field, `.vscodeignore` and `.gitignore`.
-  - Starts searching from `.` (current working directory).
+- Yarn ([our implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/yarn.ts))
+  - Modern Berry and ZPM behavior. `YarnClassic` is available. ([our implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/yarnClassic.ts))
+  - Reads `package.json` `files` field or `.npmignore` or `.gitignore`.
+  - Searches from `.` (current working directory).
+  - Requires `package.json`: `name`, `version`. Forces paths from `main`, `module`, `browser` and `bin` to be included.
+- VSCE ([our implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/vsce.ts))
+  - Reads `package.json` `files` field or `.vscodeignore` or `.gitignore`.
+  - Searches from `.` (current working directory).
+  - Requires `package.json`: `name`, `version`, `engines.vscode`.
   - Check this scanner by running `vsce ls`.
-- JSR ([implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/jsr.ts))
-  - Validates and 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))
-  - Validates and reads `jsr.json(c)` and `deno.json(c)` `include` and `exclude` fields.
-  - Starts searching from `.` (current working directory).
+- JSR ([our implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/jsr.ts))
+  - Searches from `.` (current working directory).
+  - Requires `jsr.json` or `jsr.jsonc`.
+  - Validates `publish.include` and `publish.exclude` or `include` and `exclude` fields.
+- Deno ([our implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/deno.ts))
+  - Searches from `.` (current working directory).
+  - Requires `jsr.json` or `jsr.jsonc` or `deno.json` or `deno.jsonc`.
+  - Validates `publish.include` and `publish.exclude` or `include` and `exclude` fields.
 
 ## See also
 
+- There are references in our implementations.
 - https://jsr.io/@m234/path - Utility to sort, convert and format paths.
+- https://github.com/git/git/blob/master/wildmatch.c - The original wildmatch implementation.
+- https://npmx.dev/package/ignore-walk - A Node.js module for walking directories while respecting ignore files. (It does it incorrectly for Git).
+- https://npmx.dev/package/npm-packlist - A Node.js module for listing files to be included in an npm package. (Heavy)
+
+## Benchmarks
+
+See [benchmarks directory](https://github.com/Mopsgamer/view-ignored/tree/main/benchmarks).
 
 ## License
 

package/out/browser.d.ts

@@ -1,3 +1,4 @@
 export { scan } from "./browser_scan.js";
+export { scanCb } from "./scanCb.js";
 export { scanStream as stream } from "./browser_stream.js";
 export type * from "./types.js";

package/out/browser.js

@@ -1,2 +1,3 @@
 export { scan } from "./browser_scan.js";
+export { scanCb } from "./scanCb.js";
 export { scanStream as stream } from "./browser_stream.js";

package/out/browser_scan.d.ts

@@ -1,13 +1,11 @@
 import type { MatcherContext } from "./patterns/matcherContext.js";
 import type { ScanOptions, FsAdapter } from "./types.js";
+export { scanCb } from "./scanCb.js";
 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
- * 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.
  *
  * @param options Scan options.
  * @returns A promise that resolves to a {@link MatcherContext} containing the scan results.

package/out/browser_scan.js

@@ -1,13 +1,9 @@
-import { opendir } from "./opendir.js";
-import { unixify, join } from "./unixify.js";
-import { walkIncludes } from "./walk.js";
+import { scanCb } from "./scanCb.js";
+export { scanCb } from "./scanCb.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
- * 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.
  *
  * @param options Scan options.
  * @returns A promise that resolves to a {@link MatcherContext} containing the scan results.
@@ -15,44 +11,13 @@ import { walkIncludes } from "./walk.js";
  * @since 0.6.0
  */
 export function scan(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");
-    }
-    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,
-    };
-    return (async () => {
-        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,
-            });
-        });
-        return ctx;
-    })();
+    const { promise, resolve, reject } = Promise.withResolvers();
+    scanCb(options, (err, ctx) => {
+        if (err) {
+            reject(err);
+            return;
+        }
+        resolve(ctx);
+    });
+    return promise;
 }

package/out/browser_stream.d.ts

@@ -2,7 +2,12 @@ import type { ScanOptions, FsAdapter } from "./types.js";
 import { MatcherStream } from "./patterns/matcherStream.js";
 export type * from "./types.js";
 /**
- * @see {@link browserScan}
+ * Scan the directory for included files based on the provided targets.
+ *
+ * It also normalizes paths to use forward slashes.
+ *
+ * @param options Scan options.
+ * @returns A stream containing the scan results.
  *
  * @since 0.6.0
  */

package/out/browser_stream.js

@@ -1,6 +1,11 @@
 import { MatcherStream } from "./patterns/matcherStream.js";
 /**
- * @see {@link browserScan}
+ * Scan the directory for included files based on the provided targets.
+ *
+ * It also normalizes paths to use forward slashes.
+ *
+ * @param options Scan options.
+ * @returns A stream containing the scan results.
  *
  * @since 0.6.0
  */

package/out/index.d.ts

@@ -1,3 +1,4 @@
 export { scan } from "./scan.js";
+export { scanCb } from "./scanCb.js";
 export { scanStream } from "./stream.js";
 export type * from "./types.js";

package/out/index.js

@@ -1,2 +1,3 @@
 export { scan } from "./scan.js";
+export { scanCb } from "./scanCb.js";
 export { scanStream } from "./stream.js";

package/out/patterns/extractor.d.ts

@@ -1,18 +1,18 @@
 import type { Target } from "../targets/target.js";
 import type { FsAdapter } from "../types.js";
-import type { MatcherContext } from "./matcherContext.js";
+import type { Resource } from "./resource.js";
 import type { Source } from "./source.js";
 /**
  * Populates the source object from the content of a source file.
  * Results are available in `ctx.external`.
- * If `"none"` returned or throwed, will skip the extractor.
+ * If `null` returned or throwed, will skip the extractor.
  *
- * @see {@link Source.pattern} for more details.
+ * @see {@link Source.rules} for more details.
  * @throws Error if extraction fails. Processing stops.
  *
  * @since 0.6.0
  */
-export type ExtractorFn = (source: Source, content: Buffer, ctx: MatcherContext) => void | "none";
+export type ExtractorFn = (source: Source, content: Buffer) => void | null | Error;
 /**
  * Defines a method for extracting patterns from a specific source file.
  *
@@ -53,11 +53,11 @@ export interface PatternFinderOptions {
      */
     fs: FsAdapter;
     /**
-     * The context to modify.
+     * The associated resource.
      *
-     * @since 0.6.0
+     * @since 0.11.0
      */
-    ctx: MatcherContext;
+    resource?: Resource;
     /**
      * The current working directory.
      *

package/out/patterns/gitignore.d.ts

@@ -6,7 +6,7 @@ import { type Source } from "./source.js";
  *
  * @since 0.6.0
  */
-export declare function extractGitignore(source: Source, content: Buffer): void;
+export declare function extractGitignore(source: Source, content: Buffer): void | Error;
 /**
  * Extracts and compiles patterns from the file.
  *
@@ -14,4 +14,4 @@ export declare function extractGitignore(source: Source, content: Buffer): void;
  *
  * @since 0.8.0
  */
-export declare function extractGitignoreNocase(source: Source, content: Buffer): void;
+export declare function extractGitignoreNocase(source: Source, content: Buffer): void | Error;

package/out/patterns/gitignore.js

@@ -9,7 +9,7 @@ import { resolveNegatable } from "./source.js";
  */
 export function extractGitignore(source, content) {
     extract(source, content);
-    for (const element of source.pattern) {
+    for (const element of source.rules) {
         ruleCompile(element);
     }
 }
@@ -22,7 +22,7 @@ export function extractGitignore(source, content) {
  */
 export function extractGitignoreNocase(source, content) {
     extract(source, content);
-    for (const element of source.pattern) {
+    for (const element of source.rules) {
         ruleCompile(element, { nocase: true });
     }
 }
@@ -30,16 +30,24 @@ extractGitignore;
 function extract(source, content) {
     const include = { compiled: null, excludes: false, pattern: [] };
     const exclude = { compiled: null, excludes: true, pattern: [] };
-    for (let line of content.toString().split("\n")) {
-        line = line.trim();
+    let start = 0;
+    while (start < content.length) {
+        let end = content.indexOf(0x0a, start);
+        if (end === -1)
+            end = content.length;
+        // Convert only the current line to a string
+        let line = content.toString("utf8", start, end).trim();
+        start = end + 1;
         if (line === "" || line.startsWith("#")) {
             continue;
         }
         const cdx = line.indexOf("#");
         if (cdx >= 0) {
-            line = line.substring(-cdx);
+            line = line.slice(0, cdx).trim();
+            if (line === "")
+                continue;
         }
         resolveNegatable(line, false, include, exclude);
     }
-    source.pattern.push(include, exclude);
+    source.rules.push(include, exclude);
 }

package/out/patterns/ignores.d.ts

@@ -1,7 +1,8 @@
 import type { InitState } from "./initState.js";
+import type { Resource } from "./resource.js";
 import type { RuleMatch } from "./rule.js";
 /**
- * Used in {@link Ignores}.
+ * Used in {@link IgnoresCb}.
  *
  * @since 0.6.0
  */
@@ -12,6 +13,18 @@ export interface IgnoresOptions extends InitState {
      * @since 0.6.0
      */
     entry: string;
+    /**
+     * Pre-lowercased entry path.
+     *
+     * @since 0.11.1
+     */
+    lowerEntry?: string;
+    /**
+     * The associated resource.
+     *
+     * @since 0.11.0
+     */
+    resource: Resource;
     /**
      * Result of the `dirname(entry)` call.
      *
@@ -20,12 +33,8 @@ export interface IgnoresOptions extends InitState {
     parentPath: string;
 }
 /**
- * Checks whether a given entry path should be ignored based on its patterns.
+ * @see {@link IgnoresCb}
  *
- * @see {@link resolveSources}
- * @see {@link ruleTest}
- * @see {@link https://github.com/Mopsgamer/view-ignored/tree/main/src/targets} for usage examples.
- *
- * @since 0.6.0
+ * @since 0.11.0
  */
-export type Ignores = (options: IgnoresOptions) => Promise<RuleMatch>;
+export type IgnoresCb = (options: IgnoresOptions, cb: (err: Error | null, match: RuleMatch) => void) => void;

package/out/patterns/index.d.ts

@@ -10,6 +10,7 @@ export * from "./matcherStream.js";
 export * from "./packagejson.js";
 export * from "./patternList.js";
 export * from "./resolveSources.js";
+export * from "./resource.js";
 export * from "./rule.js";
 export * from "./source.js";
 export * from "./patternCompile.js";

package/out/patterns/index.js

@@ -10,6 +10,7 @@ export * from "./matcherStream.js";
 export * from "./packagejson.js";
 export * from "./patternList.js";
 export * from "./resolveSources.js";
+export * from "./resource.js";
 export * from "./rule.js";
 export * from "./source.js";
 export * from "./patternCompile.js";

package/out/patterns/init.d.ts

@@ -4,6 +4,6 @@ import type { InitState } from "./initState.js";
  * Yarn reads `package.json` to find `main` and `bin` values,
  * so it can forcefully include them.
  *
- * @since 0.8.0
+ * @since 0.11.0
  */
-export type Init = (options: InitState) => Promise<void>;
+export type InitCb = (options: InitState, cb: (err?: Error | null) => void) => void;

package/out/patterns/initState.d.ts

@@ -1,6 +1,5 @@
 import type { Target } from "../targets/target.js";
 import type { FsAdapter } from "../types.js";
-import type { MatcherContext } from "./matcherContext.js";
 /**
  * Used in {@link IgnoresOptions}.
  *
@@ -17,12 +16,6 @@ export interface InitState {
      * @since 0.6.0
      */
     cwd: string;
-    /**
-     * The context to populate.
-     *
-     * @since 0.6.0
-     */
-    ctx: MatcherContext;
     /**
      * The target implementation.
      *

package/out/patterns/jsrjson.d.ts

@@ -1,11 +1,10 @@
-import type { MatcherContext } from "./matcherContext.js";
 import { type Source } from "./source.js";
 /**
  * Extracts and compiles patterns from the file.
  *
  * @since 0.6.0
  */
-export declare function extractJsrJson(source: Source, content: Buffer, ctx: MatcherContext): void;
+export declare function extractJsrJson(source: Source, content: Buffer): void | Error;
 /**
  * Extracts and compiles patterns from the file.
  *
@@ -13,4 +12,4 @@ export declare function extractJsrJson(source: Source, content: Buffer, ctx: Mat
  *
  * @since 0.6.0
  */
-export declare function extractJsrJsonc(source: Source, content: Buffer, ctx: MatcherContext): void;
+export declare function extractJsrJsonc(source: Source, content: Buffer): void | Error;