refactor: deps cruiser rules, + generated dependency graph

Author: Sairyss

.dependency-cruiser.js

@@ -1,17 +1,17 @@
 /** @type {import('dependency-cruiser').IConfiguration} */
 
-const applicationLayerPaths = [
-  'application',
+const apiLayerPaths = [
   'controller',
   'dtos',
   'request',
   'response',
   'dto\\.ts$',
   'controller\\.ts$',
   'resolver\\.ts$',
-  '\\.service\\.ts$',
 ];
 
+const applicationLayerPaths = ['application', '\\.service\\.ts$'];
+
 const infrastructureLayerPaths = [
   'infrastructure',
   'infra',
@@ -30,14 +30,23 @@ const domainLayerPaths = [
 module.exports = {
   forbidden: [
     /* user defined rules */
+    {
+      name: 'no-domain-to-api-deps',
+      comment: 'Domain layer cannot depend on api layer',
+      severity: 'error',
+      from: { path: domainLayerPaths },
+      to: {
+        path: apiLayerPaths,
+      },
+    },
     {
       name: 'no-domain-to-app-deps',
       comment: 'Domain layer cannot depend on application layer',
       severity: 'error',
       from: { path: domainLayerPaths },
       to: {
         path: applicationLayerPaths,
-        pathNot: ['AppRequestContext\\.ts$'],
+        pathNot: ['AppRequestContext\\.ts'],
       },
     },
     {
@@ -51,18 +60,17 @@ module.exports = {
       },
     },
     {
-      name: 'no-infra-to-app-deps',
-      comment: 'Infrastructure layer cannot depend on application layer',
+      name: 'no-infra-to-api-deps',
+      comment: 'Infrastructure layer cannot depend on api layer',
       severity: 'error',
       from: { path: infrastructureLayerPaths },
       to: {
-        path: applicationLayerPaths,
-        pathNot: ['AppRequestContext\\.ts$'],
+        path: apiLayerPaths,
       },
     },
     {
-      name: 'query-deps',
-      comment: 'Commands and Queries cannot depend on application layer',
+      name: 'no-command-query-to-api-deps',
+      comment: 'Commands and Queries cannot depend on api layer',
       severity: 'error',
       from: {
         path: [
@@ -73,23 +81,22 @@ module.exports = {
         ],
       },
       to: {
-        path: applicationLayerPaths,
-        pathNot: ['AppRequestContext\\.ts$'],
+        path: apiLayerPaths,
       },
     },
 
     /* rules from the 'recommended' preset: */
-    {
-      name: 'no-circular',
-      severity: 'warn',
-      comment:
-        'This dependency is part of a circular relationship. You might want to revise ' +
-        'your solution (i.e. use dependency inversion, make sure the modules have a single responsibility) ',
-      from: {},
-      to: {
-        circular: true,
-      },
-    },
+    // {
+    //   name: 'no-circular',
+    //   severity: 'warn',
+    //   comment:
+    //     'This dependency is part of a circular relationship. You might want to revise ' +
+    //     'your solution (i.e. use dependency inversion, make sure the modules have a single responsibility) ',
+    //   from: {},
+    //   to: {
+    //     circular: true,
+    //   },
+    // },
     {
       name: 'no-orphans',
       comment:
@@ -98,7 +105,7 @@ module.exports = {
         'add an exception for it in your dependency-cruiser configuration. By default ' +
         'this rule does not scrutinize dot-files (e.g. .eslintrc.js), TypeScript declaration ' +
         'files (.d.ts), tsconfig.json and some of the babel and webpack configs.',
-      severity: 'warn',
+      severity: 'error',
       from: {
         orphan: true,
         pathNot: [
@@ -115,7 +122,7 @@ module.exports = {
       comment:
         'A module depends on a node core module that has been deprecated. Find an alternative - these are ' +
         "bound to exist - node doesn't deprecate lightly.",
-      severity: 'warn',
+      severity: 'error',
       from: {},
       to: {
         dependencyTypes: ['core'],
@@ -148,7 +155,7 @@ module.exports = {
       comment:
         'This module uses a (version of an) npm module that has been deprecated. Either upgrade to a later ' +
         'version of that module, or find an alternative. Deprecated modules are a security risk.',
-      severity: 'warn',
+      severity: 'error',
       from: {},
       to: {
         dependencyTypes: ['deprecated'],
@@ -184,7 +191,7 @@ module.exports = {
         "Likely this module depends on an external ('npm') package that occurs more than once " +
         'in your package.json i.e. bot as a devDependencies and in dependencies. This will cause ' +
         'maintenance problems later on.',
-      severity: 'warn',
+      severity: 'error',
       from: {},
       to: {
         moreThanOneDependencyType: true,
@@ -260,7 +267,7 @@ module.exports = {
         'in your package.json. This makes sense if your package is e.g. a plugin, but in ' +
         'other cases - maybe not so much. If the use of a peer dependency is intentional ' +
         'add an exception to your dependency-cruiser configuration.',
-      severity: 'warn',
+      severity: 'error',
       from: {},
       to: {
         dependencyTypes: ['npm-peer'],

README.md

@@ -1223,6 +1223,14 @@ For example:
 
 Snippet of code above will prevent your domain layer to depend on the application layer, controllers, etc. Simplified example config: [.dependency-cruiser.js](.dependency-cruiser.js)
 
+You can also generate graphs like this:
+
+<details>
+<summary>Click to see dependency graph</summary>
+ <img src="dependency-graph.svg" alt="Dependency graph"> 
+</details>
+<br>
+
 Example tools:
 
 - [Dependency cruiser](https://github.com/sverweij/dependency-cruiser) - Validate and visualize dependencies for JavaScript / TypeScript.