npm - dependency-cruiser - Versions diffs - 11.5.0 → 11.6.0 - Mend

dependency-cruiser 11.5.0 → 11.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/package.json +13 -8
package/src/cli/tools/svg-in-html-snippets/header.snippet.html +61 -2
package/src/cli/tools/svg-in-html-snippets/script.snippet.js +107 -7
package/src/cli/tools/wrap-stream-in-html.js +2 -4
package/src/meta.js +1 -1
package/src/validate/match-folder-dependency-rule.js +23 -1
package/types/rule-set.d.ts +3 -2

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "11.5.0",
+  "version": "11.6.0",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -142,8 +142,8 @@
     "acorn-walk": "8.2.0",
     "ajv": "8.11.0",
     "chalk": "^4.1.2",
-    "commander": "9.1.0",
-    "enhanced-resolve": "5.9.2",
+    "commander": "9.2.0",
+    "enhanced-resolve": "5.9.3",
     "figures": "^3.2.0",
     "get-stream": "^6.0.1",
     "glob": "7.2.0",
@@ -153,7 +153,7 @@
     "json5": "2.2.1",
     "lodash": "4.17.21",
     "safe-regex": "2.1.1",
-    "semver": "^7.3.6",
+    "semver": "^7.3.7",
     "semver-try-require": "^5.0.2",
     "teamcity-service-messages": "0.1.12",
     "tsconfig-paths-webpack-plugin": "3.5.2",
@@ -163,10 +163,10 @@
     "@babel/core": "7.17.9",
     "@babel/plugin-transform-modules-commonjs": "7.17.9",
     "@babel/preset-typescript": "7.16.7",
-    "@swc/core": "1.2.165",
-    "@typescript-eslint/eslint-plugin": "5.18.0",
-    "@typescript-eslint/parser": "5.18.0",
-    "@vue/compiler-sfc": "3.2.31",
+    "@swc/core": "1.2.167",
+    "@typescript-eslint/eslint-plugin": "5.19.0",
+    "@typescript-eslint/parser": "5.19.0",
+    "@vue/compiler-sfc": "3.2.33",
     "c8": "7.11.0",
     "chai": "4.3.6",
     "chai-json-schema": "1.5.1",
@@ -213,6 +213,11 @@
         "policy": "wanted",
         "because": "version 4 only exports ejs - and we use cjs and don't transpile"
       },
+      {
+        "package": "glob",
+        "policy": "pin",
+        "because": "from version 7.2.1 behavior on windows changes - in a potentially breaking fashion. Wait with upgrading until we're majoring or from when there's a vuln in 7.2.0"
+      },
       {
         "package": "husky",
         "policy": "wanted",

package/src/cli/tools/svg-in-html-snippets/header.snippet.html CHANGED Viewed

@@ -9,8 +9,7 @@
       .node.current path,
       .node:active polygon,
       .node:hover polygon,
-      .node.current polygon
-       {
+      .node.current polygon {
         stroke: fuchsia;
         stroke-width: 2;
       }
@@ -44,6 +43,66 @@
       .cluster:hover path {
         fill: #ffff0011;
       }
+      div.hint {
+        background-color: #000000aa;
+        color: white;
+        font-family: Arial, Helvetica, sans-serif;
+        border-radius: 1rem;
+        position: fixed;
+        top: calc(50% - 4em);
+        right: calc(50% - 10em);
+        border: none;
+        padding: 1em 3em 1em 1em;
+      }
+      .hint button {
+        position: absolute;
+        font-weight: bolder;
+        right: 0.6em;
+        top: 0.6em;
+        color: inherit;
+        background-color: inherit;
+        border: 1px solid currentColor;
+        border-radius: 1em;
+        margin-left: 0.6em;
+      }
+      .hint a {
+        color: inherit;
+      }
+      #button_help {
+        color: white;
+        background-color: #00000011;
+        border-radius: 1em;
+        position: fixed;
+        top: 1em;
+        right: 1em;
+        font-size: 24pt;
+        font-weight: bolder;
+        width: 2em;
+        height: 2em;
+        border: none;
+      }
+      #button_help:hover {
+        cursor: pointer;
+        background-color: #00000077;
+      }
+      @media print {
+        #button_help {
+          display: none;
+        }
+        div.hint {
+          display: none;
+        }
+      }
     </style>
   </head>
   <body>
+    <button id="button_help">?</button>
+    <div id="hints" class="hint" style="display: none">
+      <button id="close-hints">x</button>
+      <span id="hint-text"></span>
+      <ul>
+        <li><b>Hover</b> - highlight</li>
+        <li><b>Left-click</b> - pin highlight</li>
+        <li><b>ESC</b> - clear</li>
+      </ul>
+    </div>

package/src/cli/tools/svg-in-html-snippets/script.snippet.js CHANGED Viewed

@@ -1,27 +1,85 @@
-document.body.onmouseover = getHighlightHandler();
+document.addEventListener("contextmenu", getSelectHandler(title2ElementMap));
+document.addEventListener("mouseover", getHoverHandler(title2ElementMap));
+document.addEventListener("keydown", keyboardEventHandler);
-function getHighlightHandler() {
-  /** @type {string} */
-  var currentHighlightedTitle;
+var gMode = new Mode();
+var title2ElementMap = (function makeElementMap() {
   /** @type {NodeListOf<SVGGElement>} */
   var nodes = document.querySelectorAll(".node");
   /** @type {NodeListOf<SVGGElement>} */
   var edges = document.querySelectorAll(".edge");
-  var title2ElementMap = new Title2ElementMap(edges, nodes);
+  return new Title2ElementMap(edges, nodes);
+})();
+function getHoverHandler() {
+  /** @type {string} */
+  var currentHighlightedTitle;
   /** @param {MouseEvent} pMouseEvent */
-  return function highlightHandler(pMouseEvent) {
+  return function hoverHighlightHandler(pMouseEvent) {
+    var closestNodeOrEdge = pMouseEvent.target.closest(".edge, .node");
+    var closestTitleText = getTitleText(closestNodeOrEdge);
+    if (
+      !(currentHighlightedTitle === closestTitleText) &&
+      gMode.get() === gMode.HOVER
+    ) {
+      resetNodesAndEdges();
+      addHighlight(closestNodeOrEdge);
+      title2ElementMap.get(closestTitleText).forEach(addHighlight);
+      currentHighlightedTitle = closestTitleText;
+    }
+  };
+}
+function getSelectHandler() {
+  /** @type {string} */
+  var currentHighlightedTitle;
+  /** @param {MouseEvent} pMouseEvent */
+  return function selectHighlightHandler(pMouseEvent) {
+    pMouseEvent.preventDefault();
     var closestNodeOrEdge = pMouseEvent.target.closest(".edge, .node");
     var closestTitleText = getTitleText(closestNodeOrEdge);
+    if (!!closestNodeOrEdge) {
+      gMode.setToSelect();
+    } else {
+      gMode.setToHover();
+    }
     if (!(currentHighlightedTitle === closestTitleText)) {
-      title2ElementMap.get(currentHighlightedTitle).forEach(removeHighlight);
+      resetNodesAndEdges();
+      addHighlight(closestNodeOrEdge);
       title2ElementMap.get(closestTitleText).forEach(addHighlight);
       currentHighlightedTitle = closestTitleText;
     }
   };
 }
+function Mode() {
+  var HOVER = 1;
+  var SELECT = 2;
+  function setToHover() {
+    this._mode = HOVER;
+  }
+  function setToSelect() {
+    this._mode = SELECT;
+  }
+  function get() {
+    return this._mode || HOVER;
+  }
+  return {
+    HOVER: HOVER,
+    SELECT: SELECT,
+    setToHover: setToHover,
+    setToSelect: setToSelect,
+    get: get,
+  };
+}
 /**
  *
@@ -132,6 +190,12 @@ function nodeListToArray(pNodeList) {
   return lReturnValue;
 }
+function resetNodesAndEdges() {
+  nodeListToArray(document.querySelectorAll(".current")).forEach(
+    removeHighlight
+  );
+}
 /**
  * @param {SVGGElement} pGElement
  */
@@ -149,3 +213,39 @@ function addHighlight(pGroup) {
     pGroup.classList.add("current");
   }
 }
+var hints = {
+  HIDDEN: 1,
+  SHOWN: 2,
+  state: this.HIDDEN,
+  show: function () {
+    document.getElementById("hints").removeAttribute("style");
+    hints.state = hints.SHOWN;
+  },
+  hide: function () {
+    document.getElementById("hints").style = "display:none";
+    hints.state = hints.HIDDEN;
+  },
+  toggle: function () {
+    if ((hints.state || hints.HIDDEN) === hints.HIDDEN) {
+      hints.show();
+    } else {
+      hints.hide();
+    }
+  },
+};
+/** @param {KeyboardEvent} pKeyboardEvent */
+function keyboardEventHandler(pKeyboardEvent) {
+  if (pKeyboardEvent.key === "Escape") {
+    resetNodesAndEdges();
+    gMode.setToHover();
+    hints.hide();
+  }
+  if (pKeyboardEvent.key === "F1") {
+    pKeyboardEvent.preventDefault();
+    hints.toggle();
+  }
+}
+document.getElementById("close-hints").addEventListener("click", hints.hide);
+document.getElementById("button_help").addEventListener("click", hints.toggle);

package/src/cli/tools/wrap-stream-in-html.js CHANGED Viewed

@@ -31,7 +31,7 @@ const FOOTER_FILE = path.join(
  * @param {readStream} pStream stream whose characters are to be slapped between header and footer
  * @param {writeStream} pOutStream stream to write to
  */
-function wrap(pInStream, pOutStream) {
+module.exports = function wrap(pInStream, pOutStream) {
   const lHeader = fs.readFileSync(HEADER_FILE, "utf8");
   const lScript = fs.readFileSync(SCRIPT_FILE, "utf8");
   const lEnd = fs.readFileSync(FOOTER_FILE, "utf8");
@@ -54,6 +54,4 @@ function wrap(pInStream, pOutStream) {
     .on("data", (pChunk) => {
       pOutStream.write(pChunk);
     });
-}
-module.exports = (pInStream, pOutStream) => wrap(pInStream, pOutStream);
+};

package/src/meta.js CHANGED Viewed

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

package/src/validate/match-folder-dependency-rule.js CHANGED Viewed

@@ -1,10 +1,32 @@
 const { isModuleOnlyRule, isFolderScope } = require("./rule-classifiers");
 const matchers = require("./matchers");
+function fromFolderPath(pRule, pFromFolder) {
+  return Boolean(!pRule.from.path || pFromFolder.name.match(pRule.from.path));
+}
+function fromFolderPathNot(pRule, pFromFolder) {
+  return Boolean(
+    !pRule.from.pathNot || !pFromFolder.name.match(pRule.from.pathNot)
+  );
+}
+function toFolderPath(pRule, pToFolder) {
+  return Boolean(!pRule.to.path || pToFolder.name.match(pRule.to.path));
+}
+function toFolderPathNot(pRule, pToFolder) {
+  return Boolean(!pRule.to.pathNot || !pToFolder.name.match(pRule.to.pathNot));
+}
 function match(pFromFolder, pToFolder) {
   return (pRule) =>
-    // TODO: add path rules - they need to be frippled from the ones
+    // TODO: to path rules - they need to be frippled from the ones
     // already in place for modules
+    fromFolderPath(pRule, pFromFolder) &&
+    fromFolderPathNot(pRule, pFromFolder) &&
+    toFolderPath(pRule, pToFolder) &&
+    toFolderPathNot(pRule, pToFolder) &&
     matchers.toIsMoreUnstable(pRule, pFromFolder, pToFolder) &&
     matchers.propertyEquals(pRule, pToFolder, "circular");
 }

package/types/rule-set.d.ts CHANGED Viewed

@@ -47,8 +47,9 @@ export interface IRegularForbiddenRuleType extends IBaseRuleType {
    * to note when you decide to use 'folder' level scope: (1) the 'scope' attribute
    * is experimental - the way to indicate the scope of a rule can change
    * over time without dependency-cruiser undergoing a major bump. (2) Only
-   * the to.moreUnstable attribute works at the moment. Other attributes will
-   * follow suit in releases after 11.3.0."
+   * the to.moreUnstable, to.circular, and path (both from and to) attributes
+   * work at the moment. Other attributes will follow suit in releases
+   * after 11.6.0.
    */
   scope?: RuleScopeType;
 }