view-ignored 0.7.1 → 0.8.1

package/out/patterns/stringCompile.js

@@ -4,9 +4,9 @@ import { makeRe } from "minimatch";
  *
  * @see {@link patternCompile}
  *
- * @since 0.6.0
+ * @since 0.8.0
  */
-export function stringCompile(pattern, _ = -1, array = []) {
+export function stringCompile(pattern, context = [], options) {
     const original = pattern;
     if (pattern.endsWith("/")) {
         pattern = pattern.substring(0, pattern.length - 1);
@@ -23,6 +23,7 @@ export function stringCompile(pattern, _ = -1, array = []) {
         nonegate: true,
         nocomment: true,
         nobrace: true,
+        nocase: options?.nocase ?? false,
     });
-    return { re, pattern: original, patternContext: array };
+    return { re, pattern: original, patternContext: context };
 }

package/out/scan.d.ts

@@ -4,7 +4,7 @@ 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
+ * 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.

package/out/scan.js

@@ -4,7 +4,7 @@ import { scan as browserScan } from "./browser_scan.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
+ * 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.

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,78 @@
+import { signedPatternIgnores, signedPatternCompile, extractPackageJson, extractGitignore, } from "../patterns/index.js";
+const extractors = [
+    {
+        extract: extractPackageJson,
+        path: "package.json",
+    },
+    {
+        extract: extractGitignore,
+        path: ".npmignore",
+    },
+    {
+        extract: extractGitignore,
+        path: ".gitignore",
+    },
+];
+const internal = {
+    exclude: [
+        // 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",
+    ],
+    include: [
+        // 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,
+};
+signedPatternCompile(internal);
+/**
+ * @since 0.8.1
+ */
+export const Bun = {
+    // TODO: Bun should include some paths: bins, bundled deps, nothing else.
+    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;

package/out/targets/deno.js

@@ -0,0 +1,40 @@
+import { signedPatternIgnores, signedPatternCompile, extractJsrJson, extractJsrJsonc, } from "../patterns/index.js";
+const extractors = [
+    {
+        extract: extractJsrJson,
+        path: "deno.json",
+    },
+    {
+        extract: extractJsrJsonc,
+        path: "deno.jsonc",
+    },
+    {
+        extract: extractJsrJson,
+        path: "jsr.json",
+    },
+    {
+        extract: extractJsrJsonc,
+        path: "jsr.jsonc",
+    },
+];
+const internal = {
+    exclude: [".git", ".DS_Store"],
+    include: [],
+    compiled: null,
+};
+signedPatternCompile(internal);
+/**
+ * @since 0.8.1
+ */
+export const Deno = {
+    // TODO: Deno should validate manifest
+    extractors,
+    ignores(o) {
+        return signedPatternIgnores({
+            ...o,
+            internal,
+            root: ".",
+            target: Deno,
+        });
+    },
+};

package/out/targets/git.js

@@ -19,6 +19,7 @@ signedPatternCompile(internal);
  * @since 0.6.0
  */
 export const Git = {
+    // TODO: Git should read configs
     extractors,
     ignores(o) {
         return signedPatternIgnores({

package/out/targets/index.d.ts

@@ -1,6 +1,9 @@
+export * from "./bun.js";
+export * from "./deno.js";
 export * from "./git.js";
 export * from "./jsr.js";
 export * from "./npm.js";
 export * from "./target.js";
 export * from "./vsce.js";
 export * from "./yarn.js";
+export * from "./yarnClassic.js";

package/out/targets/index.js

@@ -1,6 +1,9 @@
+export * from "./bun.js";
+export * from "./deno.js";
 export * from "./git.js";
 export * from "./jsr.js";
 export * from "./npm.js";
 export * from "./target.js";
 export * from "./vsce.js";
 export * from "./yarn.js";
+export * from "./yarnClassic.js";

package/out/targets/jsr.js

@@ -1,13 +1,5 @@
 import { signedPatternIgnores, signedPatternCompile, extractJsrJson, extractJsrJsonc, } from "../patterns/index.js";
 const extractors = [
-    {
-        extract: extractJsrJson,
-        path: "deno.json",
-    },
-    {
-        extract: extractJsrJsonc,
-        path: "deno.jsonc",
-    },
     {
         extract: extractJsrJson,
         path: "jsr.json",
@@ -27,6 +19,7 @@ signedPatternCompile(internal);
  * @since 0.6.0
  */
 export const JSR = {
+    // TODO: JSR should validate manifest
     extractors,
     ignores(o) {
         return signedPatternIgnores({

package/out/targets/npm.js

@@ -15,25 +15,47 @@ const extractors = [
 ];
 const internal = {
     exclude: [
-        ".git",
-        ".DS_Store",
-        "node_modules",
-        ".*.swp",
-        "._*",
-        ".DS_Store",
-        ".git",
+        // https://github.com/npm/npm-packlist/blob/main/lib/index.js#L16
+        ".npmignore",
         ".gitignore",
+        ".git",
+        ".svn",
         ".hg",
-        ".npmignore",
-        ".npmrc",
-        ".lock-wscript",
+        "CVS",
+        ".git",
         ".svn",
-        ".wafpickle-*",
-        "config.gypi",
+        ".hg",
         "CVS",
+        "/.lock-wscript",
+        "/.wafpickle-*",
+        "/build/config.gypi",
         "npm-debug.log",
+        ".npmrc",
+        ".*.swp",
+        ".DS_Store",
+        "._*",
+        "*.orig",
+        "/archived-packages/**",
+        // https://github.com/npm/npm-packlist/blob/main/lib/index.js#L294
+        "/node_modules",
+        "/package-lock.json",
+        "/yarn.lock",
+        "/pnpm-lock.yaml",
+        "/bun.lockb",
+    ],
+    include: [
+        // https://github.com/npm/npm-packlist/blob/main/lib/index.js#L287
+        "bin",
+        "package.json",
+        "README",
+        "COPYING",
+        "LICENSE",
+        "LICENCE",
+        "README.*",
+        "COPYING.*",
+        "LICENSE.*",
+        "LICENCE.*",
     ],
-    include: ["bin", "package.json", "README*", "LICENSE*", "LICENCE*"],
     compiled: null,
 };
 signedPatternCompile(internal);
@@ -41,6 +63,7 @@ signedPatternCompile(internal);
  * @since 0.6.0
  */
 export const NPM = {
+    // TODO: NPM should validate package.json
     extractors,
     ignores(o) {
         return signedPatternIgnores({

package/out/targets/target.d.ts

@@ -1,5 +1,6 @@
 import type { Extractor } from "../patterns/extractor.js";
 import type { Ignores } from "../patterns/ignores.js";
+import type { Init } from "../patterns/init.js";
 /**
  * Contains the matcher used for scanning.
  *
@@ -21,4 +22,16 @@ export interface Target {
      * @since 0.6.0
      */
     ignores: Ignores;
+    /**
+     * Initialization function.
+     * Called by the scanner method.
+     *
+     * @example
+     * scan({ target: { ...Git, init: undefined } })
+     *
+     * @see {@link Init}
+     *
+     * @since 0.8.0
+     */
+    init?: Init;
 }

package/out/targets/vsce.js

@@ -14,7 +14,40 @@ const extractors = [
     },
 ];
 const internal = {
-    exclude: [".git", ".DS_Store"],
+    exclude: [
+        // https://github.com/microsoft/vscode-vsce/blob/main/src/package.ts#L1633
+        ".vscodeignore",
+        "package-lock.json",
+        "npm-debug.log",
+        "yarn.lock",
+        "yarn-error.log",
+        "npm-shrinkwrap.json",
+        ".editorconfig",
+        ".npmrc",
+        ".yarnrc",
+        ".gitattributes",
+        "*.todo",
+        "tslint.yaml",
+        ".eslintrc*",
+        ".babelrc*",
+        ".prettierrc*",
+        ".cz-config.js",
+        ".commitlintrc*",
+        "webpack.config.js",
+        "ISSUE_TEMPLATE.md",
+        "CONTRIBUTING.md",
+        "PULL_REQUEST_TEMPLATE.md",
+        "CODE_OF_CONDUCT.md",
+        ".github",
+        ".travis.yml",
+        "appveyor.yml",
+        ".git",
+        "*.vsix",
+        ".DS_Store",
+        "*.vsixmanifest",
+        ".vscode-test",
+        ".vscode-test-web",
+    ],
     include: [],
     compiled: null,
 };

package/out/targets/yarn.js

@@ -1,52 +1,98 @@
-import { signedPatternIgnores, signedPatternCompile, extractPackageJson, extractGitignore, } from "../patterns/index.js";
+import { type } from "arktype";
+import { signedPatternIgnores, signedPatternCompile, extractPackageJsonNocase, extractGitignoreNocase, } from "../patterns/index.js";
+import { join, unixify } from "../unixify.js";
 const extractors = [
     {
-        extract: extractPackageJson,
+        extract: extractPackageJsonNocase,
         path: "package.json",
     },
     {
-        extract: extractGitignore,
-        path: ".yarnignore",
-    },
-    {
-        extract: extractGitignore,
+        extract: extractGitignoreNocase,
         path: ".npmignore",
     },
     {
-        extract: extractGitignore,
+        extract: extractGitignoreNocase,
         path: ".gitignore",
     },
 ];
+const include = [
+    // https://github.com/yarnpkg/berry/blob/master/packages/plugin-pack/sources/packUtils.ts#L10
+    "/package.json",
+    "/README",
+    "/README.*",
+    "/LICENSE",
+    "/LICENSE.*",
+    "/LICENCE",
+    "/LICENCE.*",
+];
 const internal = {
     exclude: [
+        // https://github.com/yarnpkg/berry/blob/master/packages/plugin-pack/sources/packUtils.ts#L26
+        "/package.tgz",
+        ".github",
         ".git",
-        ".DS_Store",
-        "node_modules",
-        ".*.swp",
-        "._*",
-        ".DS_Store",
-        ".git",
-        ".gitignore",
         ".hg",
+        "node_modules",
         ".npmignore",
-        ".npmrc",
-        ".lock-wscript",
-        ".svn",
-        ".wafpickle-*",
-        "config.gypi",
-        "CVS",
-        "npm-debug.log",
-        ".yarnignore",
-        ".yarnrc",
+        ".gitignore",
+        ".#*",
+        ".DS_Store",
     ],
-    include: ["bin", "package.json", "README*", "LICENSE*", "LICENCE*"],
+    include: [...include],
     compiled: null,
 };
-signedPatternCompile(internal);
+signedPatternCompile(internal, { nocase: true });
+const npmManifest = type({
+    "main?": "string",
+    "module?": "string",
+    "browser?": "string",
+    "bin?": "string | Record<string, string>",
+});
+const parse = type("string")
+    .pipe((s) => JSON.parse(s))
+    .pipe(npmManifest);
 /**
  * @since 0.6.0
  */
 export const Yarn = {
+    async init({ fs, cwd }) {
+        let content;
+        const normalCwd = unixify(cwd);
+        try {
+            content = await fs.promises.readFile(normalCwd + "/" + "package.json");
+        }
+        catch (error) {
+            if (error.code === "ENOENT") {
+                return; // no package.json
+            }
+            throw new Error("Error while initializing Yarn's ignoring implementation", { cause: error });
+        }
+        const dist = parse(content.toString());
+        if (dist instanceof type.errors) {
+            throw new Error("Invalid 'package.json': " + dist.summary, { cause: dist });
+        }
+        // https://github.com/yarnpkg/berry/blob/master/packages/plugin-pack/sources/packUtils.ts#L215-L231
+        const set = new Set(include);
+        function normal(path) {
+            const result = unixify(join(normalCwd, path)).substring(normalCwd.length);
+            return result;
+        }
+        if (dist.main)
+            set.add(normal(dist.main));
+        if (dist.module)
+            set.add(normal(dist.module));
+        if (dist.browser)
+            set.add(normal(dist.browser));
+        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)));
+        }
+        internal.include.length = 0;
+        internal.include.push(...set);
+        signedPatternCompile(internal, { nocase: true });
+    },
     extractors,
     ignores(o) {
         return signedPatternIgnores({

package/out/targets/yarnClassic.d.ts

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

package/out/targets/yarnClassic.js

@@ -0,0 +1,77 @@
+import { signedPatternIgnores, signedPatternCompile, extractPackageJsonNocase, extractGitignoreNocase, } from "../patterns/index.js";
+const extractors = [
+    {
+        extract: extractPackageJsonNocase,
+        path: "package.json",
+    },
+    {
+        extract: extractGitignoreNocase,
+        path: ".yarnignore",
+    },
+    {
+        extract: extractGitignoreNocase,
+        path: ".npmignore",
+    },
+    {
+        extract: extractGitignoreNocase,
+        path: ".gitignore",
+    },
+];
+const internal = {
+    exclude: [
+        // https://github.com/yarnpkg/berry/blob/master/packages/plugin-pack/sources/packUtils.ts#L26
+        ".git",
+        "CVS",
+        ".svn",
+        ".hg",
+        "node_modules",
+        "yarn.lock",
+        ".lock-wscript",
+        ".wafpickle-0",
+        ".wafpickle-1",
+        ".wafpickle-2",
+        ".wafpickle-3",
+        ".wafpickle-4",
+        ".wafpickle-5",
+        ".wafpickle-6",
+        ".wafpickle-7",
+        ".wafpickle-8",
+        ".wafpickle-9",
+        "*.swp",
+        "._*",
+        "npm-debug.log",
+        "yarn-error.log",
+        ".npmrc",
+        ".yarnrc",
+        ".yarnrc.yml",
+        ".npmignore",
+        ".gitignore",
+        ".DS_Store",
+    ],
+    include: [
+        // https://github.com/yarnpkg/berry/blob/master/packages/plugin-pack/sources/packUtils.ts#L10
+        "/package.json",
+        "/readme*",
+        "/license*",
+        "/licence*",
+        "/changes*",
+        "/changelog*",
+        "/history*",
+    ],
+    compiled: null,
+};
+signedPatternCompile(internal, { nocase: true });
+/**
+ * @since 0.8.0
+ */
+export const YarnClassic = {
+    extractors,
+    ignores(o) {
+        return signedPatternIgnores({
+            ...o,
+            internal,
+            root: ".",
+            target: YarnClassic,
+        });
+    },
+};

package/out/types.d.ts

@@ -26,7 +26,7 @@ export type ScanOptions = {
     /**
      * Current working directory to start the scan from.
      *
-     * @default `normalizeCwd(process.cwd())`
+     * @default `unixify(process.cwd())`
      *
      * @since 0.6.0
      */

package/out/unixify.d.ts

@@ -0,0 +1,3 @@
+export declare function unixify(path: string): string;
+export declare function join(from: string, p2: string): string;
+export declare function relative(base: string, to: string): string;

package/out/unixify.js

@@ -0,0 +1,33 @@
+const strippedCwd = strip(process.cwd());
+export function unixify(path) {
+    let result = strip(path);
+    if (result.startsWith("./")) {
+        result = strippedCwd + result.substring(1);
+    }
+    else if (!result.startsWith("/")) {
+        result = strippedCwd + "/" + result;
+    }
+    return result;
+}
+export function join(from, p2) {
+    if (p2 === "." || p2 === "./") {
+        return from;
+    }
+    else if (p2.startsWith("./")) {
+        from += "/" + p2.substring(2);
+    }
+    else {
+        from += "/" + p2;
+    }
+    return from;
+}
+export function relative(base, to) {
+    if (!base.endsWith("/")) {
+        base += "/";
+    }
+    const result = to.replace(base, "");
+    return result;
+}
+function strip(path) {
+    return path.replaceAll("\\", "/").replace(/\w:/, "");
+}

package/out/walk.js

@@ -88,10 +88,10 @@ export async function walkIncludes(options) {
         if (lastSlash >= 0) {
             const dir = path.substring(0, lastSlash) + "/";
             const dirMatch = ctx.paths.get(dir);
-            if (dirMatch?.ignored) {
+            if (dirMatch === undefined || dirMatch.ignored) {
                 ctx.paths.set(dir, match);
                 if (stream) {
-                    stream.emit("dirent", { dirent: entry, match, path: direntPath, ctx });
+                    stream.emit("dirent", { dirent: entry, match, path: dir, ctx });
                 }
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "view-ignored",
-	"version": "0.7.1",
+	"version": "0.8.1",
 	"description": "Retrieve list of files ignored/included by Git, NPM, Yarn, JSR, VSCE or other tools.",
 	"keywords": [
 		".gitignore",
@@ -100,9 +100,12 @@
 	"devDependencies": {
 		"@release-it/keep-a-changelog": "^7.0.1",
 		"@types/bun": "^1.3.8",
+		"@types/ignore-walk": "^4.0.3",
 		"@types/node": "^18.19.130",
 		"@typescript/native-preview": "^7.0.0-dev.20260209.1",
+		"ignore-walk": "^8.0.0",
 		"memfs": "^4.56.10",
+		"mitata": "^1.0.34",
 		"oxfmt": "^0.28.0",
 		"oxlint": "^1.43.0",
 		"oxlint-tsgolint": "^0.11.5",

package/out/normalizeCwd.d.ts

@@ -1 +0,0 @@
-export declare function normalizeCwd(cwd: string): string;

package/out/normalizeCwd.js

@@ -1,4 +0,0 @@
-import { resolve } from "node:path";
-export function normalizeCwd(cwd) {
-    return resolve(cwd).replaceAll("\\", "/").replace(/\w:/, "");
-}