fix(schema|types): adds 'checksum' attribute to the module schema (#803)

sverweij · Apr 30, 2023 · deb7266 · deb7266
1 parent 79feaf4
commit deb7266
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 1 deletion.
diff --git a/src/schema/cruise-result.schema.js b/src/schema/cruise-result.schema.js
diff --git a/src/schema/cruise-result.schema.json b/src/schema/cruise-result.schema.json
@@ -102,6 +102,10 @@
         "instability": {
           "type": "number",
           "description": "number of dependents/ (number of dependents + number of dependencies)A measure for how stable the module is; ranging between 0 (completely stable module) to 1 (completely instable module). Derived from Uncle Bob's instability metric - but applied to a single module instead of to a group of them. This attribute is only present when dependency-cruiser was asked to calculate metrics."
+        },
+        "checksum": {
+          "type": "string",
+          "description": "checksum of the contents of the module. This attribute is currently only available when the cruise was executed with caching and the cache strategy is 'content'."
         }
       }
     },

diff --git a/tools/schema/modules.mjs b/tools/schema/modules.mjs
@@ -137,6 +137,13 @@ export default {
             "to a group of them. This attribute is only present when dependency-cruiser " +
             "was asked to calculate metrics.",
         },
+        checksum: {
+          type: "string",
+          description:
+            "checksum of the contents of the module. This attribute is currently " +
+            "only available when the cruise was executed with caching and the cache " +
+            "strategy is 'content'.",
+        },
       },
     },
     ReachableType: {

diff --git a/types/cruise-result.d.ts b/types/cruise-result.d.ts
@@ -139,6 +139,12 @@ export interface IModule {
    * was asked to calculate metrics.
    */
   instability?: number;
+  /**
+   * checksum of the contents of the module. This attribute is currently only
+   * available when the cruise was executed with caching and the cache strategy
+   * is 'content'.
+   */
+  checksum?: string;
 }
 
 export interface IDependency {