view-ignored 0.8.0 → 0.9.0

package/README.md

@@ -138,37 +138,39 @@ 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 (expecting to be 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.
+  - 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`.
-  - See the implementation of [NPM target](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/npm.ts) for details.
-- Yarn
-  - Modern Berry behavior, but does not include paths from `package.json` `main`, `module`, `browser` and `bin`.
-  - `YarnClassic` is available.
+- 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).
-  - 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))
+  - Validates `package.json`.
   - 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)
-  - Reads `jsr.json(c)` and `deno.json(c)` `include` and `exclude` fields.
+- 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).
-  - 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_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/jsrjson.js

@@ -19,6 +19,8 @@ const parse = type("string")
  */
 export function extractJsrJson(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,21 +28,23 @@ 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);
+    }
+    for (const element of source.pattern) {
+        signedPatternCompile(element);
     }
-    signedPatternCompile(source.pattern);
 }
 extractJsrJson;
 /**

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/patternMatcher.d.ts

@@ -13,11 +13,11 @@ export type PatternMatcher = {
      *
      * @since 0.6.0
      */
-    internal: SignedPattern;
+    internal: SignedPattern[];
     /**
      * External patterns are sourced from existing project files at runtime.
      *
      * @since 0.6.0
      */
-    external: SignedPattern;
+    external: SignedPattern[];
 };

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,6 +1,6 @@
 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.
@@ -18,17 +18,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,24 +36,7 @@ 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}
@@ -103,24 +86,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

@@ -19,25 +19,21 @@ function signedPatternCompiledMatchInternal(options, path) {
     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 };
+        for (const si of signedPattern) {
+            const compiled = si.compiled;
+            if (compiled === null) {
+                continue;
+            }
+            ;
+            [patternMatch, err] = patternRegExpTest(path, compiled);
+            if (err) {
+                throw err;
+            }
+            if (patternMatch) {
+                // return true
+                return { kind, pattern: patternMatch, ignored: si.excludes };
+            }
         }
     }
     catch (error) {
@@ -54,47 +50,20 @@ 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;
+        for (const si of source.pattern) {
+            const compiled = si.compiled;
+            if (compiled === null) {
+                continue;
             }
-            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 };
-            }
-        }
-        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);
+            [patternMatch, err] = patternRegExpTest(path, compiled);
             if (err) {
                 throw err;
             }
             if (patternMatch) {
                 // return true
-                return { kind, source, pattern: patternMatch, ignored: true };
+                return { kind, pattern: patternMatch, ignored: si.excludes, source };
             }
         }
     }
@@ -109,18 +78,6 @@ function signedPatternCompiledMatchExternal(options, path, 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 +88,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

@@ -14,7 +14,7 @@ export type Source = {
      *
      * @since 0.6.0
      */
-    pattern: SignedPattern;
+    pattern: SignedPattern[];
     /**
      * Name of the source file.
      *
@@ -54,4 +54,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);
 }

package/out/patterns/stringCompile.js

@@ -17,7 +17,9 @@ export function stringCompile(pattern, context = [], options) {
     else if (!pattern.startsWith("**/")) {
         pattern = "**/" + pattern;
     }
-    pattern += "/**";
+    if (!pattern.endsWith("/**")) {
+        pattern += "/**";
+    }
     const re = makeRe(pattern, {
         dot: true,
         nonegate: true,

package/out/targets/bun.d.ts

@@ -0,0 +1,5 @@
+import type { Target } from "./target.js";
+/**
+ * @since 0.8.1
+ */
+export declare const Bun: Target;

package/out/targets/bun.js

@@ -0,0 +1,123 @@
+import { type } from "arktype";
+import { signedPatternIgnores, signedPatternCompile, extractPackageJson, extractGitignore, } from "../patterns/index.js";
+import { join, unixify } from "../unixify.js";
+import { npmManifestParse } from "./npmManifest.js";
+const extractors = [
+    {
+        extract: extractPackageJson,
+        path: "package.json",
+    },
+    {
+        extract: extractGitignore,
+        path: ".npmignore",
+    },
+    {
+        extract: extractGitignore,
+        path: ".gitignore",
+    },
+];
+const internalInclude = {
+    excludes: false,
+    pattern: [], // filled within init
+    compiled: [],
+};
+const internal = [
+    internalInclude,
+    signedPatternCompile({
+        excludes: true,
+        pattern: [
+            // https://github.com/oven-sh/bun/blob/main/src/cli/pack_command.zig#L180
+            "package-lock.json",
+            "yarn.lock",
+            "pnpm-lock.yaml",
+            "bun.lockb",
+            "bun.lock", // npm includes it
+            // https://github.com/oven-sh/bun/blob/main/src/cli/pack_command.zig#L189
+            ".*.swp",
+            "._*",
+            ".DS_Store",
+            ".git",
+            ".gitignore",
+            ".hg",
+            ".npmignore",
+            ".npmrc",
+            ".lock-wscript",
+            ".svn",
+            "wafpickle-*",
+            "CVS",
+            "npm-debug.log",
+            // bun says it is "mentioned in the docs but does not appear to be ignored by default"
+            // but we know it should be /build/config.gypi, not just config.gypi, haha
+            // "config.gypi",
+            ".env.production", // npm includes it
+            "bunfig.toml", // npm includes it
+            // https://github.com/oven-sh/bun/blob/main/src/cli/pack_command.zig#L284
+            // manifest should be included, but bun ignores it on this line
+            // bun forces it later: https://github.com/oven-sh/bun/blob/main/src/cli/pack_command.zig#L2586
+            // "package.json",
+            // https://github.com/oven-sh/bun/blob/main/src/cli/pack_command.zig#L285
+            "node_modules",
+        ],
+        compiled: null,
+    }), // nocase should be false here
+    signedPatternCompile({
+        excludes: true,
+        pattern: [
+            // https://github.com/oven-sh/bun/blob/main/src/cli/pack_command.zig#L2586
+            "package.json",
+            // the special?.* check works this way: https://github.com/oven-sh/bun/blob/main/src/cli/pack_command.zig#L2599
+            "LICENSE",
+            "LICENSE.*",
+            "LICENCE",
+            "LICENCE.*",
+            "README",
+            "README.*",
+        ],
+        compiled: null,
+    }, { nocase: true }),
+];
+/**
+ * @since 0.8.1
+ */
+export const Bun = {
+    async init({ fs, cwd }) {
+        let content;
+        const normalCwd = unixify(cwd);
+        try {
+            content = await fs.promises.readFile(normalCwd + "/" + "package.json");
+        }
+        catch (error) {
+            throw new Error("Error while initializing Bun", { cause: error });
+        }
+        const dist = npmManifestParse(content.toString());
+        if (dist instanceof type.errors) {
+            throw new Error("Invalid 'package.json': " + dist.summary, { cause: dist });
+        }
+        const set = new Set();
+        function normal(path) {
+            const result = unixify(join(normalCwd, path)).substring(normalCwd.length);
+            return result;
+        }
+        // https://github.com/oven-sh/bun/blob/main/src/cli/pack_command.zig#L1440
+        if (typeof dist.bin === "string") {
+            set.add(normal(dist.bin));
+        }
+        else if (typeof dist.bin === "object" && dist.bin !== null) {
+            Object.values(dist.bin).forEach((binPath) => set.add(normal(binPath)));
+        }
+        // TODO: Bun should include bundled deps
+        // nothing else
+        // link zig code
+        internalInclude.pattern = Array.from(set);
+        signedPatternCompile(internalInclude, { nocase: true });
+    },
+    extractors,
+    ignores(o) {
+        return signedPatternIgnores({
+            ...o,
+            internal,
+            root: ".",
+            target: Bun,
+        });
+    },
+};

package/out/targets/deno.d.ts

@@ -0,0 +1,5 @@
+import type { Target } from "./target.js";
+/**
+ * @since 0.8.1
+ */
+export declare const Deno: Target;