feat(core): Add ignoreFile option (#80)

Implement the `ignoreFile` option and rewrite the `ignore` option behaviour. 

Previously, we used `glob`'s `ignore` option to pass an array of ignore rules to the library. This meant we'd get back a set of filtered files where ignore rules were already applied. However, `glob` does not support negated ignore rules, meaning ignore patterns like "ignore everything except file x" wouldn't work. 

With this change, we introduce a new library to the project: [ignore](https://www.npmjs.com/package/ignore). It lets us add rules to a rule checker (regardless of if these rules come from a file or an array). We now first collect all files with `glob` and subsequently filter out the ones that are ignored by the specified ignore rules. This rule checker supports all rules as specified in `.gitignore` specs. Therefore, it also supports negated ignore rules.

Author: Lms24

packages/bundler-plugin-core/package.json

@@ -39,6 +39,7 @@
     "axios": "^0.27.2",
     "form-data": "^4.0.0",
     "glob": "8.0.3",
+    "ignore": "^5.2.0",
     "magic-string": "0.26.2",
     "unplugin": "0.10.1"
   },

packages/bundler-plugin-core/src/sentry/sourcemaps.ts

@@ -3,13 +3,55 @@ import fs, { Stats } from "fs";
 import glob from "glob";
 import { InternalIncludeEntry } from "../options-mapping";
 
+import ignore, { Ignore } from "ignore";
+
 export type FileRecord = {
   name: string;
   content: string;
 };
 
+type FileNameRecord = {
+  absolutePath: string;
+  // Contains relative paths without leading `.` (e.g. "foo/bar.js" or "asdf\\a\\b.js.map")
+  relativePath: string;
+  // Holds the path of the file relative to the CWD (used for ignore matching)
+  relativeCwdPath: string;
+};
+
 export function getFiles(includePath: string, includeEntry: InternalIncludeEntry): FileRecord[] {
+  // Start with getting all (unfiltered) files for the given includePath.
+  const files = collectAllFiles(includePath);
+  if (!files.length) {
+    return [];
+  }
+
+  const ignore = getIgnoreRules(includeEntry);
+  const filteredFiles = files
+    .filter(({ relativeCwdPath }) => !ignore.ignores(relativeCwdPath))
+    .filter(({ absolutePath }) => includeEntry.ext.includes(path.extname(absolutePath)));
+
+  // TODO do sourcemap rewriting?
+  // TODO do sourcefile rewriting? (adding source map reference to bottom - search for "guess_sourcemap_reference")
+  return filteredFiles.map(({ absolutePath, relativePath }) => {
+    const content = fs.readFileSync(absolutePath, { encoding: "utf-8" });
+    return {
+      name:
+        (includeEntry.urlPrefix ?? "~/") +
+        convertWindowsPathToPosix(relativePath) +
+        (includeEntry.urlSuffix ?? ""),
+      content,
+    };
+  });
+}
+
+/**
+ * Collects all (unfiltered) files from @param includePath
+ * @param includePath
+ * @returns an array of files
+ */
+function collectAllFiles(includePath: string): FileNameRecord[] {
   let fileStat: Stats;
+
   const absolutePath = path.isAbsolute(includePath)
     ? includePath
     : path.resolve(process.cwd(), includePath);
@@ -19,52 +61,42 @@ export function getFiles(includePath: string, includeEntry: InternalIncludeEntry
     return [];
   }
 
-  let files: {
-    absolutePath: string;
-    // Contains relative paths without leading `.` (e.g. "foo/bar.js" or "asdf\\a\\b.js.map")
-    relativePath: string;
-  }[];
-
   if (fileStat.isFile()) {
-    files = [{ absolutePath, relativePath: path.basename(absolutePath) }];
+    return [
+      {
+        absolutePath,
+        relativePath: path.basename(absolutePath),
+        relativeCwdPath: path.relative(process.cwd(), absolutePath),
+      },
+    ];
   } else if (fileStat.isDirectory()) {
-    const absoluteIgnores = includeEntry.ignore.map((ignoreEntry) =>
-      path.join(process.cwd(), ignoreEntry)
-    );
-
-    files = glob
+    return glob
       .sync(path.join(absolutePath, "**"), {
         nodir: true,
         absolute: true,
-        ignore: absoluteIgnores,
       })
       .map((globPath) => ({
         absolutePath: globPath,
         relativePath: globPath.slice(absolutePath.length + 1),
+        relativeCwdPath: path.relative(process.cwd(), globPath),
       }));
   } else {
     return [];
   }
+}
 
-  const filteredFiles = files.filter(({ absolutePath }) => {
-    return includeEntry.ext.includes(path.extname(absolutePath));
-  });
-
-  // TODO ignore files
-  // TODO ignorefile
-  // TODO do sourcemap rewriting?
-  // TODO do sourcefile rewriting? (adding source map reference to bottom - search for "guess_sourcemap_reference")
-
-  return filteredFiles.map(({ absolutePath, relativePath }) => {
-    const content = fs.readFileSync(absolutePath, { encoding: "utf-8" });
-    return {
-      name:
-        (includeEntry.urlPrefix ?? "~/") +
-        convertWindowsPathToPosix(relativePath) +
-        (includeEntry.urlSuffix ?? ""),
-      content,
-    };
-  });
+/**
+ * Adds rules specified in `ignore` and `ignoreFile` to the ignore rule
+ * checker and returns the checker for further use.
+ */
+function getIgnoreRules(includeEntry: InternalIncludeEntry): Ignore {
+  const ignoreChecker = ignore();
+  if (includeEntry.ignoreFile) {
+    const ignoreFileContent = fs.readFileSync(includeEntry.ignoreFile).toString();
+    ignoreChecker.add(ignoreFileContent);
+  }
+  ignoreChecker.add(includeEntry.ignore);
+  return ignoreChecker;
 }
 
 function convertWindowsPathToPosix(windowsPath: string): string {

packages/playground/.sentryignore

@@ -0,0 +1,5 @@
+#out/vite-smallNodeApp/\*\*
+
+# some comment
+
+!out/vite-smallNodeApp/index.js

packages/playground/vite.config.smallNodeApp.js

@@ -17,14 +17,16 @@ export default defineConfig({
   },
   plugins: [
     sentryVitePlugin({
-      url: process.env.SENTRY_URL,
-      authToken: process.env.SENTRY_AUTH_TOKEN,
-      org: process.env.SENTRY_ORG,
-      project: process.env.SENTRY_PROJECT,
+      authToken: process.env.SENTRY_AUTH_TOKEN || "",
+      org: process.env.SENTRY_ORG || "",
+      project: process.env.SENTRY_PROJECT || "",
       debug: true,
-      release: "0.0.11",
+      release: "0.0.14",
       include: "out/vite-smallNodeApp",
       cleanArtifacts: true,
+      // ignore: ["out/*", "!out/vite-smallNodeApp/index.js.map"],
+      ignore: ["!out/vite-smallNodeApp/index.js.map"],
+      ignoreFile: ".sentryignore",
     }),
   ],
 });