dependency-cruiser 10.4.0-beta-1 → 10.4.0-beta-2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "10.4.0-beta-1",
+  "version": "10.4.0-beta-2",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -139,10 +139,10 @@
     "ajv": "8.6.3",
     "chalk": "4.1.2",
     "commander": "8.2.0",
-    "enhanced-resolve": "5.8.2",
+    "enhanced-resolve": "5.8.3",
     "figures": "^3.2.0",
     "get-stream": "^6.0.1",
-    "glob": "7.1.7",
+    "glob": "7.2.0",
     "handlebars": "4.7.7",
     "indent-string": "^4.0.0",
     "inquirer": "8.1.5",
@@ -159,13 +159,13 @@
     "@babel/core": "7.15.5",
     "@babel/plugin-transform-modules-commonjs": "7.15.4",
     "@babel/preset-typescript": "7.15.0",
-    "@swc/core": "1.2.88",
-    "@typescript-eslint/eslint-plugin": "4.31.1",
-    "@typescript-eslint/parser": "4.31.1",
+    "@swc/core": "1.2.91",
+    "@typescript-eslint/eslint-plugin": "4.31.2",
+    "@typescript-eslint/parser": "4.31.2",
     "c8": "7.9.0",
     "chai": "4.3.4",
     "chai-json-schema": "1.5.1",
-    "coffeescript": "2.5.1",
+    "coffeescript": "2.6.0",
     "eslint": "7.32.0",
     "eslint-config-moving-meadow": "2.0.9",
     "eslint-config-prettier": "8.3.0",
@@ -178,12 +178,12 @@
     "husky": "^4.3.8",
     "intercept-stdout": "0.1.2",
     "lint-staged": "11.1.2",
-    "mocha": "9.1.1",
+    "mocha": "9.1.2",
     "normalize-newline": "4.1.0",
     "npm-run-all": "4.1.5",
     "prettier": "2.4.1",
     "shx": "0.3.3",
-    "svelte": "3.42.6",
+    "svelte": "3.43.0",
     "symlink-dir": "5.0.1",
     "typescript": "4.4.3",
     "upem": "^7.0.0",

package/src/enrich/soften-known-violations.js

@@ -1,5 +1,6 @@
 const bus = require("../utl/bus");
 const busLogLevels = require("../utl/bus-log-levels");
+const isSameViolation = require("./summarize/is-same-violation");
 
 function softenModuleViolation(
   pRule,
@@ -26,11 +27,8 @@ function softenDependencyViolation(
 ) {
   return {
     ...pViolationKey.rule,
-    severity: pKnownDependencyViolations.some(
-      (pKnownError) =>
-        pKnownError.from === pViolationKey.from &&
-        pKnownError.to === pViolationKey.to &&
-        pKnownError.rule.name === pViolationKey.rule.name
+    severity: pKnownDependencyViolations.some((pKnownError) =>
+      isSameViolation(pKnownError, pViolationKey)
     )
       ? pSoftenedSeverity
       : pViolationKey.rule.severity,
@@ -48,7 +46,12 @@ function softenDependencyViolations(
       ...pDependency,
       rules: pDependency.rules.map((pRule) =>
         softenDependencyViolation(
-          { rule: pRule, from: pModuleSource, to: pDependency.resolved },
+          {
+            rule: pRule,
+            from: pModuleSource,
+            to: pDependency.resolved,
+            cycle: pDependency.cycle,
+          },
           pKnownDependencyViolations,
           pSoftenedSeverity
         )

package/src/enrich/summarize/is-same-violation.js

@@ -0,0 +1,18 @@
+module.exports = function isSameViolation(pLeftViolation, pRightViolation) {
+  let lReturnValue = false;
+
+  if (pLeftViolation.rule.name === pRightViolation.rule.name) {
+    if (pRightViolation.cycle && pLeftViolation.cycle) {
+      lReturnValue =
+        pLeftViolation.cycle.length === pRightViolation.cycle.length &&
+        pLeftViolation.cycle.every((pModule) =>
+          pRightViolation.cycle.includes(pModule)
+        );
+    } else {
+      lReturnValue =
+        pLeftViolation.from === pRightViolation.from &&
+        pLeftViolation.to === pRightViolation.to;
+    }
+  }
+  return lReturnValue;
+};

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

@@ -1,8 +1,9 @@
 const _flattenDeep = require("lodash/flattenDeep");
 const _get = require("lodash/get");
+const _uniqWith = require("lodash/uniqWith");
 const { findRuleByName } = require("../../graph-utl/rule-set");
 const compare = require("../../graph-utl/compare");
-const deDuplicateViolations = require("./de-duplicate-violations");
+const isSameViolation = require("./is-same-violation");
 
 function cutNonTransgressions(pSourceEntry) {
   return {
@@ -23,6 +24,7 @@ function extractMetaData(pViolations) {
       error: 0,
       warn: 0,
       info: 0,
+      ignore: 0,
     }
   );
 }
@@ -128,10 +130,11 @@ function extractModuleViolations(pModules, pRuleSet) {
 }
 
 module.exports = function summarizeModules(pModules, pRuleSet) {
-  const lViolations = deDuplicateViolations(
+  const lViolations = _uniqWith(
     extractDependencyViolations(pModules, pRuleSet)
       .concat(extractModuleViolations(pModules, pRuleSet))
-      .sort(compare.violations)
+      .sort(compare.violations),
+    isSameViolation
   );
 
   return {

package/src/extract/ast-extractors/extract-typescript-deps.js

@@ -31,7 +31,7 @@ function extractImportsAndExports(pAST) {
       moduleSystem: "es6",
       exoticallyRequired: false,
       ...(pStatement.importClause && pStatement.importClause.isTypeOnly
-        ? { typeOnly: true }
+        ? { dependencyTypes: ["type-only"] }
         : {}),
     }));
 }

package/src/extract/get-dependencies.js

@@ -162,8 +162,8 @@ function addResolutionAttributes(pOptions, pFileName, pResolveOptions) {
     );
 
     return {
-      ...lResolved,
       ...pDependency,
+      ...lResolved,
       followable: lResolved.followable && !lMatchesDoNotFollow,
       matchesDoNotFollow: lMatchesDoNotFollow,
     };
@@ -196,22 +196,12 @@ function compareDeps(pLeft, pRight) {
  *
  *
  * @param  {string} pFileName path to the file
- * @param  {object} pCruiseOptions  an object with one or more of these properties:
- *                            - baseDir         - the directory to consider as the
- *                                                base for all files
- *                                                Default: the current working directory
- *                            - moduleSystems   - an array of module systems to
- *                                                consider.
- *                                                Default: ["cjs", "es6", "amd"]
- *                            - exclude         - a regular expression string
- *                                                with a pattern of modules to exclude
- *                                                (e.g. "(node_modules)"). Default: none
- *                            - preserveSymlinks - don't resolve symlinks.
- * @param {object} pResolveOptions an object with webpack 'enhanced-resolve' options
+ * @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
  *                               ('flattened' so there's no need for file access on any
  *                               'extends' option in there)
- * @return {array}           an array of dependency objects (see above)
+ * @return {import("../../types/dependency-cruiser").IDependency[]} an array of dependency objects (see above)
  */
 module.exports = function getDependencies(
   pFileName,

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

@@ -1,8 +1,8 @@
 const path = require("path");
+const { builtinModules } = require("module");
 const _has = require("lodash/has");
 const {
   isRelativeModuleName,
-  isCore,
   isExternalModule,
   isAliassy,
 } = require("./module-classifiers");
@@ -167,7 +167,7 @@ module.exports = function determineDependencyTypes(
 
   if (pDependency.couldNotResolve) {
     lReturnValue = ["unknown"];
-  } else if (isCore(pModuleName)) {
+  } else if (builtinModules.includes(pModuleName)) {
     // this 'isCore' business seems duplicate (it's already in
     // the passed object as `coreModule`- determined by the resolve-AMD or
     // resolve-commonJS module). I want to deprecate the `coreModule`
@@ -195,11 +195,7 @@ module.exports = function determineDependencyTypes(
     lReturnValue = ["aliased"];
   }
 
-  if (pDependency.typeOnly) {
-    lReturnValue.push("type-only");
-  }
-
-  return lReturnValue;
+  return lReturnValue.concat(pDependency.dependencyTypes || []);
 };
 
 /* eslint security/detect-object-injection: 0*/

package/src/extract/resolve/index.js

@@ -7,6 +7,8 @@ const { isRelativeModuleName } = require("./module-classifiers");
 const resolveAMD = require("./resolve-amd");
 const resolveCommonJS = require("./resolve-cjs");
 const resolveHelpers = require("./resolve-helpers");
+const determineDependencyTypes = require("./determine-dependency-types");
+const getManifest = require("./get-manifest");
 
 function resolveModule(
   pModule,
@@ -16,20 +18,20 @@ function resolveModule(
 ) {
   let lReturnValue = null;
 
-  const lModuleName = resolveHelpers.stripToModuleName(pModule.module);
+  const lStrippedModuleName = resolveHelpers.stripToModuleName(pModule.module);
   if (
-    isRelativeModuleName(lModuleName) ||
+    isRelativeModuleName(lStrippedModuleName) ||
     ["cjs", "es6", "tsd"].includes(pModule.moduleSystem)
   ) {
     lReturnValue = resolveCommonJS(
-      pModule.module,
+      lStrippedModuleName,
       pBaseDirectory,
       pFileDirectory,
       pResolveOptions
     );
   } else {
     lReturnValue = resolveAMD(
-      pModule.module,
+      lStrippedModuleName,
       pBaseDirectory,
       pFileDirectory,
       pResolveOptions
@@ -48,7 +50,7 @@ function isTypeScriptishExtension(pModuleName) {
 function resolveYarnVirtual(pPath) {
   const pnpAPI = get(monkeyPatchedModule, "findPnpApi", () => false)(pPath);
 
-  // the pnp api only works in plug'n play environemnts, and resolveVirtual
+  // the pnp api only works in plug'n play environments, and resolveVirtual
   // only under yarn(berry). As we can't run a 'regular' nodejs environment
   // and a yarn(berry) one at the same time, ignore in the test coverage and
   // cover it in a separate integration test.
@@ -72,7 +74,7 @@ function resolveWithRetry(
     pFileDirectory,
     pResolveOptions
   );
-  const lModuleName = resolveHelpers.stripToModuleName(pModule.module);
+  const lStrippedModuleName = resolveHelpers.stripToModuleName(pModule.module);
 
   // when we feed the typescript compiler an import with an explicit .js(x) extension
   // and the .js(x) file does not exist, it tries files with the .ts, .tsx or
@@ -87,8 +89,14 @@ function resolveWithRetry(
   //
   // This should eventually probably land in either enhanced_resolve or in a
   // plugin/ extension for it (tsconfig-paths-webpack-plugin?)
-  if (lReturnValue.couldNotResolve && canBeResolvedToTsVariant(lModuleName)) {
-    const lModuleWithOutExtension = lModuleName.replace(/\.js(x)?$/g, "");
+  if (
+    lReturnValue.couldNotResolve &&
+    canBeResolvedToTsVariant(lStrippedModuleName)
+  ) {
+    const lModuleWithOutExtension = lStrippedModuleName.replace(
+      /\.js(x)?$/g,
+      ""
+    );
 
     const lReturnValueCandidate = resolveModule(
       { ...pModule, module: lModuleWithOutExtension },
@@ -106,14 +114,13 @@ function resolveWithRetry(
 /**
  * resolves the module name of the pDependency to a file on disk.
  *
- * @param  {import("../../../types/cruise-result").IModule} pModule an object with a module and the moduleSystem
- *                              according to which this is a dependency
+ * @param  {Partial <import("../../../types/cruise-result").IDependency>} pDependency
  * @param  {string} pBaseDirectory    the directory to consider as base (or 'root')
  *                              for resolved files.
  * @param  {string} pFileDirectory    the directory of the file the dependency was
  *                              detected in
  * @param  {import(../../../types/resolve-options").IResolveOptions} pResolveOptions
- * @return {object}             an object with as attributes:
+ * @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)
@@ -128,18 +135,44 @@ function resolveWithRetry(
  *                              - dependencyTypes: an array of dependencyTypes
  *
  */
+// eslint-disable-next-line max-lines-per-function
 module.exports = function resolve(
-  pModule,
+  pDependency,
   pBaseDirectory,
   pFileDirectory,
   pResolveOptions
 ) {
   let lResolvedModule = resolveWithRetry(
-    pModule,
+    pDependency,
     pBaseDirectory,
     pFileDirectory,
     pResolveOptions
   );
+  const lStrippedModuleName = resolveHelpers.stripToModuleName(
+    pDependency.module
+  );
+
+  lResolvedModule = {
+    ...lResolvedModule,
+    ...resolveHelpers.addLicenseAttribute(
+      lStrippedModuleName,
+      lResolvedModule.resolved,
+      { baseDirectory: pBaseDirectory, fileDirectory: pFileDirectory },
+      pResolveOptions
+    ),
+    dependencyTypes: determineDependencyTypes(
+      { ...pDependency, ...lResolvedModule },
+      lStrippedModuleName,
+      getManifest(
+        pFileDirectory,
+        pBaseDirectory,
+        pResolveOptions.combinedDependencies
+      ),
+      pFileDirectory,
+      pResolveOptions,
+      pBaseDirectory
+    ),
+  };
 
   if (
     !pResolveOptions.symlinks &&

package/src/extract/resolve/module-classifiers.js

@@ -1,4 +1,3 @@
-const { builtinModules } = require("module");
 const path = require("path");
 const getExtension = require("../utl/get-extension");
 
@@ -19,10 +18,6 @@ function isRelativeModuleName(pModuleName) {
   );
 }
 
-function isCore(pModuleName) {
-  return builtinModules.includes(pModuleName);
-}
-
 function isExternalModule(
   pResolvedModuleName,
   pModuleFolderNames = ["node_modules"],
@@ -124,7 +119,6 @@ function isAliassy(pModuleName, pResolvedModuleName, pResolveOptions) {
 module.exports = {
   isScoped,
   isRelativeModuleName,
-  isCore,
   isExternalModule,
   isFollowable,
   isAliassy,

package/src/extract/resolve/resolve-amd.js

@@ -1,11 +1,8 @@
 const fs = require("fs");
 const path = require("path");
+const { builtinModules } = require("module");
 const memoize = require("lodash/memoize");
 const pathToPosix = require("../utl/path-to-posix");
-const determineDependencyTypes = require("./determine-dependency-types");
-const { isCore } = require("./module-classifiers");
-const getManifest = require("./get-manifest");
-const resolveHelpers = require("./resolve-helpers");
 
 const fileExists = memoize((pFile) => {
   try {
@@ -27,7 +24,7 @@ function guessPath(pBaseDirectory, pFileDirectory, pStrippedModuleName) {
 }
 
 function guessLikelyPath(pBaseDirectory, pFileDirectory, pStrippedModuleName) {
-  let lReturnValue =
+  return (
     [".js", ""]
       .map((pExtension) =>
         guessPath(
@@ -36,16 +33,14 @@ function guessLikelyPath(pBaseDirectory, pFileDirectory, pStrippedModuleName) {
           `${pStrippedModuleName}${pExtension}`
         )
       )
-      .find(fileExists) || pStrippedModuleName;
-
-  return lReturnValue;
+      .find(fileExists) || pStrippedModuleName
+  );
 }
 
 module.exports = function resolveAMD(
-  pRawModuleName,
+  pStrippedModuleName,
   pBaseDirectory,
-  pFileDirectory,
-  pResolveOptions
+  pFileDirectory
 ) {
   // lookups:
   // - [x] could be relative in the end (implemented)
@@ -53,41 +48,19 @@ module.exports = function resolveAMD(
   // - [ ] maybe use mrjoelkemp/module-lookup-amd ?
   // - [ ] or https://github.com/jaredhanson/amd-resolve ?
   // - [x] funky plugins (json!wappie, ./screeching-cat!sabertooth)
-  const lModuleName = resolveHelpers.stripToModuleName(pRawModuleName);
   const lResolvedPath = guessLikelyPath(
     pBaseDirectory,
     pFileDirectory,
-    lModuleName
+    pStrippedModuleName
   );
 
-  let lReturnValue = {
+  return {
     resolved: lResolvedPath,
-    coreModule: Boolean(isCore(pRawModuleName)),
+    coreModule: builtinModules.includes(pStrippedModuleName),
     followable: fileExists(lResolvedPath) && lResolvedPath.endsWith(".js"),
     couldNotResolve:
-      !Boolean(isCore(pRawModuleName)) && !fileExists(lResolvedPath),
-  };
-
-  return {
-    ...lReturnValue,
-    ...resolveHelpers.addLicenseAttribute(
-      lModuleName,
-      pBaseDirectory,
-      pResolveOptions,
-      lReturnValue.resolved
-    ),
-    dependencyTypes: determineDependencyTypes(
-      lReturnValue,
-      lModuleName,
-      getManifest(
-        pFileDirectory,
-        pBaseDirectory,
-        pResolveOptions.combinedDependencies
-      ),
-      pFileDirectory,
-      pResolveOptions,
-      pBaseDirectory
-    ),
+      !builtinModules.includes(pStrippedModuleName) &&
+      !fileExists(lResolvedPath),
   };
 };
 

package/src/extract/resolve/resolve-cjs.js

@@ -1,9 +1,7 @@
 const path = require("path");
+const { builtinModules } = require("module");
 const pathToPosix = require("../utl/path-to-posix");
-const determineDependencyTypes = require("./determine-dependency-types");
-const { isCore, isFollowable } = require("./module-classifiers");
-const getManifest = require("./get-manifest");
-const resolveHelpers = require("./resolve-helpers");
+const { isFollowable } = require("./module-classifiers");
 const resolve = require("./resolve");
 
 function addResolutionAttributes(
@@ -14,7 +12,7 @@ function addResolutionAttributes(
 ) {
   let lReturnValue = {};
 
-  if (isCore(pModuleName)) {
+  if (builtinModules.includes(pModuleName)) {
     lReturnValue.coreModule = true;
   } else {
     try {
@@ -39,47 +37,21 @@ function addResolutionAttributes(
  * resolves both CommonJS and ES6
  */
 module.exports = function resolveCommonJS(
-  pRawModuleName,
+  pStrippedModuleName,
   pBaseDirectory,
   pFileDirectory,
   pResolveOptions
 ) {
-  const lModuleName = resolveHelpers.stripToModuleName(pRawModuleName);
-  const lManifest = getManifest(
-    pFileDirectory,
-    pBaseDirectory,
-    pResolveOptions.combinedDependencies
-  );
-
-  let lReturnValue = {
-    resolved: lModuleName,
+  return {
+    resolved: pStrippedModuleName,
     coreModule: false,
     followable: false,
     couldNotResolve: false,
-    dependencyTypes: ["undetermined"],
     ...addResolutionAttributes(
       pBaseDirectory,
-      lModuleName,
+      pStrippedModuleName,
       pFileDirectory,
       pResolveOptions
     ),
   };
-
-  return {
-    ...lReturnValue,
-    ...resolveHelpers.addLicenseAttribute(
-      lModuleName,
-      lReturnValue.resolved,
-      { baseDirectory: pBaseDirectory, fileDirectory: pFileDirectory },
-      pResolveOptions
-    ),
-    dependencyTypes: determineDependencyTypes(
-      lReturnValue,
-      lModuleName,
-      lManifest,
-      pFileDirectory,
-      pResolveOptions,
-      pBaseDirectory
-    ),
-  };
 };

package/src/meta.js

@@ -1,7 +1,7 @@
 /* generated - don't edit */
 
 module.exports = {
-  version: "10.4.0-beta-1",
+  version: "10.4.0-beta-2",
   engines: {
     node: "^12.20||^14||>=16",
   },

package/src/schema/cruise-result.schema.js

@@ -174,6 +174,7 @@ module.exports = {
         error: { type: "number" },
         warn: { type: "number" },
         info: { type: "number" },
+        ignore: { type: "number" },
         totalCruised: { type: "number" },
         totalDependenciesCruised: { type: "number" },
         ruleSetUsed: { $ref: "#/definitions/RuleSetType" },

package/types/cruise-result.d.ts

@@ -278,6 +278,10 @@ export interface ISummary {
    * the number of errors in the dependencies
    */
   error: number;
+  /**
+   * the number of ignored notices in the dependencies
+   */
+  ignore: number;
   /**
    * the number of informational level notices in the dependencies
    */

package/src/enrich/summarize/de-duplicate-violations.js

@@ -1,18 +0,0 @@
-const _difference = require("lodash/difference");
-const _uniqWith = require("lodash/uniqWith");
-
-function violationIsEqual(pLeftViolation, pRightViolation) {
-  if (
-    pLeftViolation.rule.name === pRightViolation.rule.name &&
-    pLeftViolation.cycle
-  ) {
-    return (
-      _difference(pLeftViolation.cycle, pRightViolation.cycle).length === 0
-    );
-  }
-  return false;
-}
-
-module.exports = function deDuplicateViolations(pViolations) {
-  return _uniqWith(pViolations, violationIsEqual);
-};