refactor: addresses small linting issues

sverweij · Nov 22, 2024 · 3032dda · 3032dda
1 parent 09e9e41
commit 3032dda
Show file tree

Hide file tree

Showing 18 changed files with 2,763 additions and 2,720 deletions.
diff --git a/doc/assets/filtering/focus.svg b/doc/assets/filtering/focus.svg
diff --git a/doc/real-world-samples/dependency-cruiser-archi-graph.svg b/doc/real-world-samples/dependency-cruiser-archi-graph.svg
diff --git a/doc/real-world-samples/dependency-cruiser-dir-graph.svg b/doc/real-world-samples/dependency-cruiser-dir-graph.svg
diff --git a/doc/real-world-samples/dependency-cruiser-without-node_modules.svg b/doc/real-world-samples/dependency-cruiser-without-node_modules.svg
diff --git a/docs/dependency-cruiser-archi-graph.html b/docs/dependency-cruiser-archi-graph.html
@@ -122,7 +122,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
  "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<!-- Generated by graphviz version 12.1.2 (20240928.0832)
+<!-- Generated by graphviz version 12.2.0 (20241103.1931)
  -->
 <!-- Title: dependency&#45;cruiser output Pages: 1 -->
 <svg width="310pt" height="278pt"
@@ -470,7 +470,7 @@
     var closestTitleText = getTitleText(closestNodeOrEdge);
 
     if (
-      !(currentHighlightedTitle === closestTitleText) &&
+      currentHighlightedTitle !== closestTitleText &&
       gMode.get() === gMode.HOVER
     ) {
       resetNodesAndEdges();
@@ -492,12 +492,12 @@
     var closestNodeOrEdge = pMouseEvent.target.closest(".edge, .node");
     var closestTitleText = getTitleText(closestNodeOrEdge);
 
-    if (!!closestNodeOrEdge) {
+    if (closestNodeOrEdge) {
       gMode.setToSelect();
     } else {
       gMode.setToHover();
     }
-    if (!(currentHighlightedTitle === closestTitleText)) {
+    if (currentHighlightedTitle !== closestTitleText) {
       resetNodesAndEdges();
       addHighlight(closestNodeOrEdge);
       pTitle2ElementMap.get(closestTitleText).forEach(addHighlight);
@@ -668,7 +668,7 @@
 var gHints = {
   HIDDEN: 1,
   SHOWN: 2,
-  state: this.HIDDEN,
+  state: 1, // === HIDDEN
   show: function () {
     document.getElementById("hints").removeAttribute("style");
     gHints.state = gHints.SHOWN;

diff --git a/docs/dependency-cruiser-dependency-graph.html b/docs/dependency-cruiser-dependency-graph.html
diff --git a/docs/dependency-cruiser-dir-graph.html b/docs/dependency-cruiser-dir-graph.html
@@ -122,7 +122,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
  "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<!-- Generated by graphviz version 12.1.2 (20240928.0832)
+<!-- Generated by graphviz version 12.2.0 (20241103.1931)
  -->
 <!-- Title: dependency&#45;cruiser output Pages: 1 -->
 <svg width="1357pt" height="475pt"
@@ -1149,7 +1149,7 @@
     var closestTitleText = getTitleText(closestNodeOrEdge);
 
     if (
-      !(currentHighlightedTitle === closestTitleText) &&
+      currentHighlightedTitle !== closestTitleText &&
       gMode.get() === gMode.HOVER
     ) {
       resetNodesAndEdges();
@@ -1171,12 +1171,12 @@
     var closestNodeOrEdge = pMouseEvent.target.closest(".edge, .node");
     var closestTitleText = getTitleText(closestNodeOrEdge);
 
-    if (!!closestNodeOrEdge) {
+    if (closestNodeOrEdge) {
       gMode.setToSelect();
     } else {
       gMode.setToHover();
     }
-    if (!(currentHighlightedTitle === closestTitleText)) {
+    if (currentHighlightedTitle !== closestTitleText) {
       resetNodesAndEdges();
       addHighlight(closestNodeOrEdge);
       pTitle2ElementMap.get(closestTitleText).forEach(addHighlight);
@@ -1347,7 +1347,7 @@
 var gHints = {
   HIDDEN: 1,
   SHOWN: 2,
-  state: this.HIDDEN,
+  state: 1, // === HIDDEN
   show: function () {
     document.getElementById("hints").removeAttribute("style");
     gHints.state = gHints.SHOWN;

diff --git a/docs/schema-overview.html b/docs/schema-overview.html
@@ -122,7 +122,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
  "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<!-- Generated by graphviz version 12.1.2 (20240928.0832)
+<!-- Generated by graphviz version 12.2.0 (20241103.1931)
  -->
 <!-- Title: dependency&#45;cruiser output Pages: 1 -->
 <svg width="962pt" height="762pt"
@@ -865,7 +865,7 @@
     var closestTitleText = getTitleText(closestNodeOrEdge);
 
     if (
-      !(currentHighlightedTitle === closestTitleText) &&
+      currentHighlightedTitle !== closestTitleText &&
       gMode.get() === gMode.HOVER
     ) {
       resetNodesAndEdges();
@@ -887,12 +887,12 @@
     var closestNodeOrEdge = pMouseEvent.target.closest(".edge, .node");
     var closestTitleText = getTitleText(closestNodeOrEdge);
 
-    if (!!closestNodeOrEdge) {
+    if (closestNodeOrEdge) {
       gMode.setToSelect();
     } else {
       gMode.setToHover();
     }
-    if (!(currentHighlightedTitle === closestTitleText)) {
+    if (currentHighlightedTitle !== closestTitleText) {
       resetNodesAndEdges();
       addHighlight(closestNodeOrEdge);
       pTitle2ElementMap.get(closestTitleText).forEach(addHighlight);
@@ -1063,7 +1063,7 @@
 var gHints = {
   HIDDEN: 1,
   SHOWN: 2,
-  state: this.HIDDEN,
+  state: 1, // === HIDDEN
   show: function () {
     document.getElementById("hints").removeAttribute("style");
     gHints.state = gHints.SHOWN;

diff --git a/src/cli/utl/io.mjs b/src/cli/utl/io.mjs
@@ -28,10 +28,9 @@ function writeToFile(pOutputTo, pDependencyString) {
  */
 function writeToStdOut(pString, pBufferSize = PIPE_BUFFER_SIZE) {
   const lNumberOfChunks = Math.ceil(pString.length / pBufferSize);
-  let lIndex = 0;
 
   /* eslint no-plusplus: 0 */
-  for (lIndex = 0; lIndex < lNumberOfChunks; lIndex++) {
+  for (let lIndex = 0; lIndex < lNumberOfChunks; lIndex++) {
     const lChunkStart = lIndex * pBufferSize;
     process.stdout.write(
       pString.substring(lChunkStart, lChunkStart + pBufferSize),

diff --git a/src/extract/resolve/external-module-helpers.mjs b/src/extract/resolve/external-module-helpers.mjs
@@ -78,7 +78,7 @@ function bareGetPackageJson(pModuleName, pFileDirectory, pResolveOptions) {
   try {
     const lPackageJsonFilename = resolve(
       join(getPackageRoot(pModuleName), "package.json"),
-      pFileDirectory ? pFileDirectory : process.cwd(),
+      pFileDirectory ?? process.cwd(),
       {
         ...pResolveOptions,
         // if a module has exports fields _and_ does not expose package.json

diff --git a/src/extract/resolve/module-classifiers.mjs b/src/extract/resolve/module-classifiers.mjs
@@ -150,7 +150,7 @@ function isWorkspaceAliased(pModuleName, pResolvedModuleName, pManifest) {
   // an object. To prevent the code from borking we check whether it's an array
   // see https://github.com/sverweij/dependency-cruiser/issues/919
   const lWorkspaces = getWorkspacesArray(pManifest?.workspaces);
-  if (lWorkspaces.length >= 0) {
+  if (lWorkspaces.length > 0) {
     // workspaces are an array of globs that match the (sub) workspace
     // folder itself only.
     //
@@ -193,7 +193,7 @@ function isWorkspaceAliased(pModuleName, pResolvedModuleName, pManifest) {
     // of the workspace, not the path of the workspace itself. So if it's
     // in node_modules we need to check against the unresolved modulename.
     //
-    // Other then the detection for when symlinks are resolved to their realpath
+    // Other than the detection for when symlinks are resolved to their realpath
     // (the if above), this is a 'best effort' detection only for now; there's
     // guaranteed to be scenarios where this will fail. How often is the
     // --preserve-symlinks flag used in practice, though?

diff --git a/src/extract/swc/dependency-visitor.mjs b/src/extract/swc/dependency-visitor.mjs
@@ -41,7 +41,7 @@ function argumentsAreUsable(pArguments) {
     ["StringLiteral", "TemplateLiteral"].includes(
       pArguments[0].expression.type,
     ) &&
-    (!(pArguments[0].expression.type === "TemplateLiteral") ||
+    (pArguments[0].expression.type !== "TemplateLiteral" ||
       isPlaceholderlessTemplateLiteral(pArguments[0]))
   );
 }
@@ -250,11 +250,7 @@ export default Visitor
         // as visitors for some shapes of type annotations aren't completely
         // implemented yet (1.2.51) pNode can come in as null (also see
         // comments in accompanying unit test)
-        if (
-          Boolean(pNode) &&
-          Boolean(pNode.typeAnnotation) &&
-          Boolean(pNode.typeAnnotation.argument)
-        )
+        if (pNode && pNode.typeAnnotation && pNode.typeAnnotation.argument)
           this.lResult.push({
             module: pNode.typeAnnotation.argument.value,
             moduleSystem: "es6",

diff --git a/src/main/rule-set/normalize.mjs b/src/main/rule-set/normalize.mjs
@@ -16,7 +16,7 @@ const DEFAULT_RULE = "unnamed";
 const DEFAULT_SCOPE = "module";
 
 function normalizeSeverity(pSeverity) {
-  const lSeverity = pSeverity ? pSeverity : DEFAULT_SEVERITY;
+  const lSeverity = pSeverity ?? DEFAULT_SEVERITY;
 
   return VALID_SEVERITIES.test(lSeverity) ? lSeverity : DEFAULT_SEVERITY;
 }
@@ -26,15 +26,15 @@ function normalizeSeverity(pSeverity) {
  * @returns {string}
  */
 function normalizeName(pRuleName) {
-  return pRuleName ? pRuleName : DEFAULT_RULE;
+  return pRuleName ?? DEFAULT_RULE;
 }
 
 /**
  * @param {RuleScopeType} pScope?
  * @returns {RuleScopeType}
  */
 function normalizeScope(pScope) {
-  return pScope ? pScope : DEFAULT_SCOPE;
+  return pScope ?? DEFAULT_SCOPE;
 }
 
 /**

diff --git a/src/report/dot-webpage/svg-in-html-snippets/script.cjs b/src/report/dot-webpage/svg-in-html-snippets/script.cjs
@@ -18,7 +18,7 @@ function getHoverHandler(pTitle2ElementMap) {
     var closestTitleText = getTitleText(closestNodeOrEdge);
 
     if (
-      !(currentHighlightedTitle === closestTitleText) &&
+      currentHighlightedTitle !== closestTitleText &&
       gMode.get() === gMode.HOVER
     ) {
       resetNodesAndEdges();
@@ -40,12 +40,12 @@ function getSelectHandler(pTitle2ElementMap) {
     var closestNodeOrEdge = pMouseEvent.target.closest(".edge, .node");
     var closestTitleText = getTitleText(closestNodeOrEdge);
 
-    if (!!closestNodeOrEdge) {
+    if (closestNodeOrEdge) {
       gMode.setToSelect();
     } else {
       gMode.setToHover();
     }
-    if (!(currentHighlightedTitle === closestTitleText)) {
+    if (currentHighlightedTitle !== closestTitleText) {
       resetNodesAndEdges();
       addHighlight(closestNodeOrEdge);
       pTitle2ElementMap.get(closestTitleText).forEach(addHighlight);
@@ -216,7 +216,7 @@ function addHighlight(pGroup) {
 var gHints = {
   HIDDEN: 1,
   SHOWN: 2,
-  state: this.HIDDEN,
+  state: 1, // === HIDDEN
   show: function () {
     document.getElementById("hints").removeAttribute("style");
     gHints.state = gHints.SHOWN;

diff --git a/src/utl/get-extension.mjs b/src/utl/get-extension.mjs
@@ -1,7 +1,7 @@
 // @ts-check
 import { extname } from "node:path";
 
-const EXTENSION_RE = /(?<extension>(?:(?:\.d\.(?:c|m)?ts)|\.coffee\.md)$)/;
+const EXTENSION_RE = /(?<extension>(?:(?:\.d\.(?:[cm])?ts)|\.coffee\.md)$)/;
 
 /**
  * Returns the extension of the given file name path.

diff --git a/tools/overview.svg b/tools/overview.svg
diff --git a/types/overview.html b/types/overview.html
@@ -122,7 +122,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
  "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<!-- Generated by graphviz version 12.1.2 (20240928.0832)
+<!-- Generated by graphviz version 12.2.0 (20241103.1931)
  -->
 <!-- Title: dependency&#45;cruiser output Pages: 1 -->
 <svg width="1027pt" height="350pt"
@@ -732,7 +732,7 @@
     var closestTitleText = getTitleText(closestNodeOrEdge);
 
     if (
-      !(currentHighlightedTitle === closestTitleText) &&
+      currentHighlightedTitle !== closestTitleText &&
       gMode.get() === gMode.HOVER
     ) {
       resetNodesAndEdges();
@@ -754,12 +754,12 @@
     var closestNodeOrEdge = pMouseEvent.target.closest(".edge, .node");
     var closestTitleText = getTitleText(closestNodeOrEdge);
 
-    if (!!closestNodeOrEdge) {
+    if (closestNodeOrEdge) {
       gMode.setToSelect();
     } else {
       gMode.setToHover();
     }
-    if (!(currentHighlightedTitle === closestTitleText)) {
+    if (currentHighlightedTitle !== closestTitleText) {
       resetNodesAndEdges();
       addHighlight(closestNodeOrEdge);
       pTitle2ElementMap.get(closestTitleText).forEach(addHighlight);
@@ -930,7 +930,7 @@
 var gHints = {
   HIDDEN: 1,
   SHOWN: 2,
-  state: this.HIDDEN,
+  state: 1, // === HIDDEN
   show: function () {
     document.getElementById("hints").removeAttribute("style");
     gHints.state = gHints.SHOWN;

diff --git a/types/overview.svg b/types/overview.svg