view-ignored 0.9.1 → 0.10.0

package/out/patterns/resolveSources.js

@@ -1,17 +1,17 @@
 import { dirname } from "node:path";
-import { unixify, relative, join } from "../unixify.js";
-import { patternCompile } from "./pattern.js";
+import { join, base } from "../unixify.js";
+import { patternListCompile } from "./patternList.js";
 /**
- * Compiles the {@link SignedPattern} (forced).
+ * Compiles the {@link Rule} (forced).
  * Can be compiled at any time.
  * Extractors are compiling it.
  *
- * @see {@link patternCompile}
+ * @see {@link patternListCompile}
  *
  * @since 0.6.0
  */
-export function signedPatternCompile(signedPattern, options) {
-    signedPattern.compiled = patternCompile(signedPattern.pattern, options);
+export function ruleCompile(signedPattern, options) {
+    signedPattern.compiled = patternListCompile(signedPattern.pattern, options);
     return signedPattern;
 }
 /**
@@ -20,7 +20,7 @@ export function signedPatternCompile(signedPattern, options) {
  * @since 0.6.0
  */
 export async function resolveSources(options) {
-    const { fs, ctx, cwd, target, root, signal } = options;
+    const { fs, ctx, cwd, signal, target } = options;
     let dir = options.dir;
     if (ctx.external.has(dir)) {
         return;
@@ -42,7 +42,7 @@ export async function resolveSources(options) {
             }
             noSourceDirList.push(dir);
             const parent = dirname(dir);
-            if (dir === dir)
+            if (dir === parent)
                 break;
             dir = parent;
             continue;
@@ -50,25 +50,25 @@ export async function resolveSources(options) {
     }
     // else
     // find non-cwd source [root > cwd) and populate [cwd > ... > dir]
-    // root, root/cwd[0], root/cwd[0]/cwd[2]
     const preCwdSegments = [];
-    {
+    if (target.root.startsWith("/")) {
         let c = dirname(cwd);
         while (true) {
             signal?.throwIfAborted();
             preCwdSegments.push(c);
-            if (c === "/" || c === root)
+            if (c === target.root)
                 break;
             const parent = dirname(c);
             c = parent;
         }
         preCwdSegments.reverse();
-    }
-    source = await findSourceForAbsoluteDirs(preCwdSegments, ctx, fs, target, signal);
-    if (typeof source === "object") {
-        for (const noSourceDir of noSourceDirList) {
-            signal?.throwIfAborted();
-            ctx.external.set(noSourceDir, source);
+        source = await findSourceForAbsoluteDirs(preCwdSegments, ctx, fs, target, signal);
+        if (typeof source === "object") {
+            for (const noSourceDir of noSourceDirList) {
+                signal?.throwIfAborted();
+                ctx.external.set(noSourceDir, source);
+            }
+            return;
         }
     }
     const absPaths = noSourceDirList.map((rel) => join(cwd, rel));
@@ -97,18 +97,11 @@ async function findSourceForAbsoluteDirs(paths, ctx, fs, target, signal) {
     return "none";
 }
 async function tryExtractor(cwd, fs, ctx, extractor) {
-    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);
+    let abs = join(cwd, extractor.path);
+    const name = base(extractor.path);
     const newSource = {
         name,
-        path,
+        path: extractor.path,
         inverted: false,
         pattern: [],
     };

package/out/patterns/rule.d.ts

@@ -0,0 +1,115 @@
+import type { PatternFinderOptions } from "./extractor.js";
+import type { Source } from "./source.js";
+import { type PatternList, type PatternCache } from "./patternList.js";
+/**
+ * Represents a set of include and exclude patterns.
+ * These patterns are positive minimatch patterns.
+ *
+ * @see {@link ruleTest} provides the ignoring algorithm.
+ * @see {@link ruleCompile} compiles the signed pattern.
+ * Use this or an extractor's method to compile.
+ *
+ * @since 0.6.0
+ */
+export type Rule = {
+    /**
+     * Provides ignored or included file and directory patterns.
+     *
+     * @see {@link ruleTest} provides the ignoring algorithm.
+     *
+     * @since 0.9.0
+     */
+    pattern: PatternList;
+    /**
+     * If `true`, pattern "test" will exclude file named "test".
+     *
+     * @see {@link ruleTest} provides the ignoring algorithm.
+     *
+     * @since 0.9.0
+     */
+    excludes: boolean;
+    /**
+     * Provides compiled ignored or included file and directory patterns.
+     *
+     * @see {@link ruleTest} provides the ignoring algorithm.
+     *
+     * @since 0.6.0
+     */
+    compiled: null | PatternCache[];
+};
+/**
+ * The kind of a pattern match.
+ *
+ * @since 0.9.1
+ */
+export type MatchKind = RuleMatch["kind"];
+/**
+ * @see {@link RuleMatch}
+ *
+ * @since 0.9.1
+ */
+export interface RuleMatchBase<K extends string> {
+    kind: K;
+    ignored: boolean;
+}
+/**
+ * @see {@link RuleMatch}
+ *
+ * @since 0.9.1
+ */
+export interface RuleMatchBaseSource<K extends string> extends RuleMatchBase<K> {
+    source: Source;
+}
+/**
+ * @see {@link RuleMatch}
+ *
+ * @since 0.9.1
+ */
+export interface RuleMatchBasePattern<K extends string> extends RuleMatchBase<K> {
+    pattern: string;
+}
+/**
+ * @see {@link RuleMatch}
+ *
+ * @since 0.9.1
+ */
+export interface RuleMatchBaseErrorPattern<K extends string> extends RuleMatchBasePattern<K> {
+    error: Error;
+}
+/**
+ * @see {@link RuleMatch}
+ *
+ * @since 0.9.1
+ */
+export interface RuleMatchBaseSourcePattern<K extends string> extends RuleMatchBasePattern<K>, RuleMatchBaseSource<K> {
+}
+/**
+ * @see {@link ruleTest}
+ *
+ * @since 0.6.0
+ */
+export type RuleMatch = RuleMatchBase<"none" | "missing-source"> | RuleMatchBaseSource<"no-match" | "broken-source" | "invalid-pattern"> | RuleMatchBaseErrorPattern<"invalid-internal-pattern"> | RuleMatchBasePattern<"internal"> | RuleMatchBaseSourcePattern<"external">;
+/**
+ * @see {@link ruleTest}
+ *
+ * @since 0.6.0
+ */
+export interface RuleTestOptions extends PatternFinderOptions {
+    /**
+     * Relative entry path.
+     *
+     * @example
+     * "dir/subdir"
+     * "dir/subdir/index.js"
+     *
+     * @since 0.6.0
+     */
+    entry: string;
+}
+/**
+ * Checks whether a given entry should be ignored based on internal and external patterns.
+ * Populates unknown sources using {@link resolveSources}.
+ *
+ * @since 0.6.0
+ */
+export declare function ruleTest(options: RuleTestOptions): Promise<RuleMatch>;

package/out/patterns/{signedPattern.js → rule.js}

@@ -1,10 +1,10 @@
 import { dirname } from "node:path/posix";
-import { patternMinimatchTest } from "./pattern.js";
+import { patternCacheTest } from "./patternList.js";
 import { resolveSources } from "./resolveSources.js";
-function patternRegExpTest(path, rs) {
+function cacheTest(rs, path) {
     for (const r of rs) {
         try {
-            if (patternMinimatchTest(r, path)) {
+            if (patternCacheTest(r, path)) {
                 return [r.pattern, undefined];
             }
         }
@@ -14,12 +14,12 @@ function patternRegExpTest(path, rs) {
     }
     return ["", undefined];
 }
-function signedPatternCompiledMatchInternal(options, path) {
-    for (const si of options.internal) {
+function testInternal(options, path) {
+    for (const si of options.target.internalRules) {
         const compiled = si.compiled;
         if (compiled === null)
             continue;
-        let [patternMatch, error] = patternRegExpTest(path, compiled);
+        let [patternMatch, error] = cacheTest(compiled, path);
         if (error)
             return {
                 kind: "invalid-internal-pattern",
@@ -36,13 +36,13 @@ function signedPatternCompiledMatchInternal(options, path) {
     }
     return null;
 }
-function signedPatternCompiledMatchExternal(options, path, source) {
+function testExternal(options, path, source) {
     for (const si of source.pattern) {
         const compiled = si.compiled;
         if (compiled === null) {
             continue;
         }
-        let [patternMatch, err] = patternRegExpTest(path, compiled);
+        let [patternMatch, err] = cacheTest(compiled, path);
         if (err) {
             source.error = err;
             options.ctx?.failed.push(source);
@@ -72,23 +72,26 @@ function signedPatternCompiledMatchExternal(options, path, source) {
  *
  * @since 0.6.0
  */
-export async function signedPatternIgnores(options) {
+export async function ruleTest(options) {
     const parent = dirname(options.entry);
     let source = options.ctx?.external.get(parent);
     if (source === undefined) {
-        await resolveSources({ ...options, dir: parent, root: options.root });
+        await resolveSources({ ...options, dir: parent });
         source = options.ctx.external.get(parent);
     }
-    if (source === undefined || source === "none") {
+    if (source === undefined) {
+        throw new Error("view-ignored has crashed: no source cached.");
+    }
+    if (source === "none") {
         return { kind: "missing-source", ignored: false };
     }
     if (typeof source === "object" && source.error) {
         return { kind: "broken-source", ignored: true, source };
     }
-    let internalMatch = signedPatternCompiledMatchInternal(options, options.entry);
+    let internalMatch = testInternal(options, options.entry);
     if (internalMatch !== null) {
         return internalMatch;
     }
-    const externalMatch = signedPatternCompiledMatchExternal(options, options.entry, source);
+    const externalMatch = testExternal(options, options.entry, source);
     return externalMatch;
 }

package/out/patterns/source.d.ts

@@ -1,4 +1,4 @@
-import type { SignedPattern } from "./signedPattern.js";
+import type { Rule } from "./rule.js";
 /**
  * Represents a source of external patterns.
  *
@@ -9,11 +9,11 @@ export type Source = {
      * Patterns defined within the source file.
      * Those patterns are for ignoring files.
      *
-     * @see {@link signedPatternIgnores}
+     * @see {@link ruleTest}
      *
      * @since 0.6.0
      */
-    pattern: SignedPattern[];
+    pattern: Rule[];
     /**
      * Name of the source file.
      *
@@ -31,7 +31,7 @@ export type Source = {
      * For example, `package.json` `files` field inverts the matching logic,
      * because it specifies files to include rather than exclude.
      *
-     * @see {@link signedPatternIgnores}
+     * @see {@link ruleTest}
      *
      * @since 0.6.0
      */
@@ -46,10 +46,13 @@ export type Source = {
     error?: Error;
 };
 /**
- * Adds a negatable pattern to the source's pattern lists.
+ * Adds a negatable pattern to the source's rules.
  * Strips the leading '!' for include patterns,
  * and adds to exclude patterns otherwise.
  *
+ * Expecting the rules
+ * to be added into the source and then compiled.
+ *
  * @since 0.6.0
  */
-export declare function sourcePushNegatable(pattern: string, invert: boolean, include: SignedPattern, exclude: SignedPattern): void;
+export declare function resolveNegatable(pattern: string, invert: boolean, include: Rule, exclude: Rule): void;

package/out/patterns/source.js

@@ -1,11 +1,14 @@
 /**
- * Adds a negatable pattern to the source's pattern lists.
+ * Adds a negatable pattern to the source's rules.
  * Strips the leading '!' for include patterns,
  * and adds to exclude patterns otherwise.
  *
+ * Expecting the rules
+ * to be added into the source and then compiled.
+ *
  * @since 0.6.0
  */
-export function sourcePushNegatable(pattern, invert, include, exclude) {
+export function resolveNegatable(pattern, invert, include, exclude) {
     if (invert) {
         ;
         [exclude, include] = [include, exclude];

package/out/targets/bun.js

@@ -1,5 +1,5 @@
 import { type } from "arktype";
-import { signedPatternIgnores, signedPatternCompile, extractPackageJson, extractGitignore, } from "../patterns/index.js";
+import { ruleTest, ruleCompile, extractPackageJson, extractGitignore, } from "../patterns/index.js";
 import { join, unixify } from "../unixify.js";
 import { npmManifestParse } from "./npmManifest.js";
 const extractors = [
@@ -23,7 +23,7 @@ const internalInclude = {
 };
 const internal = [
     internalInclude,
-    signedPatternCompile({
+    ruleCompile({
         excludes: true,
         pattern: [
             // https://github.com/oven-sh/bun/blob/main/src/cli/pack_command.zig#L180
@@ -60,7 +60,7 @@ const internal = [
         ],
         compiled: null,
     }), // nocase should be false here
-    signedPatternCompile({
+    ruleCompile({
         excludes: true,
         pattern: [
             // https://github.com/oven-sh/bun/blob/main/src/cli/pack_command.zig#L2586
@@ -80,6 +80,9 @@ const internal = [
  * @since 0.8.1
  */
 export const Bun = {
+    internalRules: internal,
+    extractors,
+    root: ".",
     async init({ fs, cwd }) {
         let content;
         const normalCwd = unixify(cwd);
@@ -109,15 +112,7 @@ export const Bun = {
         // nothing else
         // link zig code
         internalInclude.pattern = Array.from(set);
-        signedPatternCompile(internalInclude, { nocase: true });
-    },
-    extractors,
-    ignores(o) {
-        return signedPatternIgnores({
-            ...o,
-            internal,
-            root: ".",
-            target: Bun,
-        });
+        ruleCompile(internalInclude, { nocase: true });
     },
+    ignores: ruleTest,
 };

package/out/targets/deno.js

@@ -1,5 +1,5 @@
 import { type } from "arktype";
-import { signedPatternIgnores, signedPatternCompile, extractJsrJson, extractJsrJsonc, extractPackageJson, } from "../patterns/index.js";
+import { ruleTest, ruleCompile, extractJsrJson, extractJsrJsonc, extractPackageJson, } from "../patterns/index.js";
 import { unixify } from "../unixify.js";
 import { jsrManifestParse } from "./jsrManifest.js";
 const extractors = [
@@ -25,7 +25,7 @@ const extractors = [
     },
 ];
 const internal = [
-    signedPatternCompile({
+    ruleCompile({
         excludes: true,
         pattern: [".git", ".DS_Store"],
         compiled: null,
@@ -35,6 +35,9 @@ const internal = [
  * @since 0.8.1
  */
 export const Deno = {
+    internalRules: internal,
+    extractors,
+    root: ".",
     async init({ fs, cwd }) {
         let content;
         const normalCwd = unixify(cwd);
@@ -58,13 +61,5 @@ export const Deno = {
             throw new Error("Invalid '" + path + "': " + dist.summary, { cause: dist });
         }
     },
-    extractors,
-    ignores(o) {
-        return signedPatternIgnores({
-            ...o,
-            internal,
-            root: ".",
-            target: Deno,
-        });
-    },
+    ignores: ruleTest,
 };

package/out/targets/git.js

@@ -1,4 +1,4 @@
-import { extractGitignore, signedPatternIgnores, signedPatternCompile, } from "../patterns/index.js";
+import { extractGitignore, ruleTest, ruleCompile, } from "../patterns/index.js";
 const extractors = [
     {
         extract: extractGitignore,
@@ -10,7 +10,7 @@ const extractors = [
     },
 ];
 const internal = [
-    signedPatternCompile({
+    ruleCompile({
         excludes: true,
         pattern: [".git", ".DS_Store"],
         compiled: null,
@@ -20,14 +20,9 @@ const internal = [
  * @since 0.6.0
  */
 export const Git = {
-    // TODO: Git should read configs
+    internalRules: internal,
     extractors,
-    ignores(o) {
-        return signedPatternIgnores({
-            ...o,
-            internal,
-            root: "/",
-            target: Git,
-        });
-    },
+    root: "/",
+    // TODO: Git should read configs
+    ignores: ruleTest,
 };

package/out/targets/jsr.js

@@ -1,5 +1,5 @@
 import { type } from "arktype";
-import { signedPatternIgnores, signedPatternCompile, extractJsrJson, extractJsrJsonc, } from "../patterns/index.js";
+import { ruleTest, ruleCompile, extractJsrJson, extractJsrJsonc, } from "../patterns/index.js";
 import { unixify } from "../unixify.js";
 import { jsrManifestParse } from "./jsrManifest.js";
 const extractors = [
@@ -13,7 +13,7 @@ const extractors = [
     },
 ];
 const internal = [
-    signedPatternCompile({
+    ruleCompile({
         excludes: true,
         pattern: [".git", ".DS_Store"],
         compiled: null,
@@ -23,6 +23,9 @@ const internal = [
  * @since 0.6.0
  */
 export const JSR = {
+    internalRules: internal,
+    extractors,
+    root: ".",
     async init({ fs, cwd }) {
         let content;
         const normalCwd = unixify(cwd);
@@ -46,13 +49,5 @@ export const JSR = {
             throw new Error("Invalid '" + path + "': " + dist.summary, { cause: dist });
         }
     },
-    extractors,
-    ignores(o) {
-        return signedPatternIgnores({
-            ...o,
-            internal,
-            root: ".",
-            target: JSR,
-        });
-    },
+    ignores: ruleTest,
 };

package/out/targets/npm.js

@@ -1,5 +1,5 @@
 import { type } from "arktype";
-import { signedPatternIgnores, signedPatternCompile, extractPackageJson, extractGitignore, } from "../patterns/index.js";
+import { ruleTest, ruleCompile, extractPackageJson, extractGitignore, } from "../patterns/index.js";
 import { unixify } from "../unixify.js";
 import { npmManifestParse } from "./npmManifest.js";
 const extractors = [
@@ -23,7 +23,7 @@ const internalInclude = {
 };
 const internal = [
     internalInclude,
-    signedPatternCompile({
+    ruleCompile({
         excludes: true,
         pattern: [
             // https://github.com/npm/npm-packlist/blob/main/lib/index.js#L16
@@ -56,7 +56,7 @@ const internal = [
         ],
         compiled: null,
     }),
-    signedPatternCompile({
+    ruleCompile({
         excludes: false,
         pattern: [
             // https://github.com/npm/npm-packlist/blob/main/lib/index.js#L287
@@ -78,6 +78,9 @@ const internal = [
  * @since 0.6.0
  */
 export const NPM = {
+    internalRules: internal,
+    extractors,
+    root: ".",
     async init({ fs, cwd }) {
         let content;
         const normalCwd = unixify(cwd);
@@ -94,15 +97,7 @@ export const NPM = {
         // const set = new Set<string>()
         // TODO: NPM should include bundled deps
         // internalInclude.pattern = Array.from(set)
-        // signedPatternCompile(internalInclude, { nocase: true })
-    },
-    extractors,
-    ignores(o) {
-        return signedPatternIgnores({
-            ...o,
-            internal,
-            root: ".",
-            target: NPM,
-        });
+        // ruleCompile(internalInclude, { nocase: true })
     },
+    ignores: ruleTest,
 };

package/out/targets/target.d.ts

@@ -1,12 +1,26 @@
 import type { Extractor } from "../patterns/extractor.js";
 import type { Ignores } from "../patterns/ignores.js";
 import type { Init } from "../patterns/init.js";
+import type { Rule } from "../patterns/rule.js";
 /**
  * Contains the matcher used for scanning.
  *
  * @since 0.6.0
  */
 export interface Target {
+    /**
+     * Should be compiled.
+     *
+     * @since 0.10.0
+     */
+    internalRules: Rule[];
+    /**
+     * Initial search directory.
+     * Relative to the `cwd` path or absolute path.
+     *
+     * @since 0.10.0
+     */
+    root: string;
     /**
      * The set of extractors.
      * Required for context-patching APIs (ctx add/remove path).

package/out/targets/vsce.js

@@ -1,5 +1,5 @@
 import { type } from "arktype";
-import { signedPatternIgnores, signedPatternCompile, extractPackageJson, extractGitignore, } from "../patterns/index.js";
+import { ruleTest, ruleCompile, extractPackageJson, extractGitignore, } from "../patterns/index.js";
 import { unixify } from "../unixify.js";
 import { npmManifest } from "./npmManifest.js";
 const extractors = [
@@ -17,7 +17,7 @@ const extractors = [
     },
 ];
 const internal = [
-    signedPatternCompile({
+    ruleCompile({
         excludes: true,
         pattern: [
             // https://github.com/microsoft/vscode-vsce/blob/main/src/package.ts#L1633
@@ -69,6 +69,9 @@ const vsceManifestParse = type("string")
  * @since 0.6.0
  */
 export const VSCE = {
+    internalRules: internal,
+    extractors,
+    root: ".",
     async init({ fs, cwd }) {
         let content;
         const normalCwd = unixify(cwd);
@@ -83,13 +86,5 @@ export const VSCE = {
             throw new Error("Invalid 'package.json': " + dist.summary, { cause: dist });
         }
     },
-    extractors,
-    ignores(o) {
-        return signedPatternIgnores({
-            ...o,
-            internal,
-            root: ".",
-            target: VSCE,
-        });
-    },
+    ignores: ruleTest,
 };