Allow relative AND absolute paths when ignoring directories (#150)

Fixes #149

Author: jamesrweb

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## [Unreleased]
 
+- The `--ignore-dirs` and `--ignore-files` flags now support absolute paths. Thanks [@jamesrweb](https://github.com/jamesrweb)!
+
 ## [2.11.1] - 2024-03-16
 
 - Fixed a crash when running in watch mode related to not being able to fetch cache results.

lib/options.js

@@ -191,6 +191,20 @@ try re-running it with ${chalk.cyan('--elmjson <path-to-elm.json>')}.`,
     license
   };
 
+  /**
+   * Converts absolute to relative paths.
+   *
+   * @param {Path} filePath
+   * @returns {Path}
+   */
+  function absolutePathsToRelative(filePath) {
+    if (path.isAbsolute(filePath)) {
+      return path.relative(projectToReview(), filePath);
+    }
+
+    return filePath;
+  }
+
   return {
     debug: args.debug,
     showBenchmark: args['benchmark-info'],
@@ -219,8 +233,10 @@ try re-running it with ${chalk.cyan('--elmjson <path-to-elm.json>')}.`,
     report: args.report === 'json' || args.report === 'ndjson' ? 'json' : null,
     reportOnOneLine: args.report === 'ndjson',
     rulesFilter: listOfStrings(args.rules),
-    ignoredDirs: listOfStrings(args['ignore-dirs']) || [],
-    ignoredFiles: listOfStrings(args['ignore-files']) || [],
+    ignoredDirs: () =>
+      (listOfStrings(args['ignore-dirs']) || []).map(absolutePathsToRelative),
+    ignoredFiles: () =>
+      (listOfStrings(args['ignore-files']) || []).map(absolutePathsToRelative),
 
     // TEMPORARY WORKAROUNDS
     ignoreProblematicDependencies: args['ignore-problematic-dependencies'],

lib/result-cache.js

@@ -31,8 +31,8 @@ async function load(options, cacheFolder) {
   if (
     options.debug ||
     options.directoriesToAnalyze.length > 0 ||
-    options.ignoredDirs.length > 0 ||
-    options.ignoredFiles.length > 0
+    options.ignoredDirs().length > 0 ||
+    options.ignoredFiles().length > 0
   ) {
     // TODO Breaking change: When we drop support for Node.js v10, use `globalThis` everywhere instead of `global`
     global.loadResultFromCache = () => null;

lib/runner.js

@@ -111,8 +111,8 @@ async function initializeApp(options, elmModulePath, reviewElmJson, appHash) {
     rulesFilter: options.rulesFilter,
     ignoreProblematicDependencies: options.ignoreProblematicDependencies,
     directoriesToAnalyze: options.directoriesToAnalyze,
-    ignoredDirs: options.ignoredDirs,
-    ignoredFiles: options.ignoredFiles,
+    ignoredDirs: options.ignoredDirs(),
+    ignoredFiles: options.ignoredFiles(),
     writeSuppressionFiles: options.directoriesToAnalyze.length === 0
   });
 

lib/types/options.d.ts

@@ -28,8 +28,8 @@ export type Options = {
   report: ReportMode;
   reportOnOneLine: boolean;
   rulesFilter: string[] | null;
-  ignoredDirs: string[];
-  ignoredFiles: string[];
+  ignoredDirs: () => string[];
+  ignoredFiles: () => string[];
   ignoreProblematicDependencies: boolean;
   prefilledAnswers: NewPackagePrefilledAnswers;