view-ignored 0.8.1 → 0.9.1

package/README.md

@@ -146,28 +146,30 @@ The following built-in scanners are available:
   - 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).
-  - No additional checks for `name`, `version` or `publishConfig`.
   - Check this scanner by running `npm pack --dry-run`.
 - 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.
+  - 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).
   - Check this scanner by running `vsce ls`.
 - JSR ([implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/jsr.ts))
-  - Reads `jsr.json(c)` `include` and `exclude` fields.
+  - 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))
-  - Reads `jsr.json(c)` and `deno.json(c)` `include` and `exclude` fields.
+  - Validates and reads `jsr.json(c)` and `deno.json(c)` `include` and `exclude` fields.
   - Starts searching from `.` (current working directory).
 
 ## See also

package/out/browser_stream.d.ts

@@ -1,5 +1,5 @@
-import { MatcherStream } from "./patterns/matcherStream.js";
 import type { ScanOptions, FsAdapter } from "./types.js";
+import { MatcherStream } from "./patterns/matcherStream.js";
 export type * from "./types.js";
 /**
  * @see {@link browserScan}

package/out/patterns/gitignore.js

@@ -9,7 +9,9 @@ import { sourcePushNegatable } from "./source.js";
  */
 export function extractGitignore(source, content) {
     extract(source, content);
-    signedPatternCompile(source.pattern);
+    for (const element of source.pattern) {
+        signedPatternCompile(element);
+    }
 }
 /**
  * Extracts and compiles patterns from the file.
@@ -20,10 +22,14 @@ export function extractGitignore(source, content) {
  */
 export function extractGitignoreNocase(source, content) {
     extract(source, content);
-    signedPatternCompile(source.pattern, { nocase: true });
+    for (const element of source.pattern) {
+        signedPatternCompile(element, { nocase: true });
+    }
 }
 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();
         if (line === "" || line.startsWith("#")) {
@@ -33,6 +39,7 @@ function extract(source, content) {
         if (cdx >= 0) {
             line = line.substring(-cdx);
         }
-        sourcePushNegatable(source, line);
+        sourcePushNegatable(line, false, include, exclude);
     }
+    source.pattern.push(include, exclude);
 }

package/out/patterns/index.d.ts

@@ -9,7 +9,6 @@ export * from "./matcherContextPatch.js";
 export * from "./matcherStream.js";
 export * from "./packagejson.js";
 export * from "./pattern.js";
-export * from "./patternMatcher.js";
 export * from "./resolveSources.js";
 export * from "./signedPattern.js";
 export * from "./source.js";

package/out/patterns/index.js

@@ -9,7 +9,6 @@ export * from "./matcherContextPatch.js";
 export * from "./matcherStream.js";
 export * from "./packagejson.js";
 export * from "./pattern.js";
-export * from "./patternMatcher.js";
 export * from "./resolveSources.js";
 export * from "./signedPattern.js";
 export * from "./source.js";

package/out/patterns/jsrjson.d.ts

@@ -1,5 +1,5 @@
 import type { MatcherContext } from "./matcherContext.js";
-import type { Source } from "./source.js";
+import { type Source } from "./source.js";
 /**
  * Extracts and compiles patterns from the file.
  *

package/out/patterns/jsrjson.js

@@ -1,6 +1,7 @@
 import { type } from "arktype";
 import stripJsonComments from "strip-json-comments";
 import { signedPatternCompile } from "./resolveSources.js";
+import { sourcePushNegatable } from "./source.js";
 const jsrManifest = type({
     exclude: "string[]?",
     include: "string[]?",
@@ -18,7 +19,27 @@ const parse = type("string")
  * @since 0.6.0
  */
 export function extractJsrJson(source, content, ctx) {
+    extract(source, content, ctx);
+    for (const element of source.pattern) {
+        signedPatternCompile(element);
+    }
+}
+extractJsrJson;
+/**
+ * Extracts and compiles patterns from the file.
+ *
+ * @see {@link signedPatternCompile}
+ *
+ * @since 0.6.0
+ */
+export function extractJsrJsonc(source, content, ctx) {
+    extractJsrJson(source, Buffer.from(stripJsonComments(content.toString())), ctx);
+}
+extractJsrJsonc;
+function extract(source, content, ctx) {
     const dist = parse(content.toString());
+    const include = { compiled: null, excludes: false, pattern: [] };
+    const exclude = { compiled: null, excludes: true, pattern: [] };
     if (dist instanceof type.errors) {
         source.error = new Error("Invalid '" + source.path + "': " + dist.summary, { cause: dist });
         ctx.failed.push(source);
@@ -26,31 +47,24 @@ export function extractJsrJson(source, content, ctx) {
     }
     if (!dist.publish) {
         if (dist.exclude) {
-            source.pattern.exclude.push(...dist.exclude);
+            exclude.pattern.push(...dist.exclude);
         }
     }
     else if (dist.publish.exclude) {
-        source.pattern.exclude.push(...dist.publish.exclude);
+        exclude.pattern.push(...dist.publish.exclude);
     }
     if (!dist.publish) {
         if (dist.include) {
-            source.pattern.include.push(...dist.include);
+            include.pattern.push(...dist.include);
         }
     }
     else if (dist.publish.include) {
-        source.pattern.include.push(...dist.publish.include);
+        include.pattern.push(...dist.publish.include);
     }
-    signedPatternCompile(source.pattern);
-}
-extractJsrJson;
-/**
- * Extracts and compiles patterns from the file.
- *
- * @see {@link signedPatternCompile}
- *
- * @since 0.6.0
- */
-export function extractJsrJsonc(source, content, ctx) {
-    extractJsrJson(source, Buffer.from(stripJsonComments(content.toString())), ctx);
+    for (const si of [include, exclude]) {
+        for (const pattern of si.pattern) {
+            sourcePushNegatable(pattern, true, include, exclude);
+        }
+    }
+    source.pattern.push(include, exclude);
 }
-extractJsrJsonc;

package/out/patterns/matcherStream.d.ts

@@ -1,5 +1,5 @@
-import { EventEmitter } from "node:events";
 import type { Dirent } from "node:fs";
+import { EventEmitter } from "node:events";
 import type { MatcherContext } from "../patterns/matcherContext.js";
 import type { ScanOptions, FsAdapter } from "../types.js";
 import type { SignedPatternMatch } from "./signedPattern.js";

package/out/patterns/packagejson.js

@@ -1,12 +1,7 @@
 import { type } from "arktype";
+import { npmManifestParse } from "../targets/npmManifest.js";
 import { signedPatternCompile } from "./resolveSources.js";
 import { sourcePushNegatable } from "./source.js";
-const npmManifest = type({
-    "files?": "string[]",
-});
-const parse = type("string")
-    .pipe((s) => JSON.parse(s))
-    .pipe(npmManifest);
 /**
  * Extracts and compiles patterns from the file.
  *
@@ -16,8 +11,11 @@ const parse = type("string")
  */
 export function extractPackageJson(source, content) {
     const result = extract(source, content);
-    if (result === undefined)
-        signedPatternCompile(source.pattern);
+    if (result === undefined) {
+        for (const element of source.pattern) {
+            signedPatternCompile(element);
+        }
+    }
     if (result === "error")
         return;
     return result;
@@ -31,15 +29,20 @@ export function extractPackageJson(source, content) {
  */
 export function extractPackageJsonNocase(source, content) {
     const result = extract(source, content);
-    if (result === undefined)
-        signedPatternCompile(source.pattern, { nocase: true });
+    if (result === undefined) {
+        for (const element of source.pattern) {
+            signedPatternCompile(element, { nocase: true });
+        }
+    }
     if (result === "error")
         return;
     return result;
 }
 function extract(source, content) {
     source.inverted = true;
-    const dist = parse(content.toString());
+    const include = { compiled: null, excludes: false, pattern: [] };
+    const exclude = { compiled: null, excludes: true, pattern: [] };
+    const dist = npmManifestParse(content.toString());
     if (dist instanceof type.errors) {
         source.error = new Error("Invalid '" + source.path + "': " + dist.summary, { cause: dist });
         return "error";
@@ -48,7 +51,8 @@ function extract(source, content) {
         return "none";
     }
     for (const pattern of dist.files) {
-        sourcePushNegatable(source, pattern);
+        sourcePushNegatable(pattern, true, include, exclude);
     }
+    source.pattern.push(include, exclude);
 }
 extractPackageJson;

package/out/patterns/pattern.d.ts

@@ -8,6 +8,11 @@ import { type StringCompileOptions } from "./stringCompile.js";
  * @since 0.6.0
  */
 export type PatternMinimatch = {
+    /**
+     * The regular expression instance.
+     *
+     * @since 0.6.0
+     */
     re: RegExp;
     /**
      * The original pattern string this minimatch was compiled from.

package/out/patterns/resolveSources.js

@@ -11,10 +11,7 @@ import { patternCompile } from "./pattern.js";
  * @since 0.6.0
  */
 export function signedPatternCompile(signedPattern, options) {
-    signedPattern.compiled = {
-        include: patternCompile(signedPattern.include, options),
-        exclude: patternCompile(signedPattern.exclude, options),
-    };
+    signedPattern.compiled = patternCompile(signedPattern.pattern, options);
     return signedPattern;
 }
 /**
@@ -110,10 +107,10 @@ async function tryExtractor(cwd, fs, ctx, extractor) {
     const path = relative(cwd, abs);
     const name = path.substring(path.lastIndexOf("/") + 1);
     const newSource = {
-        inverted: false,
         name,
         path,
-        pattern: { exclude: [], include: [], compiled: null },
+        inverted: false,
+        pattern: [],
     };
     let buff;
     try {

package/out/patterns/signedPattern.d.ts

@@ -1,11 +1,10 @@
 import type { PatternFinderOptions } from "./extractor.js";
-import { type Pattern, type PatternMinimatch } from "./pattern.js";
 import type { Source } from "./source.js";
+import { type Pattern, type PatternMinimatch } from "./pattern.js";
 /**
  * Represents a set of include and exclude patterns.
  * These patterns are positive minimatch patterns.
  *
- * @see {@link PatternMatcher} uses it.
  * @see {@link signedPatternIgnores} provides the ignoring algorithm.
  * @see {@link signedPatternCompile} compiles the signed pattern.
  * Use this or an extractor's method to compile.
@@ -18,17 +17,17 @@ export type SignedPattern = {
      *
      * @see {@link signedPatternIgnores} provides the ignoring algorithm.
      *
-     * @since 0.6.0
+     * @since 0.9.0
      */
-    include: Pattern;
+    pattern: Pattern;
     /**
-     * Provides ignored or included file and directory patterns.
+     * If `true`, pattern "test" will exclude file named "test".
      *
      * @see {@link signedPatternIgnores} provides the ignoring algorithm.
      *
-     * @since 0.6.0
+     * @since 0.9.0
      */
-    exclude: Pattern;
+    excludes: boolean;
     /**
      * Provides compiled ignored or included file and directory patterns.
      *
@@ -36,52 +35,60 @@ export type SignedPattern = {
      *
      * @since 0.6.0
      */
-    compiled: null | {
-        /**
-         * Provides compiled ignored or included file and directory patterns.
-         *
-         * @see {@link signedPatternIgnores} provides the ignoring algorithm.
-         *
-         * @since 0.6.0
-         */
-        include: PatternMinimatch[];
-        /**
-         * Provides compiled ignored or included file and directory patterns.
-         *
-         * @see {@link signedPatternIgnores} provides the ignoring algorithm.
-         *
-         * @since 0.6.0
-         */
-        exclude: PatternMinimatch[];
-    };
+    compiled: null | PatternMinimatch[];
 };
 /**
- * @see {@link signedPatternIgnores}
+ * The kind of a pattern match.
  *
- * @since 0.6.0
+ * @since 0.9.1
  */
-export type SignedPatternMatch = {
-    kind: "none" | "missing-source";
-    ignored: boolean;
-} | {
-    kind: "no-match" | "broken-source" | "invalid-pattern";
+export type MatchKind = SignedPatternMatch["kind"];
+/**
+ * @see {@link SignedPatternMatch}
+ *
+ * @since 0.9.1
+ */
+export interface MatchBase<K extends string> {
+    kind: K;
     ignored: boolean;
+}
+/**
+ * @see {@link SignedPatternMatch}
+ *
+ * @since 0.9.1
+ */
+export interface MatchBaseSource<K extends string> extends MatchBase<K> {
     source: Source;
-} | {
-    kind: "invalid-internal-pattern";
+}
+/**
+ * @see {@link SignedPatternMatch}
+ *
+ * @since 0.9.1
+ */
+export interface MatchBasePattern<K extends string> extends MatchBase<K> {
     pattern: string;
+}
+/**
+ * @see {@link SignedPatternMatch}
+ *
+ * @since 0.9.1
+ */
+export interface MatchBaseErrorPattern<K extends string> extends MatchBasePattern<K> {
     error: Error;
-    ignored: boolean;
-} | {
-    kind: "internal";
-    pattern: string;
-    ignored: boolean;
-} | {
-    kind: "external";
-    pattern: string;
-    source: Source;
-    ignored: boolean;
-};
+}
+/**
+ * @see {@link SignedPatternMatch}
+ *
+ * @since 0.9.1
+ */
+export interface MatchBaseSourcePattern<K extends string> extends MatchBasePattern<K>, MatchBaseSource<K> {
+}
+/**
+ * @see {@link signedPatternIgnores}
+ *
+ * @since 0.6.0
+ */
+export type SignedPatternMatch = MatchBase<"none" | "missing-source"> | MatchBaseSource<"no-match" | "broken-source" | "invalid-pattern"> | MatchBaseErrorPattern<"invalid-internal-pattern"> | MatchBasePattern<"internal"> | MatchBaseSourcePattern<"external">;
 /**
  * @see {@link signedPatternIgnores}
  *
@@ -103,24 +110,12 @@ export interface SignedPatternIgnoresOptions extends PatternFinderOptions {
      *
      * @since 0.6.0
      */
-    internal: SignedPattern;
+    internal: SignedPattern[];
 }
 /**
  * Checks whether a given entry should be ignored based on internal and external patterns.
  * Populates unknown sources using {@link resolveSources}.
  *
- * Algorithm:
- * 1. Check internal exclude patterns. If matched, return true.
- * 2. Check internal include patterns. If matched, return false.
- * 3. Check external patterns:
- *    - If not inverted:
- *      a. Check external include patterns. If matched, return false.
- *      b. Check external exclude patterns. If matched, return true.
- *    - If inverted:
- *      a. Check external exclude patterns. If matched, return true.
- *      b. Check external include patterns. If matched, return false.
- * 4. If no patterns matched, return the inverted state.
- *
  * @since 0.6.0
  */
 export declare function signedPatternIgnores(options: SignedPatternIgnoresOptions): Promise<SignedPatternMatch>;

package/out/patterns/signedPattern.js

@@ -15,112 +15,61 @@ function patternRegExpTest(path, rs) {
     return ["", undefined];
 }
 function signedPatternCompiledMatchInternal(options, path) {
-    let patternMatch = "";
-    let err;
-    const kind = "internal";
-    const signedPattern = options.internal;
-    const compiled = signedPattern.compiled; // no null
-    try {
-        ;
-        [patternMatch, err] = patternRegExpTest(path, compiled.exclude);
-        if (err) {
-            throw err;
-        }
-        if (patternMatch) {
-            // return true
-            return { kind, pattern: patternMatch, ignored: true };
-        }
-        ;
-        [patternMatch, err] = patternRegExpTest(path, compiled.include);
-        if (err) {
-            throw err;
-        }
-        if (patternMatch) {
-            // return false
-            return { kind, pattern: patternMatch, ignored: false };
-        }
-    }
-    catch (error) {
-        return {
-            kind: "invalid-internal-pattern",
-            pattern: patternMatch,
-            error: error,
-            ignored: false,
-        };
+    for (const si of options.internal) {
+        const compiled = si.compiled;
+        if (compiled === null)
+            continue;
+        let [patternMatch, error] = patternRegExpTest(path, compiled);
+        if (error)
+            return {
+                kind: "invalid-internal-pattern",
+                pattern: patternMatch,
+                error,
+                ignored: false,
+            };
+        if (patternMatch)
+            return {
+                kind: "internal",
+                pattern: patternMatch,
+                ignored: si.excludes,
+            };
     }
     return null;
 }
 function signedPatternCompiledMatchExternal(options, path, source) {
-    let patternMatch = "";
-    let err;
-    const kind = "external";
-    const signedPattern = source.pattern;
-    const compiled = signedPattern.compiled; // no null
-    try {
-        if (source.inverted) {
-            ;
-            [patternMatch, err] = patternRegExpTest(path, compiled.exclude);
-            if (err) {
-                throw err;
-            }
-            if (patternMatch) {
-                // return true
-                return { kind, source, pattern: patternMatch, ignored: true };
-            }
-            ;
-            [patternMatch, err] = patternRegExpTest(path, compiled.include);
-            if (err) {
-                throw err;
-            }
-            if (patternMatch) {
-                // return false
-                return { kind, source, pattern: patternMatch, ignored: false };
-            }
+    for (const si of source.pattern) {
+        const compiled = si.compiled;
+        if (compiled === null) {
+            continue;
         }
-        else {
-            ;
-            [patternMatch, err] = patternRegExpTest(path, compiled.include);
-            if (err) {
-                throw err;
-            }
-            if (patternMatch) {
-                // return false
-                return { kind, source, pattern: patternMatch, ignored: false };
-            }
-            ;
-            [patternMatch, err] = patternRegExpTest(path, compiled.exclude);
-            if (err) {
-                throw err;
-            }
-            if (patternMatch) {
-                // return true
-                return { kind, source, pattern: patternMatch, ignored: true };
-            }
+        let [patternMatch, err] = patternRegExpTest(path, compiled);
+        if (err) {
+            source.error = err;
+            options.ctx?.failed.push(source);
+            return {
+                kind: "invalid-pattern",
+                ignored: false,
+                source,
+            };
         }
+        if (patternMatch)
+            return {
+                kind: "external",
+                pattern: patternMatch,
+                ignored: si.excludes,
+                source,
+            };
     }
-    catch (err) {
-        source.error = err;
-        options.ctx?.failed.push(source);
-        return { kind: "invalid-pattern", ignored: false, source };
-    }
-    return { kind: "no-match", ignored: source.inverted, source };
+    return {
+        kind: "no-match",
+        ignored: source.inverted,
+        source,
+    };
 }
 /**
  * Checks whether a given entry should be ignored based on internal and external patterns.
  * Populates unknown sources using {@link resolveSources}.
  *
- * Algorithm:
- * 1. Check internal exclude patterns. If matched, return true.
- * 2. Check internal include patterns. If matched, return false.
- * 3. Check external patterns:
- *    - If not inverted:
- *      a. Check external include patterns. If matched, return false.
- *      b. Check external exclude patterns. If matched, return true.
- *    - If inverted:
- *      a. Check external exclude patterns. If matched, return true.
- *      b. Check external include patterns. If matched, return false.
- * 4. If no patterns matched, return the inverted state.
- *
  * @since 0.6.0
  */
 export async function signedPatternIgnores(options) {
@@ -131,7 +80,7 @@ export async function signedPatternIgnores(options) {
         source = options.ctx.external.get(parent);
     }
     if (source === undefined || source === "none") {
-        return { kind: "missing-source", ignored: true };
+        return { kind: "missing-source", ignored: false };
     }
     if (typeof source === "object" && source.error) {
         return { kind: "broken-source", ignored: true, source };

package/out/patterns/source.d.ts

@@ -9,12 +9,11 @@ export type Source = {
      * Patterns defined within the source file.
      * Those patterns are for ignoring files.
      *
-     * @see {@link PatternMatcher}
      * @see {@link signedPatternIgnores}
      *
      * @since 0.6.0
      */
-    pattern: SignedPattern;
+    pattern: SignedPattern[];
     /**
      * Name of the source file.
      *
@@ -32,7 +31,6 @@ export type Source = {
      * For example, `package.json` `files` field inverts the matching logic,
      * because it specifies files to include rather than exclude.
      *
-     * @see {@link PatternMatcher}
      * @see {@link signedPatternIgnores}
      *
      * @since 0.6.0
@@ -54,4 +52,4 @@ export type Source = {
  *
  * @since 0.6.0
  */
-export declare function sourcePushNegatable(source: Source, pattern: string): void;
+export declare function sourcePushNegatable(pattern: string, invert: boolean, include: SignedPattern, exclude: SignedPattern): void;

package/out/patterns/source.js

@@ -5,9 +5,8 @@
  *
  * @since 0.6.0
  */
-export function sourcePushNegatable(source, pattern) {
-    let exclude = source.pattern.exclude, include = source.pattern.include;
-    if (source.inverted) {
+export function sourcePushNegatable(pattern, invert, include, exclude) {
+    if (invert) {
         ;
         [exclude, include] = [include, exclude];
     }
@@ -16,5 +15,5 @@ export function sourcePushNegatable(source, pattern) {
         dist = include;
         pattern = pattern.substring(1);
     }
-    dist.push(pattern);
+    dist.pattern.push(pattern);
 }