feature(validate): adds a dependents count validation (sverweij#449)

.dependency-cruiser.json

@@ -181,6 +181,7 @@
     },
     {
       "name": "not-reachable-from-folder-index",
+      "comment": "(sample rule to demo reachable rules with capturing groups)",
       "severity": "info",
       "from": {
         "path": "^src/([^/]+)/index\\.js$"
@@ -189,6 +190,13 @@
         "path": "^src/$1/",
         "reachable": false
       }
+    },
+    {
+      "name": "utl-module-not-shared-enough",
+      "comment": "(sample rule to demo demo rules based on dependents)",
+      "severity": "info",
+      "from": { "path": "^src" },
+      "module": { "path": "^src/utl", "numberOfDependentsLessThan": 3 }
     }
   ],
   "options": {
@@ -387,8 +395,6 @@
         }
       }
     },
-    // "progress": { "type": "cli-feedback" }
     "progress": { "type": "performance-log" }
-    // "progress": {"type": "none"}
   }
 }

doc/options-reference.md

@@ -25,6 +25,7 @@
   - [mono repo behaviour - combinedDependencies](#mono-repo-behaviour---combinedDependencies)
   - [exotic ways to require modules - exoticRequireStrings](#exotic-ways-to-require-modules---exoticrequirestrings)
   - [enhancedResolveOptions](#enhancedresolveoptions)
+  - [forceDeriveDependents](#forcederivedependents)
 
 ## Filters
 
@@ -1178,3 +1179,9 @@ E.g. to set the cache duration to 1337ms, you can use this:
 The cache duration is limited from 0ms (~ don't use a cache) to 1800000ms (0.5h).
 
 The cacheDuration used here overrides any that might be set in webpack configs.
+
+### `forceDeriveDependents`
+
+Dependency-cruiser will automatically determine whether it needs to derive dependents.
+However, if you want to force them to be derived, you can switch this variable
+to `true`.

doc/recipes/internal-orphans/.dependency-cruiser-options-only.js

@@ -0,0 +1,40 @@
+/** @type {import('dependency-cruiser').IConfiguration} */
+/** @type {import('../../..').IConfiguration} */
+module.exports = {
+  options: {
+    tsPreCompilationDeps: true,
+    baseDir: "src",
+
+    reporterOptions: {
+      dot: {
+        collapsePattern: "node_modules/[^/]+",
+        theme: {
+          graph: {
+            splines: "ortho",
+            rankdir: "TD",
+          },
+          modules: [
+            {
+              criteria: { source: "^common" },
+              attributes: { fillcolor: "#cccccc" },
+            },
+          ],
+          dependencies: [
+            {
+              criteria: { "rules[0].severity": "error" },
+              attributes: { fontcolor: "red", color: "red" },
+            },
+            {
+              criteria: { "rules[0].severity": "warn" },
+              attributes: { fontcolor: "orange", color: "orange" },
+            },
+            {
+              criteria: { "rules[0].severity": "info" },
+              attributes: { fontcolor: "blue", color: "blue" },
+            },
+          ],
+        },
+      },
+    },
+  },
+};

doc/recipes/internal-orphans/.dependency-cruiser-with-rules.js

@@ -0,0 +1,17 @@
+const options = require("./.dependency-cruiser-options-only");
+
+/** @type {import('dependency-cruiser').IConfiguration} */
+module.exports = {
+  forbidden: [
+    {
+      name: "no-unshared-utl",
+      severity: "error",
+      from: {},
+      module: {
+        path: "^do-things/",
+        numberOfDependentsLessThan: 1,
+      },
+    },
+  ],
+  ...options,
+};