dependency-cruiser 16.6.0 → 16.7.0-beta-2

package/src/validate/index.mjs

@@ -3,6 +3,10 @@ import matchDependencyRule from "./match-dependency-rule.mjs";
 import violatesRequiredRule from "./violates-required-rule.mjs";
 import matchFolderRule from "./match-folder-dependency-rule.mjs";
 
+/**
+ * @import { IValidationResult } from "./index.d.ts";
+ */
+
 function compareSeverity(pFirst, pSecond) {
   const lSeverity2Int = {
     error: 1,
@@ -67,10 +71,10 @@ function validateAgainstRequiredRules(pRuleSet, pModule, pMatchModule) {
  * @param {*} pFrom
  * @param {*} pTo
  * @param {*} pMatchModule
- * @returns {import("./index.js").IValidationResult}
+ * @returns {IValidationResult}
  */
 function validateAgainstRules(pRuleSet, pFrom, pTo, pMatchModule) {
-  /** @type {import("./index.js").IValidationResult} */
+  /** @type {IValidationResult} */
   let lReturnValue = { valid: true };
 
   const lFoundRuleViolations = validateAgainstAllowedRules(

package/src/validate/match-dependency-rule.mjs

@@ -18,9 +18,13 @@ import {
 import { extractGroups } from "#utl/regex-util.mjs";
 
 /**
- *
- * @param {import("../../types/dependency-cruiser.mjs").IModule} pFrom
- * @param {import("../../types/dependency-cruiser.mjs").IDependency} pTo
+ * @import { IDependency, IModule } from "../../types/cruise-result.mjs";
+ * @import { IAnyRuleType } from "../../types/rule-set.mjs";
+ */
+
+/**
+ * @param {IModule} pFrom
+ * @param {IDependency} pTo
  * @returns {(pRule) => boolean}
  */
 function match(pFrom, pTo) {
@@ -57,7 +61,7 @@ function match(pFrom, pTo) {
 }
 
 /**
- * @param {import("../../types/rule-set.d.mts").IAnyRuleType} pRule
+ * @param {IAnyRuleType} pRule
  * @returns boolean
  */
 const isInteresting = (pRule) =>

package/src/validate/match-module-rule-helpers.mjs

@@ -7,12 +7,18 @@ import {
   matchesModulePathNot,
 } from "./matchers.mjs";
 import { extractGroups } from "#utl/regex-util.mjs";
+
+/**
+ * @import { IModule } from "../../types/cruise-result.mjs";
+ * @import { IAnyRuleType } from "../../types/rule-set.mjs";
+ */
+
 /**
  * Returns true if pRule is an orphan rule and pModule is an orphan.
  * Returns false in all other cases
  *
- * @param {import("../../types/rule-set.mjs").IAnyRuleType} pRule
- * @param {import("../../types/cruise-result.mjs").IModule} pModule
+ * @param {IAnyRuleType} pRule
+ * @param {IModule} pModule
  * @returns {boolean}
  */
 export function matchesOrphanRule(pRule, pModule) {
@@ -30,8 +36,8 @@ export function matchesOrphanRule(pRule, pModule) {
  * criteria.
  * Returns false in all other cases
  *
- * @param {import("../../types/rule-set.mjs").IAnyRuleType} pRule
- * @param {import("../../types/cruise-result.mjs").IModule} pModule
+ * @param {IAnyRuleType} pRule
+ * @param {IModule} pModule
  * @returns {boolean}
  */
 export function matchesReachableRule(pRule, pModule) {
@@ -63,8 +69,8 @@ export function matchesReachableRule(pRule, pModule) {
  * criteria.
  * Returns false in all other cases
  *
- * @param {import("../../types/rule-set.mjs").IAnyRuleType} pRule
- * @param {import("../../types/cruise-result.mjs").IModule} pModule
+ * @param {IAnyRuleType} pRule
+ * @param {IModule} pModule
  * @returns {boolean}
  */
 export function matchesReachesRule(pRule, pModule) {
@@ -85,7 +91,7 @@ export function matchesReachesRule(pRule, pModule) {
 }
 /**
  *
- * @param {import("../../types/rule-set.mjs").IAnyRuleType} pRule
+ * @param {IAnyRuleType} pRule
  * @param {string[]} pDependents
  * @returns {boolean}
  */
@@ -105,11 +111,11 @@ function dependentsCountsMatch(pRule, pDependents) {
 
 /**
  *
- * @param {import("../../types/rule-set.mjs").IAnyRuleType} pRule
- * @param {import("../../types/cruise-result.mjs").IModule} pModule
+ * @param {IAnyRuleType} pRule
+ * @param {IModule} pModule
  * @returns {boolean}
  */
-// eslint-disable-next-line complexity
+
 export function matchesDependentsRule(pRule, pModule) {
   if (
     (Object.hasOwn(pModule, "dependents") &&

package/src/validate/match-module-rule.mjs

@@ -7,9 +7,13 @@ import {
 } from "./match-module-rule-helpers.mjs";
 
 /**
- *
- * @param {import("../../types/cruise-result.mjs").IModule} pModule
- * @returns {(pRule:import("../../types/rule-set.mjs").IAnyRuleType) => boolean}
+ * @import { IModule } from "../../types/cruise-result.mjs";
+ * @import { IAnyRuleType } from "../../types/rule-set.mjs";
+ */
+
+/**
+ * @param {IModule} pModule
+ * @returns {(pRule:IAnyRuleType) => boolean}
  */
 function match(pModule) {
   return (pRule) =>
@@ -20,8 +24,7 @@ function match(pModule) {
 }
 
 /**
- *
- * @param {import("../../types/rule-set.mjs").IAnyRuleType} pRule
+ * @param {IAnyRuleType} pRule
  * @returns boolean
  */
 const isInteresting = (pRule) =>

package/src/validate/matchers.mjs

@@ -85,7 +85,7 @@ export function matchToModulePath(pRule, pModule, pGroups) {
 
 function _toPathNot(pRule, pString, pGroups = []) {
   return (
-    !Boolean(pRule.to.pathNot) ||
+    !pRule.to.pathNot ||
     !pString.match(replaceGroupPlaceholders(pRule.to.pathNot, pGroups))
   );
 }
@@ -112,7 +112,6 @@ export function matchesToDependencyTypesNot(pRule, pDependency) {
   );
 }
 
-// eslint-disable-next-line complexity
 export function matchesToVia(pRule, pDependency, pGroups) {
   let lReturnValue = true;
   if (pRule.to.via && pDependency.cycle) {
@@ -144,7 +143,6 @@ export function matchesToVia(pRule, pDependency, pGroups) {
   return lReturnValue;
 }
 
-// eslint-disable-next-line complexity
 export function matchesToViaOnly(pRule, pDependency, pGroups) {
   let lReturnValue = true;
   if (pRule.to.viaOnly && pDependency.cycle) {

package/types/options.d.mts

@@ -144,6 +144,11 @@ export interface ICruiseOptions {
    * defaults to ["es6", "cjs", "amd"]
    */
   moduleSystems?: ModuleSystemType[];
+  /**
+   * When true, dependency-cruiser will detect dependencies in JSDoc-style
+   * import statements. Implies `"parser": "tsc"`. Defaults to false.'
+   */
+  detectJSDocImports?: boolean;
   /**
    * one of "json", "html", "dot", "csv" or "err". When left
    * out the function will return a javascript object as dependencies

package/types/shared-types.d.mts

@@ -52,6 +52,9 @@ export type DependencyType =
   | "export"
   | "import-equals"
   | "import"
+  | "jsdoc"
+  | "jsdoc-bracket-import"
+  | "jsdoc-import-tag"
   | "local"
   | "localmodule"
   | "npm-bundled"