view-ignored 0.8.0 → 0.8.1

package/README.md

@@ -138,37 +138,37 @@ 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.
+  - 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.
+  - 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))
   - 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)
+- JSR ([implementation](https://github.com/Mopsgamer/view-ignored/tree/main/src/targets/jsr.ts))
+  - 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.
   - 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/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,3 +1,5 @@
+export * from "./bun.js";
+export * from "./deno.js";
 export * from "./git.js";
 export * from "./jsr.js";
 export * from "./npm.js";

package/out/targets/index.js

@@ -1,3 +1,5 @@
+export * from "./bun.js";
+export * from "./deno.js";
 export * from "./git.js";
 export * from "./jsr.js";
 export * from "./npm.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

@@ -63,6 +63,7 @@ signedPatternCompile(internal);
  * @since 0.6.0
  */
 export const NPM = {
+    // TODO: NPM should validate package.json
     extractors,
     ignores(o) {
         return signedPatternIgnores({

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "view-ignored",
-	"version": "0.8.0",
+	"version": "0.8.1",
 	"description": "Retrieve list of files ignored/included by Git, NPM, Yarn, JSR, VSCE or other tools.",
 	"keywords": [
 		".gitignore",