refactor(enrich): put summarization in separate folder

src/enrich/summarize.js → src/enrich/summarize/index.js

@@ -1,18 +1,18 @@
+const addRuleSetUsed = require("./add-rule-set-used");
 const summarizeModules = require("./summarize-modules");
 const summarizeOptions = require("./summarize-options");
-const addRuleSetUsed = require("./add-rule-set-used");
 
 /**
  *
- * @param {import("../../types/cruise-result").IModule[]} pModules -
+ * @param {import("../../../types/cruise-result").IModule[]} pModules -
  *    cruised modules that have been enriched with mandatory attributes &
  *    have been validated against rules as passed in the options
- * @param {import("../../types/options").ICruiseOptions} pOptions -
+ * @param {import("../../../types/options").ICruiseOptions} pOptions -
  *
  * @param {string[]} pFileDirectoryArray -
  *    the files/ directories originally passed to be cruised
  *
- * @returns {import("../../types/cruise-result").ISummary} -
+ * @returns {import("../../../types/cruise-result").ISummary} -
  *    a summary of the found modules, dependencies and any violations
  */
 module.exports = function makeSummary(pModules, pOptions, pFileDirectoryArray) {

src/enrich/summarize-modules.js → src/enrich/summarize/summarize-modules.js

@@ -1,7 +1,7 @@
 const _flattenDeep = require("lodash/flattenDeep");
 const _get = require("lodash/get");
-const findRuleByName = require("../graph-utl/find-rule-by-name");
-const compare = require("../graph-utl/compare");
+const findRuleByName = require("../../graph-utl/find-rule-by-name");
+const compare = require("../../graph-utl/compare");
 const deDuplicateViolations = require("./de-duplicate-violations");
 
 function cutNonTransgressions(pSourceEntry) {

src/main/index.js

@@ -3,7 +3,7 @@ const _get = require("lodash/get");
 const _has = require("lodash/has");
 const extract = require("../extract");
 const enrich = require("../enrich");
-const summarizeModules = require("../enrich/summarize-modules");
+const summarizeModules = require("../enrich/summarize/summarize-modules");
 const cruiseResultSchema = require("../schema/cruise-result.schema.json");
 const meta = require("../extract/transpile/meta");
 const report = require("../report");

test/enrich/de-duplicate-violations.spec.js

@@ -1,5 +1,5 @@
 const { expect } = require("chai");
-const deDuplicateViolations = require("../../src/enrich/de-duplicate-violations");
+const deDuplicateViolations = require("../../src/enrich/summarize/de-duplicate-violations");
 
 describe("enrich/de-duplicate-violations", () => {
   it("no violations => no violations", () => {

test/enrich/summarize-modules.spec.js

@@ -1,5 +1,5 @@
 const chai = require("chai");
-const summarize = require("../../src/enrich/summarize-modules");
+const summarize = require("../../src/enrich/summarize/summarize-modules");
 
 const expect = chai.expect;