feat(main|cache|enrich): normalize the option, put it in the summary …

…and take it into account in cache dirty algorithm
sverweij · Jan 4, 2025 · 1344527 · 1344527
1 parent e007b8d
commit 1344527
Show file tree

Hide file tree

Showing 37 changed files with 99 additions and 108 deletions.
diff --git a/src/cache/options-compatible.mjs b/src/cache/options-compatible.mjs
@@ -106,6 +106,7 @@ export function optionsAreCompatible(pOldOptions, pNewOptions) {
     pOldOptions.combinedDependencies === pNewOptions.combinedDependencies &&
     pOldOptions.experimentalStats === pNewOptions.experimentalStats &&
     pOldOptions.detectJSDocImports === pNewOptions.detectJSDocImports &&
+    pOldOptions.skipAnalysisNotInRules === pNewOptions.skipAnalysisNotInRules &&
     metricsIsCompatible(pOldOptions.metrics, pNewOptions.metrics) &&
     // includeOnly suffers from a backwards compatibility disease
     includeOnlyIsCompatible(pOldOptions.includeOnly, pNewOptions.includeOnly) &&

diff --git a/src/enrich/summarize/summarize-options.mjs b/src/enrich/summarize/summarize-options.mjs
@@ -27,6 +27,7 @@ const SHAREABLE_OPTIONS = [
   "reaches",
   "reporterOptions",
   "rulesFile",
+  "skipAnalysisNotInRules",
   "tsConfig",
   "tsPreCompilationDeps",
   "webpackConfig",

diff --git a/src/main/options/defaults.mjs b/src/main/options/defaults.mjs
@@ -4,6 +4,7 @@ export default {
   maxDepth: 0,
   moduleSystems: ["es6", "cjs", "tsd", "amd"],
   detectJSDocImports: false,
+  skipAnalysisNotInRules: false,
   tsPreCompilationDeps: false,
   preserveSymlinks: false,
   combinedDependencies: false,

diff --git a/test/cli/__fixtures__/alternate-basedir/expected.json b/test/cli/__fixtures__/alternate-basedir/expected.json
@@ -30,6 +30,7 @@
       "outputTo": "test/cli/__output__/alternate-basedir.json",
       "outputType": "json",
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "tsPreCompilationDeps": false,
       "args": "src"
     },

diff --git a/test/cli/__fixtures__/babel/babel-es6-result.json b/test/cli/__fixtures__/babel/babel-es6-result.json
@@ -76,6 +76,7 @@
       "outputTo": "test/cli/__output__/babel-es6-result.json",
       "outputType": "json",
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "tsPreCompilationDeps": false,
       "webpackConfig": {
         "fileName": "test/cli/__fixtures__/babel/es6/webpack-cache-bust.config.js"

diff --git a/test/cli/__fixtures__/babel/babel-ts-result.json b/test/cli/__fixtures__/babel/babel-ts-result.json
@@ -202,6 +202,7 @@
       "outputTo": "test/cli/__output__/babel-ts-result.json",
       "outputType": "json",
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "tsPreCompilationDeps": false,
       "webpackConfig": {
         "fileName": "test/cli/__fixtures__/babel/ts/webpack-cache-bust.config.js"

diff --git a/test/cli/__fixtures__/cjs.dir.filtered.json b/test/cli/__fixtures__/cjs.dir.filtered.json
@@ -371,6 +371,7 @@
       "outputTo": "test/cli/__output__/cjs.dir.filtered.json",
       "outputType": "json",
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "tsPreCompilationDeps": false,
       "args": "test/cli/__fixtures__/cjs"
     }

diff --git a/test/cli/__fixtures__/cjs.dir.json b/test/cli/__fixtures__/cjs.dir.json
@@ -434,6 +434,7 @@
       "outputTo": "test/cli/__output__/cjs.dir.json",
       "outputType": "json",
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "tsPreCompilationDeps": false,
       "exoticRequireStrings": [],
       "args": "test/cli/__fixtures__/cjs"

diff --git a/test/cli/__fixtures__/cjs.dir.stdout.json b/test/cli/__fixtures__/cjs.dir.stdout.json
@@ -383,7 +383,8 @@
       "combinedDependencies": false,
       "detectJSDocImports": false,
       "exoticRequireStrings": [],
-      "externalModuleResolutionStrategy": "node_modules"
+      "externalModuleResolutionStrategy": "node_modules",
+      "skipAnalysisNotInRules": false
     }
   }
 }
diff --git a/test/cli/__fixtures__/cjs.file.json b/test/cli/__fixtures__/cjs.file.json
@@ -318,6 +318,7 @@
       "outputTo": "test/cli/__output__/cjs.file.json",
       "outputType": "json",
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "tsPreCompilationDeps": false,
       "exoticRequireStrings": [],
       "args": "test/cli/__fixtures__/cjs/root_one.js"

diff --git a/test/cli/__fixtures__/dynamic-import-nok.json b/test/cli/__fixtures__/dynamic-import-nok.json
@@ -49,6 +49,7 @@
       "outputTo": "test/cli/__output__/dynamic-import-nok.json",
       "outputType": "json",
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "tsConfig": {
         "fileName": "test/cli/__fixtures__/typescriptconfig/cli-dynamic-imports/tsconfig.error_on_compile_dynamic_imports.json"
       },

diff --git a/test/cli/__fixtures__/dynamic-import-ok.json b/test/cli/__fixtures__/dynamic-import-ok.json
@@ -49,6 +49,7 @@
       "outputTo": "test/cli/__output__/dynamic-import-ok.json",
       "outputType": "json",
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "tsConfig": {
         "fileName": "test/cli/__fixtures__/typescriptconfig/cli-dynamic-imports/tsconfig.compile_dynamic_imports.json"
       },

diff --git a/test/cli/__fixtures__/empty.json b/test/cli/__fixtures__/empty.json
@@ -18,6 +18,7 @@
       "tsPreCompilationDeps": false,
       "combinedDependencies": false,
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "externalModuleResolutionStrategy": "node_modules"
     }
   }

diff --git a/test/cli/__fixtures__/jsdoc-import-tags/expected.json b/test/cli/__fixtures__/jsdoc-import-tags/expected.json
@@ -56,6 +56,7 @@
       "outputType": "json",
       "parser": "tsc",
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "rulesFile": "dependency-cruiser-config.mjs",
       "tsPreCompilationDeps": false,
       "args": "src/index.mjs"

diff --git a/test/cli/__fixtures__/multiple-in-one-go.json b/test/cli/__fixtures__/multiple-in-one-go.json
@@ -162,6 +162,7 @@
       "outputTo": "test/cli/__output__/multiple-in-one-go.json",
       "outputType": "json",
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "tsPreCompilationDeps": false,
       "exoticRequireStrings": [],
       "args": "test/cli/__fixtures__/cjs/sub test/cli/__fixtures__/duplicate-subs/sub/more-in-sub.js test/cli/__fixtures__/unresolvable-in-sub"

diff --git a/test/cli/__fixtures__/result-has-a-dependency-violation.json b/test/cli/__fixtures__/result-has-a-dependency-violation.json
@@ -9287,6 +9287,7 @@
       "prefix": "https://github.com/sverweij/dependency-cruiser/blob/develop/",
       "preserveSymlinks": false,
       "rulesFile": ".dependency-cruiser.json",
+      "skipAnalysisNotInRules": false,
       "tsPreCompilationDeps": true,
       "exoticRequireStrings": ["tryRequire", "requireJSON"],
       "reporterOptions": {

diff --git a/test/cli/__fixtures__/typescript-path-resolution.json b/test/cli/__fixtures__/typescript-path-resolution.json
@@ -84,6 +84,7 @@
       "outputTo": "test/cli/__output__/typescript-path-resolution.json",
       "outputType": "json",
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "tsPreCompilationDeps": false,
       "tsConfig": {
         "fileName": "test/cli/__fixtures__/typescriptconfig/cli-config-with-path/tsconfig.json"

diff --git a/test/cli/__fixtures__/webpack-config-alias-cruiser-config.json b/test/cli/__fixtures__/webpack-config-alias-cruiser-config.json
@@ -78,6 +78,7 @@
       "outputType": "json",
       "preserveSymlinks": false,
       "rulesFile": "test/cli/__fixtures__/webpackconfig/aliassy/dependency-cruiser-json-with-webpack-config.json",
+      "skipAnalysisNotInRules": false,
       "tsPreCompilationDeps": false,
       "webpackConfig": {
         "fileName": "test/cli/__fixtures__/webpackconfig/aliassy/webpack.regularexport.config.js"

diff --git a/test/cli/__fixtures__/webpack-config-alias.json b/test/cli/__fixtures__/webpack-config-alias.json
@@ -77,6 +77,7 @@
       "outputTo": "test/cli/__output__/webpack-config-alias.json",
       "outputType": "json",
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "tsPreCompilationDeps": false,
       "webpackConfig": {
         "fileName": "test/cli/__fixtures__/webpackconfig/aliassy/webpack.regularexport.config.js"

diff --git a/test/cli/__fixtures__/workspaces-mono-repo-aliases/expected.json b/test/cli/__fixtures__/workspaces-mono-repo-aliases/expected.json
@@ -223,6 +223,7 @@
       "outputType": "json",
       "preserveSymlinks": false,
       "rulesFile": ".dependency-cruiser.js",
+      "skipAnalysisNotInRules": false,
       "tsConfig": {
         "fileName": "tsconfig.json"
       },

diff --git a/test/cli/__fixtures__/workspaces-mono-repo/expected.json b/test/cli/__fixtures__/workspaces-mono-repo/expected.json
@@ -239,6 +239,7 @@
       "outputTo": "test/cli/__output__/workspaces-mono-repo.json",
       "outputType": "json",
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "tsPreCompilationDeps": false,
       "args": "apps"
     },

diff --git a/test/main/__fixtures__/jsx-as-object.json b/test/main/__fixtures__/jsx-as-object.json
@@ -8,11 +8,11 @@
           "moduleSystem": "cjs",
           "dynamic": false,
           "exoticallyRequired": false,
+          "dependencyTypes": ["local", "require"],
           "resolved": "test/main/__mocks__/jsx/jsx.jsx",
           "coreModule": false,
           "followable": true,
           "couldNotResolve": false,
-          "dependencyTypes": ["local", "require"],
           "matchesDoNotFollow": false,
           "circular": false,
           "valid": true
@@ -30,11 +30,11 @@
           "moduleSystem": "es6",
           "dynamic": false,
           "exoticallyRequired": false,
+          "dependencyTypes": ["unknown"],
           "resolved": "components/pay-method-choice",
           "coreModule": false,
           "followable": false,
           "couldNotResolve": true,
-          "dependencyTypes": ["unknown"],
           "matchesDoNotFollow": false,
           "circular": false,
           "valid": true
@@ -44,11 +44,11 @@
           "moduleSystem": "es6",
           "dynamic": false,
           "exoticallyRequired": false,
+          "dependencyTypes": ["unknown"],
           "resolved": "components/product-detail",
           "coreModule": false,
           "followable": false,
           "couldNotResolve": true,
-          "dependencyTypes": ["unknown"],
           "matchesDoNotFollow": false,
           "circular": false,
           "valid": true
@@ -58,11 +58,11 @@
           "moduleSystem": "es6",
           "dynamic": false,
           "exoticallyRequired": false,
+          "dependencyTypes": ["unknown"],
           "resolved": "products",
           "coreModule": false,
           "followable": false,
           "couldNotResolve": true,
-          "dependencyTypes": ["unknown"],
           "matchesDoNotFollow": false,
           "circular": false,
           "valid": true
@@ -72,11 +72,11 @@
           "moduleSystem": "es6",
           "dynamic": false,
           "exoticallyRequired": false,
+          "dependencyTypes": ["unknown"],
           "resolved": "react",
           "coreModule": false,
           "followable": false,
           "couldNotResolve": true,
-          "dependencyTypes": ["unknown"],
           "matchesDoNotFollow": false,
           "circular": false,
           "valid": true
@@ -86,11 +86,11 @@
           "moduleSystem": "es6",
           "dynamic": false,
           "exoticallyRequired": false,
+          "dependencyTypes": ["unknown"],
           "resolved": "tracking",
           "coreModule": false,
           "followable": false,
           "couldNotResolve": true,
-          "dependencyTypes": ["unknown"],
           "matchesDoNotFollow": false,
           "circular": false,
           "valid": true
@@ -100,11 +100,11 @@
           "moduleSystem": "es6",
           "dynamic": false,
           "exoticallyRequired": false,
+          "dependencyTypes": ["unknown"],
           "resolved": "utils",
           "coreModule": false,
           "followable": false,
           "couldNotResolve": true,
-          "dependencyTypes": ["unknown"],
           "matchesDoNotFollow": false,
           "circular": false,
           "valid": true
@@ -203,6 +203,7 @@
       "metrics": false,
       "moduleSystems": ["es6", "cjs", "tsd", "amd"],
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "tsPreCompilationDeps": false,
       "args": "test/main/__mocks__/jsx"
     },

diff --git a/test/main/__fixtures__/jsx.json b/test/main/__fixtures__/jsx.json
@@ -8,11 +8,11 @@
           "moduleSystem": "cjs",
           "dynamic": false,
           "exoticallyRequired": false,
+          "dependencyTypes": ["local", "require"],
           "resolved": "test/main/__mocks__/jsx/jsx.jsx",
           "coreModule": false,
           "followable": true,
           "couldNotResolve": false,
-          "dependencyTypes": ["local", "require"],
           "matchesDoNotFollow": false,
           "circular": false,
           "valid": true
@@ -30,11 +30,11 @@
           "moduleSystem": "es6",
           "dynamic": false,
           "exoticallyRequired": false,
+          "dependencyTypes": ["unknown"],
           "resolved": "components/pay-method-choice",
           "coreModule": false,
           "followable": false,
           "couldNotResolve": true,
-          "dependencyTypes": ["unknown"],
           "matchesDoNotFollow": false,
           "circular": false,
           "valid": true
@@ -44,11 +44,11 @@
           "moduleSystem": "es6",
           "dynamic": false,
           "exoticallyRequired": false,
+          "dependencyTypes": ["unknown"],
           "resolved": "components/product-detail",
           "coreModule": false,
           "followable": false,
           "couldNotResolve": true,
-          "dependencyTypes": ["unknown"],
           "matchesDoNotFollow": false,
           "circular": false,
           "valid": true
@@ -58,11 +58,11 @@
           "moduleSystem": "es6",
           "dynamic": false,
           "exoticallyRequired": false,
+          "dependencyTypes": ["unknown"],
           "resolved": "products",
           "coreModule": false,
           "followable": false,
           "couldNotResolve": true,
-          "dependencyTypes": ["unknown"],
           "matchesDoNotFollow": false,
           "circular": false,
           "valid": true
@@ -72,11 +72,11 @@
           "moduleSystem": "es6",
           "dynamic": false,
           "exoticallyRequired": false,
+          "dependencyTypes": ["unknown"],
           "resolved": "react",
           "coreModule": false,
           "followable": false,
           "couldNotResolve": true,
-          "dependencyTypes": ["unknown"],
           "matchesDoNotFollow": false,
           "circular": false,
           "valid": true
@@ -86,11 +86,11 @@
           "moduleSystem": "es6",
           "dynamic": false,
           "exoticallyRequired": false,
+          "dependencyTypes": ["unknown"],
           "resolved": "tracking",
           "coreModule": false,
           "followable": false,
           "couldNotResolve": true,
-          "dependencyTypes": ["unknown"],
           "matchesDoNotFollow": false,
           "circular": false,
           "valid": true
@@ -100,11 +100,11 @@
           "moduleSystem": "es6",
           "dynamic": false,
           "exoticallyRequired": false,
+          "dependencyTypes": ["unknown"],
           "resolved": "utils",
           "coreModule": false,
           "followable": false,
           "couldNotResolve": true,
-          "dependencyTypes": ["unknown"],
           "matchesDoNotFollow": false,
           "circular": false,
           "valid": true
@@ -203,6 +203,7 @@
       "metrics": false,
       "moduleSystems": ["es6", "cjs", "tsd", "amd"],
       "preserveSymlinks": false,
+      "skipAnalysisNotInRules": false,
       "tsPreCompilationDeps": false,
       "args": "test/main/__mocks__/jsx"
     }