dependency-cruiser 16.6.0 → 16.7.0-beta-2

package/src/extract/extract-dependencies.mjs

@@ -15,6 +15,11 @@ import {
 } from "./helpers.mjs";
 import { uniqBy, intersects } from "#utl/array-util.mjs";
 
+/**
+ * @import { IDependency } from "../../types/cruise-result.mjs";
+ * @import { IResolveOptions, IStrictCruiseOptions, ITranspileOptions } from "../../types/dependency-cruiser.mjs";
+ */
+
 function extractWithTsc(pCruiseOptions, pFileName, pTranspileOptions) {
   let lDependencies = tscExtract(pCruiseOptions, pFileName, pTranspileOptions);
 
@@ -30,7 +35,7 @@ function extractWithTsc(pCruiseOptions, pFileName, pTranspileOptions) {
 /**
  * @param {IStrictCruiseOptions} pCruiseOptions
  * @param {string} pFileName
- * @returns {(IStrictCruiseOptions, string, any) => import("../../types/cruise-result.mjs").IDependency[]}
+ * @returns {(IStrictCruiseOptions, string, any) => IDependency[]}
  */
 function determineExtractionFunction(pCruiseOptions, pFileName) {
   let lExtractionFunction = acornExtract;
@@ -45,13 +50,13 @@ function determineExtractionFunction(pCruiseOptions, pFileName) {
 }
 
 /**
- * @param {import('../../types/dependency-cruiser.js').IStrictCruiseOptions} pCruiseOptions
+ * @param {IStrictCruiseOptions} pCruiseOptions
  * @param {string} pFileName
  * @param {any} pTranspileOptions
- * @returns {import('../../types/cruise-result.mjs').IDependency[]}
+ * @returns {IDependency[]}
  */
 function extractDependencies(pCruiseOptions, pFileName, pTranspileOptions) {
-  /** @type import('../../types/cruise-result.mjs').IDependency[] */
+  /** @type IDependency[] */
   let lDependencies = [];
 
   if (!pCruiseOptions.extraExtensionsToScan.includes(extname(pFileName))) {
@@ -73,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;
 
@@ -114,7 +119,7 @@ function matchesPattern(pFullPathToFile, pPattern) {
 
 /**
  *
- * @param {import("../../types/dependency-cruiser.js").IDependency} pDependency
+ * @param {IDependency} pDependency
  * @returns {string}
  */
 function getDependencyUniqueKey({ module, moduleSystem, dependencyTypes }) {
@@ -143,12 +148,12 @@ function compareDeps(pLeft, pRight) {
  *
  *
  * @param  {string} pFileName path to the file
- * @param  {import("../../types/dependency-cruiser.js").IStrictCruiseOptions} pCruiseOptions cruise options
- * @param {import("../../types/dependency-cruiser.js").IResolveOptions} pResolveOptions  webpack 'enhanced-resolve' options
- * @param  {import("../../types/dependency-cruiser.js").ITranspileOptions} pTranspileOptions       an object with tsconfig ('typescript project') options
+ * @param  {IStrictCruiseOptions} pCruiseOptions cruise options
+ * @param {IResolveOptions} pResolveOptions  webpack 'enhanced-resolve' options
+ * @param  {ITranspileOptions} pTranspileOptions       an object with tsconfig ('typescript project') options
  *                               ('flattened' so there's no need for file access on any
  *                               'extends' option in there)
- * @return {import("../../types/dependency-cruiser.js").IDependency[]} an array of dependency objects (see above)
+ * @return {IDependency[]} an array of dependency objects (see above)
  */
 export default function getDependencies(
   pFileName,

package/src/extract/extract-stats.mjs

@@ -4,10 +4,15 @@ import {
 } from "./tsc/extract.mjs";
 import { getStats as acornStats } from "./acorn/extract.mjs";
 
+/**
+ * @import { IStrictCruiseOptions, ITranspileOptions } from "../../types/dependency-cruiser.mjs";
+ * @import { IDependency } from "../../types/cruise-result.mjs";
+ */
+
 /**
  * @param {IStrictCruiseOptions} pCruiseOptions
  * @param {string} pFileName
- * @returns {(IStrictCruiseOptions, string, any) => import("../../types/cruise-result.mjs").IDependency[]}
+ * @returns {(IStrictCruiseOptions, string, any) => IDependency[]}
  */
 function determineExtractionFunction(pCruiseOptions, pFileName) {
   let lExtractionFunction = acornStats;
@@ -23,11 +28,11 @@ function determineExtractionFunction(pCruiseOptions, pFileName) {
  * Returns some stats for the module in pFileName
  *
  * @param  {string} pFileName path to the file
- * @param  {import("../../types/dependency-cruiser.js").IStrictCruiseOptions} pCruiseOptions cruise options
- * @param  {import("../../types/dependency-cruiser.js").ITranspileOptions} pTranspileOptions       an object with tsconfig ('typescript project') options
+ * @param  {IStrictCruiseOptions} pCruiseOptions cruise options
+ * @param  {ITranspileOptions} pTranspileOptions       an object with tsconfig ('typescript project') options
  *                               ('flattened' so there's no need for file access on any
  *                               'extends' option in there)
- * @return {import("../../types/dependency-cruiser.js").IDependency[]} an array of dependency objects (see above)
+ * @return {IDependency[]} an array of dependency objects (see above)
  */
 export default function extractStats(
   pFileName,

package/src/extract/gather-initial-sources.mjs

@@ -1,5 +1,6 @@
 import { readdirSync, statSync } from "node:fs";
 import { join, normalize } from "node:path";
+// eslint-disable-next-line n/prefer-global/process
 import { platform } from "node:process";
 import picomatch from "picomatch";
 import { scannableExtensions } from "./transpile/meta.mjs";
@@ -8,8 +9,11 @@ import getExtension from "#utl/get-extension.mjs";
 import pathToPosix from "#utl/path-to-posix.mjs";
 
 /**
- *
- * @param {import('../../types/options.mjs').IStrictCruiseOptions} pOptions
+ * @import {IStrictCruiseOptions} from "../../types/options.mjs";
+ */
+
+/**
+ * @param {IStrictCruiseOptions} pOptions
  * @returns {string[]}
  */
 function getScannableExtensions(pOptions) {
@@ -37,9 +41,8 @@ function shouldNotBeExcluded(pFullPathToFile, pOptions) {
 }
 
 /**
- *
  * @param {string} pDirectoryName
- * @param  {import('../../types/options.mjs').IStrictCruiseOptions} pOptions options that
+ * @param {IStrictCruiseOptions} pOptions options that
  * @returns {string[]}
  */
 function gatherScannableFilesFromDirectory(pDirectoryName, pOptions) {
@@ -90,7 +93,7 @@ function expandGlob(pBaseDirectory, pScannedGlob) {
  *
  * @param  {string[]} pFileDirectoryAndGlobArray globs and/ or paths to files or
  *                               directories to be gathered
- * @param  {import('../../types/dependency-cruiser.js').IStrictCruiseOptions} pOptions options that
+ * @param  {IStrictCruiseOptions} pOptions options that
  *                               influence what needs to be gathered/ scanned
  *                               notably useful attributes:
  *                               - exclude - regexp of what to exclude

package/src/extract/index.mjs

@@ -4,6 +4,11 @@ import gatherInitialSources from "./gather-initial-sources.mjs";
 import clearCaches from "./clear-caches.mjs";
 import { bus } from "#utl/bus.mjs";
 
+/**
+ * @import {IStrictCruiseOptions} from "../../types/options.mjs";
+ * @import { IModule, IResolveOptions, ITranspileOptions } from "../../types/dependency-cruiser.mjs";
+ */
+
 /* eslint max-params:0 , max-lines-per-function:0*/
 function extractRecursive(
   pFileName,
@@ -142,10 +147,10 @@ function filterExcludedDynamicDependencies(pModule, pExclude) {
  * returns an array of all the modules it finds that way.
  *
  * @param {string[]} pFileDirectoryArray
- * @param {import("../../types/dependency-cruiser.js").IStrictCruiseOptions} pCruiseOptions
- * @param {import("../../types/dependency-cruiser.js").IResolveOptions} pResolveOptions
- * @param {import("../../types/dependency-cruiser.js").ITranspileOptions} pTranspileOptions
- * @returns {Partial<import("../../types/dependency-cruiser.js").IModule[]>}
+ * @param {IStrictCruiseOptions} pCruiseOptions
+ * @param {IResolveOptions} pResolveOptions
+ * @param {ITranspileOptions} pTranspileOptions
+ * @returns {Partial<IModule[]>}
  */
 export default function extract(
   pFileDirectoryArray,

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

@@ -9,6 +9,13 @@ import {
   getPackageRoot,
 } from "./external-module-helpers.mjs";
 
+/**
+ * @import { DependencyType } from "../../../types/shared-types.mjs"
+ * @import { IResolveOptions, ITranspileOptions } from "../../../types/dependency-cruiser.mjs"
+ * @import { IDependency } from "../../../types/cruise-result.mjs"
+ * @import { IResolveOptions } from "../../../types/resolve-options.mjs"
+ */
+
 function dependencyKeyHasModuleName(
   pPackageDependencies,
   pModuleName,
@@ -49,10 +56,10 @@ function determineManifestDependencyTypes(
   pPackageDependencies,
   pResolverModulePaths,
 ) {
-  /** @type {import("../../../types/shared-types.js").DependencyType[]} */
+  /** @type {DependencyType[]} */
   let lReturnValue = ["npm-unknown"];
 
-  if (Boolean(pPackageDependencies)) {
+  if (pPackageDependencies) {
     lReturnValue = findModuleInPackageDependencies(
       pPackageDependencies,
       pModuleName,
@@ -82,7 +89,7 @@ function determineManifestDependencyTypes(
 function dependencyIsBundled(pModule, pPackageDeps) {
   let lReturnValue = false;
 
-  if (Boolean(pPackageDeps)) {
+  if (pPackageDeps) {
     const lBundledDependencies =
       pPackageDeps.bundledDependencies || pPackageDeps.bundleDependencies;
 
@@ -98,8 +105,8 @@ function dependencyIsBundled(pModule, pPackageDeps) {
  * @param {string} pModuleName
  * @param {string} pPackageDeps
  * @param {string} pFileDirectory
- * @param {import("../../../types/dependency-cruiser.js").IResolveOptions} pResolveOptions
- * @returns {import("../../../types/shared-types.js").DependencyType[]}
+ * @param {IResolveOptions} pResolveOptions
+ * @returns {DependencyType[]}
  */
 function determineNodeModuleDependencyTypes(
   pModuleName,
@@ -107,7 +114,7 @@ function determineNodeModuleDependencyTypes(
   pFileDirectory,
   pResolveOptions,
 ) {
-  /** @type {import("../../../types/shared-types.js").DependencyType[]} */
+  /** @type { DependencyType[] } */
   let lReturnValue = determineManifestDependencyTypes(
     getPackageRoot(pModuleName),
     pPackageDeps,
@@ -127,13 +134,13 @@ function determineNodeModuleDependencyTypes(
 
 /**
  *
- * @param {import("../../../types/cruise-result.mjs").IDependency} pDependency
+ * @param {IDependency} pDependency
  * @param {string} pModuleName
  * @param {any} pPackageDeps
  * @param {string} pFileDirectory
- * @param {import("../../../types/dependency-cruiser.js").IResolveOptions} pResolveOptions
+ * @param {IResolveOptions} pResolveOptions
  * @param {string} pBaseDirectory
- * @returns {import("../../../types/shared-types.js").DependencyType[]}
+ * @returns {DependencyType[]}
  */
 function determineExternalModuleDependencyTypes(
   pDependency,
@@ -143,7 +150,7 @@ function determineExternalModuleDependencyTypes(
   pResolveOptions,
   pBaseDirectory,
 ) {
-  /** @type {import("../../../types/shared-types.js").DependencyType[]} */
+  /** @type { DependencyType[] } */
   let lReturnValue = [];
 
   if (
@@ -164,15 +171,15 @@ function determineExternalModuleDependencyTypes(
 /* eslint max-params:0, complexity:0 */
 /**
  *
- * @param {import("../../../types/cruise-result.mjs").IDependency} pDependency the dependency object with all information found hitherto
+ * @param {IDependency} pDependency the dependency object with all information found hitherto
  * @param {string} pModuleName the module name as found in the source
  * @param {any} pManifest a package.json, in object format
  * @param {string} pFileDirectory the directory relative to which to resolve (only used for npm deps here)
- * @param {import("../../../types/resolve-options.mjs").IResolveOptions} pResolveOptions an enhanced resolve 'resolve' key
+ * @param {IResolveOptions} pResolveOptions an enhanced resolve 'resolve' key
  * @param {string} pBaseDirectory the base directory dependency cruise is run on
- * @param {import("../../../types/dependency-cruiser.mjs").ITranspileOptions} pTranspileOptions
+ * @param {ITranspileOptions} pTranspileOptions
  *
- * @return {import("../../../types/shared-types.js").DependencyType[]} an array of dependency types for the dependency
+ * @return { DependencyType[] }an array of dependency types for the dependency
  */
 // eslint-disable-next-line max-lines-per-function
 export default function determineDependencyTypes(
@@ -184,7 +191,7 @@ export default function determineDependencyTypes(
   pBaseDirectory,
   pTranspileOptions,
 ) {
-  /** @type {import("../../../types/shared-types.js").DependencyType[]}*/
+  /** @type {DependencyType[]}*/
   let lReturnValue = [];
   const lResolveOptions = pResolveOptions || {};
 

package/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"
   ) {

package/src/extract/resolve/index.mjs

@@ -8,12 +8,18 @@ import determineDependencyTypes from "./determine-dependency-types.mjs";
 import { getManifest } from "./get-manifest.mjs";
 import pathToPosix from "#utl/path-to-posix.mjs";
 
+/**
+ * @import { IModule, IResolveOptions } from "../../../types/dependency-cruiser.mjs";
+ * @import { IResolveOptions } from "../../../types/resolve-options.mjs";
+ * @import { IDependency } from "../../../types/cruise-result.mjs";
+ */
+
 /**
  *
- * @param {import("../../../types/dependency-cruiser.js").IModule} pModule
+ * @param {IModule} pModule
  * @param {string} pBaseDirectory
  * @param {string} pFileDirectory
- * @param {import("../../../types/dependency-cruiser.js").IResolveOptions} pResolveOptions
+ * @param {IResolveOptions} pResolveOptions
  * @returns {any}
  */
 function resolveModule(
@@ -154,14 +160,14 @@ function resolveWithRetry(
 /**
  * resolves the module name of the pDependency to a file on disk.
  *
- * @param  {Partial <import("../../../types/cruise-result.mjs").IDependency>} pDependency
+ * @param  {Partial <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.mjs").IResolveOptions} pResolveOptions
+ * @param  {IResolveOptions} pResolveOptions
  * @param  {any} pTranspileOptions
- * @return {Partial <import("../../../types/cruise-result.mjs").IDependency>}
+ * @return {Partial <IDependency>}
  *
  *
  */

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

@@ -4,6 +4,11 @@ import { join as posix_join } from "node:path/posix";
 import picomatch from "picomatch";
 import getExtension from "#utl/get-extension.mjs";
 
+/**
+ * @import { IResolveOptions } from "../../../types/resolve-options.mjs"
+ * @import { ITranspileOptions } from "../../../types/dependency-cruiser.mjs"
+ */
+
 let gFollowableExtensionsCache = new Set();
 let gFollowableExtensionsCacheInitialized = false;
 
@@ -145,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.
     //
@@ -188,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?
@@ -278,9 +283,9 @@ function matchesTSConfigBaseURL(
 /**
  * @param {string} pModuleName
  * @param {string} pResolvedModuleName
- * @param {import("../../../types/resolve-options.mjs").IResolveOptions} pResolveOptions
+ * @param {importIResolveOptions} pResolveOptions
  * @param {any} pManifest
- * @param {import("../../../types/dependency-cruiser.mjs").ITranspileOptions} pTranspileOptions
+ * @param {ITranspileOptions} pTranspileOptions
  * @returns {string[]}
  */
 // eslint-disable-next-line max-params, complexity

package/src/extract/resolve/resolve-helpers.mjs

@@ -5,7 +5,7 @@ export function addLicenseAttribute(
   pModuleName,
   pResolvedModuleName,
   { baseDirectory, fileDirectory },
-  pResolveOptions
+  pResolveOptions,
 ) {
   let lReturnValue = {};
   if (
@@ -13,12 +13,12 @@ export function addLicenseAttribute(
     isExternalModule(
       pResolvedModuleName,
       pResolveOptions.modules,
-      baseDirectory
+      baseDirectory,
     )
   ) {
     const lLicense = getLicense(pModuleName, fileDirectory, pResolveOptions);
 
-    if (Boolean(lLicense)) {
+    if (lLicense) {
       lReturnValue.license = lLicense;
     }
   }

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

package/src/extract/swc/parse.mjs

@@ -2,10 +2,14 @@ import memoize, { memoizeClear } from "memoize";
 import tryImport from "#utl/try-import.mjs";
 import meta from "#meta.cjs";
 
-/** @type {import('@swc/core')} */
+/**
+ * @import swcCore, { ParseOptions, ModuleItem } from "@swc/core";
+ */
+
+/** @type {swcCore} */
 const swc = await tryImport("@swc/core", meta.supportedTranspilers.swc);
 
-/** @type {import('@swc/core').ParseOptions} */
+/** @type {ParseOptions} */
 const SWC_PARSE_OPTIONS = {
   dynamicImport: true,
   // typescript is a superset of ecmascript, so we use typescript always
@@ -22,7 +26,7 @@ export function getASTFromSource(pSource) {
 }
 
 function getAST(pFileName) {
-  /** @type {import('@swc/core')} swc */
+  /** @type {swcCore swc} */
   return swc.parseFileSync(pFileName, SWC_PARSE_OPTIONS);
 }
 
@@ -32,7 +36,7 @@ function getAST(pFileName) {
  * return the result from a cache
  *
  * @param {string} pFileName - the name of the file to compile
- * @return {import('@swc/core').ModuleItem[]} - an (swc) AST
+ * @return {ModuleItem[]} - an (swc) AST
  */
 export const getASTCached = memoize(getAST);