refactor: addresses small linting issues

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

Hide file tree

Showing 34 changed files with 2,843 additions and 2,789 deletions.
diff --git a/bin/depcruise-baseline.mjs b/bin/depcruise-baseline.mjs
@@ -28,7 +28,7 @@ try {
     .arguments("<files-or-directories>")
     .parse(process.argv);
 
-  if (Boolean(program.args[0])) {
+  if (program.args[0]) {
     process.exitCode = await cli(program.args, {
       ...program.opts(),
       cache: false,

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/index.mjs b/src/cli/index.mjs
@@ -90,7 +90,7 @@ function setUpListener(pCruiseOptions) {
 
   const lListenerFunction = lString2Listener.get(lListenerID);
   /* c8 ignore next 6 */
-  if (Boolean(lListenerFunction)) {
+  if (lListenerFunction) {
     lListenerFunction(
       bus,
       pCruiseOptions?.ruleSet?.options?.progress?.maximumLevel ?? INFO,

diff --git a/src/cli/listeners/performance-log/format-helpers.mjs b/src/cli/listeners/performance-log/format-helpers.mjs
@@ -65,7 +65,7 @@ function formatMessage(pMessage, pLevel) {
 export function formatTime(
   pNumber,
   pConversionMultiplier = MS_PER_SECOND,
-  pLevel,
+  pLevel = INFO,
 ) {
   return formatMessage(
     gTimeFormat(pConversionMultiplier * pNumber)

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/config-utl/extract-known-violations.mjs b/src/config-utl/extract-known-violations.mjs
@@ -21,11 +21,11 @@ import makeAbsolute from "./make-absolute.mjs";
  */
 function makeForwardCompatible(pKnownViolation) {
   let lReturnValue = pKnownViolation;
-  if (Boolean(pKnownViolation.cycle)) {
+  if (pKnownViolation.cycle) {
     lReturnValue = {
       ...pKnownViolation,
       cycle: pKnownViolation.cycle.map((pModule) => {
-        if (Boolean(pModule.name)) {
+        if (pModule.name) {
           return pModule;
         }
         return {
@@ -35,11 +35,11 @@ function makeForwardCompatible(pKnownViolation) {
       }),
     };
   }
-  if (Boolean(pKnownViolation.via)) {
+  if (pKnownViolation.via) {
     lReturnValue = {
       ...pKnownViolation,
       via: pKnownViolation.via.map((pModule) => {
-        if (Boolean(pModule.name)) {
+        if (pModule.name) {
           return pModule;
         }
         return {

diff --git a/src/enrich/soften-known-violations.mjs b/src/enrich/soften-known-violations.mjs
@@ -116,7 +116,7 @@ export default function softenKnownViolations(
   pKnownViolations,
   pSoftenedSeverity = "ignore",
 ) {
-  if (Boolean(pKnownViolations)) {
+  if (pKnownViolations) {
     bus.info("analyzing: comparing against known errors");
     return pModules.map((pModule) =>
       softenKnownViolation(pModule, pKnownViolations, pSoftenedSeverity),

diff --git a/src/extract/extract-dependencies.mjs b/src/extract/extract-dependencies.mjs
@@ -78,10 +78,10 @@ function extractDependencies(pCruiseOptions, pFileName, pTranspileOptions) {
 }
 
 function matchesDoNotFollow({ resolved, dependencyTypes }, pDoNotFollow) {
-  const lMatchesPath = Boolean(pDoNotFollow.path)
+  const lMatchesPath = pDoNotFollow.path
     ? RegExp(pDoNotFollow.path, "g").test(resolved)
     : false;
-  const lMatchesDependencyTypes = Boolean(pDoNotFollow.dependencyTypes)
+  const lMatchesDependencyTypes = pDoNotFollow.dependencyTypes
     ? intersects(dependencyTypes, pDoNotFollow.dependencyTypes)
     : false;
 

diff --git a/src/extract/resolve/determine-dependency-types.mjs b/src/extract/resolve/determine-dependency-types.mjs
@@ -59,7 +59,7 @@ function determineManifestDependencyTypes(
   /** @type {DependencyType[]} */
   let lReturnValue = ["npm-unknown"];
 
-  if (Boolean(pPackageDependencies)) {
+  if (pPackageDependencies) {
     lReturnValue = findModuleInPackageDependencies(
       pPackageDependencies,
       pModuleName,
@@ -89,7 +89,7 @@ function determineManifestDependencyTypes(
 function dependencyIsBundled(pModule, pPackageDeps) {
   let lReturnValue = false;
 
-  if (Boolean(pPackageDeps)) {
+  if (pPackageDeps) {
     const lBundledDependencies =
       pPackageDeps.bundledDependencies || pPackageDeps.bundleDependencies;
 

diff --git a/src/extract/resolve/external-module-helpers.mjs b/src/extract/resolve/external-module-helpers.mjs
@@ -32,7 +32,7 @@ import { isScoped, isRelativeModuleName } from "./module-classifiers.mjs";
  * @return {string}         the module name root
  */
 export function getPackageRoot(pModule) {
-  if (!Boolean(pModule) || isRelativeModuleName(pModule)) {
+  if (!pModule || isRelativeModuleName(pModule)) {
     return pModule;
   }
 
@@ -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
@@ -129,7 +129,7 @@ export function dependencyIsDeprecated(
     pResolveOptions,
   );
 
-  if (Boolean(lPackageJson)) {
+  if (lPackageJson) {
     lReturnValue =
       Object.hasOwn(lPackageJson, "deprecated") && lPackageJson.deprecated;
   }
@@ -154,7 +154,7 @@ export function getLicense(pModuleName, pFileDirectory, pResolveOptions) {
   );
 
   if (
-    Boolean(lPackageJson) &&
+    lPackageJson &&
     Object.hasOwn(lPackageJson, "license") &&
     typeof lPackageJson.license === "string"
   ) {

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/resolve/resolve-helpers.mjs b/src/extract/resolve/resolve-helpers.mjs
@@ -5,20 +5,20 @@ export function addLicenseAttribute(
   pModuleName,
   pResolvedModuleName,
   { baseDirectory, fileDirectory },
-  pResolveOptions
+  pResolveOptions,
 ) {
   let lReturnValue = {};
   if (
     pResolveOptions.resolveLicenses &&
     isExternalModule(
       pResolvedModuleName,
       pResolveOptions.modules,
-      baseDirectory
+      baseDirectory,
     )
   ) {
     const lLicense = getLicense(pModuleName, fileDirectory, pResolveOptions);
 
-    if (Boolean(lLicense)) {
+    if (lLicense) {
       lReturnValue.license = lLicense;
     }
   }

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",