dependency-cruiser 11.7.0 → 11.7.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "11.7.0",
+  "version": "11.7.1",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -98,7 +98,7 @@
     "lint:prettier": "prettier --loglevel warn --check \"src/**/*.js\" \"configs/**/*.js\" \"tools/**/*.mjs\" \"bin/*\" \"types/*.d.ts\" \"test/**/*.spec.{cjs,js}\" \"test/**/*.{spec,utl}.mjs\"",
     "lint:prettier:fix": "prettier --loglevel warn --write \"src/**/*.js\" \"configs/**/*.js\" \"tools/**/*.mjs\" \"bin/*\" \"types/*.d.ts\" \"test/**/*.spec.{cjs,js}\" \"test/**/*.{spec,utl}.mjs\"",
     "lint:types": "npm-run-all lint:types:tsc lint:types:lint",
-    "lint:types:tsc": "tsc --noEmit --strict --types --noUnusedLocals --noUnusedParameters types/dependency-cruiser.d.ts",
+    "lint:types:tsc": "tsc --project types/tsconfig.json",
     "lint:types:lint": "eslint --no-ignore --config types/.eslintrc.json types/*.d.ts",
     "lint:types:fix": "eslint --no-ignore --config types/.eslintrc.json --fix types/*.d.ts",
     "scm:push": "run-p --aggregate-output scm:push:*",
@@ -163,18 +163,20 @@
     "@babel/core": "7.17.10",
     "@babel/plugin-transform-modules-commonjs": "7.17.9",
     "@babel/preset-typescript": "7.16.7",
-    "@swc/core": "1.2.174",
-    "@typescript-eslint/eslint-plugin": "5.21.0",
-    "@typescript-eslint/parser": "5.21.0",
+    "@swc/core": "1.2.183",
+    "@types/lodash": "4.14.182",
+    "@types/node": "17.0.33",
+    "@typescript-eslint/eslint-plugin": "5.23.0",
+    "@typescript-eslint/parser": "5.23.0",
     "@vue/compiler-sfc": "3.2.33",
     "c8": "7.11.2",
     "chai": "4.3.6",
     "chai-json-schema": "1.5.1",
     "coffeescript": "2.7.0",
-    "eslint": "^8.14.0",
+    "eslint": "^8.15.0",
     "eslint-config-moving-meadow": "3.0.0",
     "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-budapestian": "3.0.1",
+    "eslint-plugin-budapestian": "3.0.2",
     "eslint-plugin-import": "2.26.0",
     "eslint-plugin-mocha": "^9.0.0",
     "eslint-plugin-node": "11.1.0",
@@ -206,7 +208,7 @@
       {
         "package": "eslint-plugin-mocha",
         "policy": "wanted",
-        "because": "version 10 dropped support for node 12, which we still do support"
+        "because": "version 10 bumps into https://github.com/lo1tuma/eslint-plugin-mocha/issues/322"
       },
       {
         "package": "figures",

package/src/cli/format.js

@@ -15,6 +15,12 @@ const KNOWN_FMT_OPTIONS = [
   "version",
 ];
 
+/**
+ *
+ * @param {string} pResultFile the name of the file with cruise results
+ * @param {import("../../types/dependency-cruiser").IFormatOptions} pOptions
+ * @returns {Number} an exitCode
+ */
 module.exports = async (pResultFile, pOptions) => {
   const lOptions = normalizeOptions(pOptions, KNOWN_FMT_OPTIONS);
 

package/src/enrich/index.js

@@ -3,6 +3,19 @@ const aggregateToFolders = require("./derive/folders");
 const summarize = require("./summarize");
 const clearCaches = require("./clear-caches");
 
+/**
+ * Enriches the passed modules with things like cycle detection, validations,
+ * metrics, folders and reachability & dependents analysis.
+ *
+ * Also adds a summary to the cruise result with common stats and the options
+ * used in the cruise, so consumers of the cruise result (reporters, depcruise-fmt,
+ * caching) can use that.
+ *
+ * @param {import("../../types/dependency-cruiser").IModule[]} pModules
+ * @param {import("../../types/dependency-cruiser").ICruiseOptions} pOptions
+ * @param {string[]} pFileAndDirectoryArray
+ * @returns {import("../../types/dependency-cruiser").ICruiseResult}
+ */
 module.exports = function enrich(pModules, pOptions, pFileAndDirectoryArray) {
   clearCaches();
   const lModules = enrichModules(pModules, pOptions);

package/src/extract/ast-extractors/swc-dependency-visitor.js

@@ -148,7 +148,9 @@ if (VisitorModule) {
     visitExportAllDeclration(pNode) {
       this.pushImportExportSource(pNode);
       /* c8 ignore start */
+      // @ts-ignore
       if (super.visitExportAllDeclration) {
+        // @ts-ignore
         return super.visitExportAllDeclration(pNode);
       } else {
         /* c8 ignore stop */
@@ -166,7 +168,9 @@ if (VisitorModule) {
     visitExportNamedDeclration(pNode) {
       this.pushImportExportSource(pNode);
       /* c8 ignore start */
+      // @ts-ignore
       if (super.visitExportNamedDeclration) {
+        // @ts-ignore
         return super.visitExportNamedDeclration(pNode);
       } else {
         /* c8 ignore stop */

package/src/extract/gather-initial-sources.js

@@ -84,7 +84,7 @@ function gatherScannableFilesFromDirectory(pDirectoryName, pOptions) {
  *
  * @param  {string[]} pFileAndDirectoryArray globs and/ or paths to files or
  *                               directories to be gathered
- * @param  {import('../../types/options').ICruiseOptions} pOptions options that
+ * @param  {import('../../types/dependency-cruiser').ICruiseOptions} pOptions options that
  *                               influence what needs to be gathered/ scanned
  *                               notably useful attributes:
  *                               - exclude - regexp of what to exclude

package/src/extract/get-dependencies.js

@@ -108,13 +108,13 @@ function extractWithTsc(
 
 /**
  *
- * @param {import('../../types/options').ICruiseOptions} pCruiseOptions
+ * @param {import('../../types/dependency-cruiser').ICruiseOptions} pCruiseOptions
  * @param {string} pFileName
  * @param {any} pTranspileOptions
- * @returns {Partial<import('../../types/cruise-result').IDependency[]>}
+ * @returns {import('../../types/cruise-result').IDependency[]}
  */
 function extractDependencies(pCruiseOptions, pFileName, pTranspileOptions) {
-  /** @type Partial<import('../../types/cruise-result').IDependency[]> */
+  /** @type import('../../types/cruise-result').IDependency[] */
   let lDependencies = [];
 
   if (!pCruiseOptions.extraExtensionsToScan.includes(path.extname(pFileName))) {
@@ -208,9 +208,9 @@ function compareDeps(pLeft, pRight) {
  *
  *
  * @param  {string} pFileName path to the file
- * @param  {import("../../../types/dependency-cruiser").ICruiseOptions} pCruiseOptions cruise options
- * @param {import("../../types/resolve-options").IResolveOptions} pResolveOptions  webpack 'enhanced-resolve' options
- * @param  {any} pTranspileOptions       an object with tsconfig ('typescript project') options
+ * @param  {import("../../types/dependency-cruiser").ICruiseOptions} pCruiseOptions cruise options
+ * @param {import("../../types/dependency-cruiser").IResolveOptions} pResolveOptions  webpack 'enhanced-resolve' options
+ * @param  {import("../../types/dependency-cruiser").ITranspileOptions} pTranspileOptions       an object with tsconfig ('typescript project') options
  *                               ('flattened' so there's no need for file access on any
  *                               'extends' option in there)
  * @return {import("../../types/dependency-cruiser").IDependency[]} an array of dependency objects (see above)

package/src/extract/index.js

@@ -136,6 +136,16 @@ function filterExcludedDynamicDependencies(pModule, pExclude) {
   };
 }
 
+/**
+ * Recursively runs through the modules matching the pFileDirectoryArray and
+ * returns an array of all the modules it finds that way.
+ *
+ * @param {string[]} pFileDirectoryArray
+ * @param {import("../../types/dependency-cruiser").ICruiseOptions} pCruiseOptions
+ * @param {import("../../types/dependency-cruiser").IResolveOptions} pResolveOptions
+ * @param {import("../../types/dependency-cruiser").ITranspileOptions} pTranspileOptions
+ * @returns {Partial<import("../../types/dependency-cruiser").IModule[]>}
+ */
 module.exports = function extract(
   pFileDirectoryArray,
   pCruiseOptions,

package/src/extract/parse/to-javascript-ast.js

@@ -7,6 +7,7 @@ const _memoize = require("lodash/memoize");
 const transpile = require("../transpile");
 const getExtension = require("../utl/get-extension");
 
+/** @type acorn.Options */
 const ACORN_OPTIONS = {
   sourceType: "module",
   ecmaVersion: 11,
@@ -33,6 +34,11 @@ function getASTFromSource(pFileRecord, pTranspileOptions) {
     if (needsJSXTreatment(pFileRecord, pTranspileOptions)) {
       return acornJsxParser.parse(lJavaScriptSource, {
         ...ACORN_OPTIONS,
+        // @ts-ignore
+        // acornJsxParser.parse takes an acorn.Options which doesn't include
+        // allowNamespacedObjects. acornJsx.Options doesn't include sourceType
+        // though, so a bit rock < this code > hard place hence ignore it
+        // type wise
         allowNamespacedObjects: true,
       });
     }
@@ -55,7 +61,7 @@ function getASTFromSource(pFileRecord, pTranspileOptions) {
  * @param {string} pFileName      path to the file to be parsed
  * @param {any} pTranspileOptions options for the transpiler(s) - a tsconfig or
  *                                a babel config
- * @returns {any}              the abstract syntax tree
+ * @returns {acorn.Node}              the abstract syntax tree
  */
 function getAST(pFileName, pTranspileOptions) {
   return getASTFromSource(
@@ -87,7 +93,7 @@ module.exports = {
    *
    * @param {string} pFileName - the name of the file to compile
    * @param {any} pTranspileOptions - options for the transpiler(s) - typically a tsconfig or a babel config
-   * @return {any} - a (typescript) AST
+   * @return {acorn.Node} - a (javascript) AST
    */
   getASTCached,
 

package/src/extract/parse/to-swc-ast.js

@@ -22,6 +22,7 @@ function getASTFromSource(pSource) {
 }
 
 function getAST(pFileName) {
+  /** @type {import('@swc/core')} swc */
   return swc.parseFileSync(pFileName, SWC_PARSE_OPTIONS);
 }
 
@@ -38,6 +39,7 @@ module.exports = {
    * @return {boolean} - true if the swc compiler is available,
    *                     false in all other cases
    */
+  // @ts-ignore
   isAvailable: () => swc !== false,
 
   /**

package/src/extract/parse/to-typescript-ast.js

@@ -63,6 +63,7 @@ module.exports = {
    * @return {boolean} - true if the typescript compiler is available,
    *                     false in all other cases
    */
+  // @ts-ignore
   isAvailable: () => typescript !== false,
 
   /**

package/src/extract/resolve/determine-dependency-types.js

@@ -47,6 +47,7 @@ function determineManifestDependencyTypes(
   pPackageDependencies,
   pResolverModulePaths
 ) {
+  /** @type {import("../../../types/shared-types").DependencyType[]} */
   let lReturnValue = ["npm-unknown"];
 
   if (Boolean(pPackageDependencies)) {
@@ -90,12 +91,21 @@ function dependencyIsBundled(pModule, pPackageDeps) {
   return lReturnValue;
 }
 
+/**
+ *
+ * @param {string} pModuleName
+ * @param {string} pPackageDeps
+ * @param {string} pFileDirectory
+ * @param {import("../../../types/dependency-cruiser").IResolveOptions} pResolveOptions
+ * @returns {import("../../../types/shared-types").DependencyType[]}
+ */
 function determineNodeModuleDependencyTypes(
   pModuleName,
   pPackageDeps,
   pFileDirectory,
   pResolveOptions
 ) {
+  /** @type {import("../../../types/shared-types").DependencyType[]} */
   let lReturnValue = determineManifestDependencyTypes(
     externalModuleHelpers.getPackageRoot(pModuleName),
     pPackageDeps,
@@ -117,17 +127,30 @@ function determineNodeModuleDependencyTypes(
   return lReturnValue;
 }
 
+/**
+ *
+ * @param {import("../../../types/cruise-result").IDependency} pDependency
+ * @param {string} pModuleName
+ * @param {any} pPackageDeps
+ * @param {string} pFileDirectory
+ * @param {import("../../../types/dependency-cruiser").IResolveOptions} pResolveOptions
+ * @param {string} pBaseDirectory
+ * @returns {import("../../../types/shared-types").DependencyType[]}
+ */
 function determineExternalModuleDependencyTypes(
-  pModule,
+  pDependency,
   pModuleName,
   pPackageDeps,
   pFileDirectory,
   pResolveOptions,
   pBaseDirectory
 ) {
+  /** @type {import("../../../types/shared-types").DependencyType[]} */
   let lReturnValue = [];
 
-  if (isExternalModule(pModule.resolved, ["node_modules"], pBaseDirectory)) {
+  if (
+    isExternalModule(pDependency.resolved, ["node_modules"], pBaseDirectory)
+  ) {
     lReturnValue = determineNodeModuleDependencyTypes(
       pModuleName,
       pPackageDeps,

package/src/extract/resolve/index.js

@@ -10,6 +10,14 @@ const resolveHelpers = require("./resolve-helpers");
 const determineDependencyTypes = require("./determine-dependency-types");
 const getManifest = require("./get-manifest");
 
+/**
+ *
+ * @param {import("../../../types/dependency-cruiser").IModule} pModule
+ * @param {string} pBaseDirectory
+ * @param {string} pFileDirectory
+ * @param {import("../../../types/dependency-cruiser").IResolveOptions} pResolveOptions
+ * @returns {any}
+ */
 function resolveModule(
   pModule,
   pBaseDirectory,
@@ -33,8 +41,7 @@ function resolveModule(
     lReturnValue = resolveAMD(
       lStrippedModuleName,
       pBaseDirectory,
-      pFileDirectory,
-      pResolveOptions
+      pFileDirectory
     );
   }
   return lReturnValue;
@@ -119,20 +126,8 @@ function resolveWithRetry(
  *                              for resolved files.
  * @param  {string} pFileDirectory    the directory of the file the dependency was
  *                              detected in
- * @param  {import(../../../types/resolve-options").IResolveOptions} pResolveOptions
- * @return {Partial <import("../../../types/cruise-result").IDependency>} an object with as attributes:
- *                              - resolved: a string representing the pDependency
- *                                  resolved to a file on disk (or the pDependency
- *                                  name itself when it could not be resolved)
- *                              - coreModule: true the dependency is a (node)
- *                                  core module - false in all other cases
- *                                  (deprecated over dependencyType === 'core')
- *                              - followable: true when it is worthwhile to
- *                                  follow dependencies of this dependency (
- *                                  typically not true for .json)
- *                              - couldNotResolve: true if it was not possible
- *                                  to resolve the dependency to a file on disk
- *                              - dependencyTypes: an array of dependencyTypes
+ * @param  {import("../../../types/resolve-options").IResolveOptions} pResolveOptions
+ * @return {Partial <import("../../../types/cruise-result").IDependency>}
  *
  */
 // eslint-disable-next-line max-lines-per-function

package/src/extract/transpile/meta.d.ts

@@ -0,0 +1,22 @@
+export interface ITranspilerWrapper {
+  isAvailable: () => boolean;
+  transpile: (
+    pSource: string,
+    pFileName?: string,
+    pTranspilerOptions?: any
+  ) => string;
+}
+
+export function getWrapper(pExtension, pTranspileOptions): ITranspilerWrapper;
+
+export const scannableExtensions: string[];
+
+export const allExtensions: string[];
+
+export interface IAvailableTranspiler {
+  name: string;
+  version: string;
+  available: boolean;
+}
+
+export function getAvailableTranspilers(): IAvailableTranspiler[];

package/src/extract/transpile/meta.js

@@ -95,7 +95,7 @@ module.exports.getWrapper = (pExtension, pTranspilerOptions) => {
  * all supported extensions and whether or not it is supported
  * in the current environment
  *
- * @type {string[]}
+ * @type {IAvailableExtension[]}
  */
 module.exports.allExtensions = Object.keys(EXTENSION2WRAPPER).map(
   (pExtension) => ({

package/src/extract/utl/path-to-posix.js

@@ -15,11 +15,11 @@ const path = require("path");
  * with 100% confidence.
  *
  * @param  {string} pFilePath   the path to transform
- * @param  {string} pPathModule optional - the path module/ object to use (for testing
+ * @param  {path} pPathModule? optional - the path module/ object to use (for testing
  *                              this module on posix platforms only; defaults to require('path'))
  * @return {string}             the transformed path
  */
-module.exports = function pathToPosix(pFilePath, pPathModule) {
+module.exports = function pathToPosix(pFilePath, pPathModule = path) {
   const lPathModule = pPathModule || path;
 
   if (lPathModule.sep !== path.posix.sep) {

package/src/graph-utl/consolidate-module-dependencies.js

@@ -1,14 +1,14 @@
 const _clone = require("lodash/clone");
 const _get = require("lodash/get");
 const _reject = require("lodash/reject");
-const _uniqBy = require("lodash/uniqBy");
+const _uniq = require("lodash/uniq");
 const compare = require("./compare");
 
 function mergeDependency(pLeftDependency, pRightDependency) {
   return {
     ...pLeftDependency,
     ...pRightDependency,
-    dependencyTypes: _uniqBy(
+    dependencyTypes: _uniq(
       pLeftDependency.dependencyTypes.concat(pRightDependency.dependencyTypes)
     ),
     rules: pLeftDependency.rules

package/src/graph-utl/rule-set.js

@@ -8,9 +8,9 @@ const _has = require("lodash/has");
  *
  * (this thing probably belongs in a model-like folder and not in utl)
  *
- * @param {import("../../types/configuration").IConfiguration} pRuleSet - The rule set to search in
+ * @param {import("../../types/dependency-cruiser").IFlattenedRuleSet} pRuleSet - The rule set to search in
  * @param {string} pName - The rule name to look for
- * @return {import("../../types/rule-set").IForbiddenRuleType|import("../../types/rule-set").IAllowedRuleType} - a rule (or 'undefined' if nothing found)
+ * @return {import("../../types/rule-set").IForbiddenRuleType|undefined} - a rule (or 'undefined' if nothing found)
  */
 function findRuleByName(pRuleSet, pName) {
   return _get(pRuleSet, "forbidden", []).find(
@@ -24,26 +24,31 @@ function findRuleByName(pRuleSet, pName) {
  *
  * Returns false in all other cases
  *
- * @param {import('../../../types/rule-set').IFlattenedRuleSet} pRuleSet
+ * @param {import('../../types/dependency-cruiser').IFlattenedRuleSet} pRuleSet
  * @return {boolean}
  */
 function ruleSetHasLicenseRule(pRuleSet) {
   return (
     _get(pRuleSet, "forbidden", []).some(
-      (pRule) => _has(pRule.to, "license") || _has(pRule.to, "licenseNot")
+      (pRule) => _has(pRule, "to.license") || _has(pRule, "to.licenseNot")
     ) ||
     _get(pRuleSet, "allowed", []).some(
-      (pRule) => _has(pRule.to, "license") || _has(pRule.to, "licenseNot")
+      (pRule) => _has(pRule, "to.license") || _has(pRule, "to.licenseNot")
     )
   );
 }
+/**
+ *
+ * @param {import('../../types/dependency-cruiser').IFlattenedRuleSet} pRuleSet
+ * @return {boolean}
+ */
 function ruleSetHasDeprecationRule(pRuleSet) {
   return (
     _get(pRuleSet, "forbidden", []).some((pRule) =>
-      _get(pRule.to, "dependencyTypes", []).includes("deprecated")
+      _get(pRule, "to.dependencyTypes", []).includes("deprecated")
     ) ||
     _get(pRuleSet, "allowed", []).some((pRule) =>
-      _get(pRule.to, "dependencyTypes", []).includes("deprecated")
+      _get(pRule, "to.dependencyTypes", []).includes("deprecated")
     )
   );
 }

package/src/main/files-and-dirs/normalize.js

@@ -1,5 +1,9 @@
 const path = require("path");
-
+/**
+ *
+ * @param {string} pFileDirectory
+ * @returns {string}
+ */
 function relativize(pFileDirectory) {
   // if pFileDirectory === process.cwd() path.relative will yield an empty string
   // whereas we actually want something non-empty => hence normalize
@@ -9,6 +13,11 @@ function relativize(pFileDirectory) {
     : pFileDirectory;
 }
 
+/**
+ *
+ * @param {string[]} pFileAndDirectoryArray
+ * @returns {string[]}
+ */
 module.exports = function normalizeFileAndDirectoryArray(
   pFileAndDirectoryArray
 ) {

package/src/main/options/defaults.js

@@ -1,7 +1,8 @@
+/** @type {import('../../../types/options').ICruiseOptions} */
 module.exports = {
   validate: false,
   maxDepth: 0,
-  moduleSystems: ["amd", "cjs", "es6", "tsd"],
+  moduleSystems: ["es6", "cjs", "tsd", "amd"],
   tsPreCompilationDeps: false,
   preserveSymlinks: false,
   combinedDependencies: false,

package/src/main/options/normalize.js

@@ -67,6 +67,11 @@ function normalizeCollapse(pCollapse) {
   return lReturnValue;
 }
 
+/**
+ *
+ * @param {import("../../../types/dependency-cruiser").IForbiddenRuleType} pRule
+ * @returns {boolean}
+ */
 function hasMetricsRule(pRule) {
   // TODO: philosophy: is a rule with 'folder' in it a metrics rule?
   //       Or is it a misuse to ensure folder derivations (like cycles) get
@@ -76,6 +81,11 @@ function hasMetricsRule(pRule) {
   );
 }
 
+/**
+ *
+ * @param {import("../../../types/dependency-cruiser").IFlattenedRuleSet} pRuleSet
+ * @returns {boolean}
+ */
 function ruleSetHasMetricsRule(pRuleSet) {
   const lRuleSet = pRuleSet || {};
   return (
@@ -87,7 +97,7 @@ function ruleSetHasMetricsRule(pRuleSet) {
 /**
  * Determines whether (instability) metrics should be calculated
  *
- * @param {import('../../../types/options').ICruiseOptions pOptions
+ * @param {import('../../../types/dependency-cruiser').ICruiseOptions} pOptions
  * @returns Boolean
  */
 function shouldCalculateMetrics(pOptions) {
@@ -100,7 +110,7 @@ function shouldCalculateMetrics(pOptions) {
 
 /**
  *
- * @param {Partial <import('../../../types/options').ICruiseOptions>} pOptions
+ * @param {Partial<import('../../../types/options').ICruiseOptions>} pOptions
  * @returns {import('../../../types/options').ICruiseOptions}
  */
 function normalizeCruiseOptions(pOptions) {
@@ -111,8 +121,11 @@ function normalizeCruiseOptions(pOptions) {
     ...pOptions,
   };
 
+  // @ts-ignore the idea of normalizing maxDepth to number is that after
+  // that we're  sure it's a number. Should maybe best be solved by
+  // having two types/ interfaces
   lReturnValue.maxDepth = Number.parseInt(lReturnValue.maxDepth, 10);
-  lReturnValue.moduleSystems = uniq(lReturnValue.moduleSystems.sort());
+  lReturnValue.moduleSystems = uniq(lReturnValue.moduleSystems);
   if (has(lReturnValue, "collapse")) {
     lReturnValue.collapse = normalizeCollapse(lReturnValue.collapse);
   }
@@ -125,9 +138,7 @@ function normalizeCruiseOptions(pOptions) {
   lReturnValue.extraExtensionsToScan = lReturnValue.extraExtensionsToScan || [];
   lReturnValue = normalizeFilterOptions(lReturnValue, ["focus", "includeOnly"]);
 
-  lReturnValue.exoticRequireStrings = uniq(
-    lReturnValue.exoticRequireStrings.sort()
-  );
+  lReturnValue.exoticRequireStrings = uniq(lReturnValue.exoticRequireStrings);
   if (lReturnValue.reporterOptions) {
     lReturnValue.reporterOptions = normalizeReporterOptions(
       lReturnValue.reporterOptions
@@ -138,6 +149,11 @@ function normalizeCruiseOptions(pOptions) {
   return lReturnValue;
 }
 
+/**
+ *
+ * @param {import("../../../types/dependency-cruiser").IFormatOptions} pFormatOptions
+ * @returns {import("../../../types/dependency-cruiser").IFormatOptions}
+ */
 function normalizeFormatOptions(pFormatOptions) {
   const lFormatOptions = clone(pFormatOptions);
 

package/src/main/options/validate.js

@@ -1,5 +1,5 @@
 const _get = require("lodash/get");
-const _has = require("lodash/has");
+const has = require("lodash/has");
 const safeRegex = require("safe-regex");
 const report = require("../../report");
 
@@ -55,6 +55,12 @@ function validatePathsSafety(pFilterOption) {
   validateRegExpSafety(_get(pFilterOption, "pathNot", ""));
 }
 
+/**
+ *
+ * @param {any} pOptions
+ * @throws {Error}
+ * @returns {import("../../../types/dependency-cruiser").ICruiseOptions}
+ */
 function validateCruiseOptions(pOptions) {
   let lReturnValue = {};
 
@@ -75,7 +81,7 @@ function validateCruiseOptions(pOptions) {
     // neccessary because not found a way to do this properly in JSON schema
     validateMaxDepth(pOptions.maxDepth);
 
-    if (_has(pOptions, "ruleSet.options")) {
+    if (has(pOptions, "ruleSet.options")) {
       lReturnValue = validateCruiseOptions(pOptions.ruleSet.options);
     }
     return { ...lReturnValue, ...pOptions };
@@ -83,6 +89,11 @@ function validateCruiseOptions(pOptions) {
   return lReturnValue;
 }
 
+/**
+ *
+ * @param {import("../../../types/dependency-cruiser").IFormatOptions} pFormatOptions
+ * @throws {Error}
+ */
 function validateFormatOptions(pFormatOptions) {
   validatePathsSafety(pFormatOptions.exclude);
   validatePathsSafety(pFormatOptions.focus);

package/src/main/report-wrap.js

@@ -39,7 +39,12 @@ function reSummarizeResults(pResult, pFormatOptions) {
     modules: lModules,
   };
 }
-
+/**
+ *
+ * @param {import("../../types/dependency-cruiser").ICruiseResult} pResult result of a previous run of dependency-cruiser
+ * @param {import("../../types/dependency-cruiser").IFormatOptions} pFormatOptions
+ * @returns {import("../../types/dependency-cruiser").IReporterOutput}
+ */
 module.exports = function reportWrap(pResult, pFormatOptions) {
   const lReportFunction = report.getReporter(pFormatOptions.outputType);
   const lReportOptions = _get(