dependency-cruiser 16.6.0 → 16.7.0-beta-1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "16.6.0",
+  "version": "16.7.0-beta-1",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",

package/src/cache/cache.mjs

@@ -13,10 +13,9 @@ import { scannableExtensions } from "#extract/transpile/meta.mjs";
 import { bus } from "#utl/bus.mjs";
 
 /**
- * @typedef {import("../../types/dependency-cruiser.mjs").IRevisionData} IRevisionData
- * @typedef {import("../../types/strict-options.mjs").IStrictCruiseOptions} IStrictCruiseOptions
- * @typedef {import("../../types/dependency-cruiser.mjs").ICruiseResult} ICruiseResult
- * @typedef {import("../../types/cache-options.mjs").cacheStrategyType} cacheStrategyType
+ * @import { IRevisionData, ICruiseResult } from "../../types/dependency-cruiser.mjs";
+ * @import { IStrictCruiseOptions } from "../../types/strict-options.mjs";
+ * @import { cacheStrategyType } from "../../types/cache-options.mjs";
  */
 
 const CACHE_FILE_NAME = "cache.json";

package/src/cache/content-strategy.mjs

@@ -10,11 +10,9 @@ import {
 } from "./helpers.mjs";
 
 /**
- * @typedef {import("../../types/dependency-cruiser.mjs").IModule} IModule
- * @typedef {import("../../types/dependency-cruiser.mjs").IRevisionChange} IRevisionChange
- * @typedef {import("../../types/dependency-cruiser.mjs").IRevisionData} IRevisionData
- * @typedef {import("../../types/dependency-cruiser.mjs").ICruiseResult} ICruiseResult
- * @typedef {import("../../types/strict-options.mjs").IStrictCruiseOptions} IStrictCruiseOptions
+ * @import { IModule, IRevisionChange, IRevisionData, ICruiseResult } from "../../types/dependency-cruiser.mjs"
+ * @import { IStrictCruiseOptions } from "../../types/strict-options.mjs"
+ * @import { changeType, getSHA } from "watskeburt"
  */
 
 /**
@@ -56,10 +54,10 @@ export default class ContentStrategy {
    * @param {IStrictCruiseOptions} pCruiseOptions
    * @param {Object} pOptions
    * @param {Set<string>} pOptions.extensions
-   * @param {Set<import("watskeburt").changeType>=} pOptions.interestingChangeTypes?
+   * @param {Set<changeType>=} pOptions.interestingChangeTypes?
    * @param {string=} pOptions.baseDir
    * @param {typeof findContentChanges=} pOptions.diffListFn
-   * @param {typeof import('watskeburt').getSHA=} pOptions.checksumFn
+   * @param {typeof getSHA=} pOptions.checksumFn
    * @returns {IRevisionData}
    */
   getRevisionData(pDirectory, pCachedCruiseResult, pCruiseOptions, pOptions) {

package/src/cache/find-content-changes.mjs

@@ -11,10 +11,16 @@ import {
 import { bus } from "#utl/bus.mjs";
 import findAllFiles from "#utl/find-all-files.mjs";
 
+/**
+ * @import { IModule, IRevisionChange } from "../../types/dependency-cruiser.mjs"
+ * @import { ICruiseResult } from "../../types/cruise-result.mjs"
+ * @import { IStrictExcludeType, IStrictIncludeOnlyType } from "../../types/strict-filter-types.mjs"
+ */
+
 /**
  * @param {Set<string>} pFileSet
  * @param {typeof getFileHashSync} pFileHashFunction
- * @returns {(pModule:import("../..").IModule) => import('../..').IRevisionChange}
+ * @returns {(pModule:IModule) => IRevisionChange}
  */
 function diffCachedModuleAgainstFileSet(
   pFileSet,
@@ -63,13 +69,13 @@ function diffCachedModuleAgainstFileSet(
   - there is a cache, but it doesn't contain checksums => same as before, except
     all files will be marked as 'modified'
  * @param {string} pDirectory
- * @param {import("../..").ICruiseResult} pCachedCruiseResult
+ * @param {ICruiseResult} pCachedCruiseResult
  * @param {Object} pOptions
  * @param {Set<string>} pOptions.extensions
  * @param {string} pOptions.baseDir
- * @param {import("../../types/strict-filter-types.mjs").IStrictExcludeType} pOptions.exclude
- * @param {import("../../types/strict-filter-types.mjs").IStrictIncludeOnlyType=} pOptions.includeOnly
- * @returns {import("../..").IRevisionChange[]}
+ * @param {IStrictExcludeType} pOptions.exclude
+ * @param {IStrictIncludeOnlyType=} pOptions.includeOnly
+ * @returns {IRevisionChange[]}
  */
 export default function findContentChanges(
   pDirectory,

package/src/cache/helpers.mjs

@@ -6,10 +6,10 @@ import memoize from "memoize";
 import { filenameMatchesPattern } from "#graph-utl/match-facade.mjs";
 
 /**
- * @typedef {import("../..").IModule} IModule
- * @typedef {import("../../types/dependency-cruiser.mjs").IRevisionChange} IRevisionChange
- * @typedef {import("../../types/filter-types.mjs").IExcludeType} IExcludeType
- * @typedef {import("../../types/strict-filter-types.mjs").IStrictIncludeOnlyType} IStrictIncludeOnlyType
+ * @import { IModule, IRevisionChange, } from "../../types/dependency-cruiser.mjs"
+ * @import { IExcludeType } from "../../types/filter-types.mjs"
+ * @import { IStrictIncludeOnlyType } from "../../types/strict-filter-types.mjs"
+ * @import { changeType, IChange } from "watskeburt"
  */
 
 /**
@@ -35,7 +35,7 @@ function _getFileHashSync(pFileName) {
 export const getFileHashSync = memoize(_getFileHashSync);
 
 /**
- * @param {import("watskeburt").IChange} pChange
+ * @param {IChange} pChange
  * @return {IRevisionChange}
  */
 export function addCheckSumToChangeSync(pChange) {
@@ -80,7 +80,7 @@ export function hasInterestingExtension(pExtensions) {
 
 /**
  * @param {Set<string>} pExtensions
- * @returns {(pChange: import("watskeburt").IChange) => boolean}
+ * @returns {(pChange: IChange) => boolean}
  */
 export function changeHasInterestingExtension(pExtensions) {
   return (pChange) => {
@@ -106,8 +106,8 @@ const DEFAULT_INTERESTING_CHANGE_TYPES = new Set([
 ]);
 
 /**
- * @param {Set<import("watskeburt").changeType>=} pInterestingChangeTypes
- * @returns {(pChange: import("watskeburt").IChange) => boolean}
+ * @param {Set<changeType>=} pInterestingChangeTypes
+ * @returns {(pChange: IChange) => boolean}
  */
 export function isInterestingChangeType(pInterestingChangeTypes) {
   return (pChange) =>

package/src/cache/metadata-strategy.mjs

@@ -12,20 +12,18 @@ import {
 import { bus } from "#utl/bus.mjs";
 
 /**
- * @typedef {import("../../types/dependency-cruiser.mjs").IModule} IModule
- * @typedef {import("../../types/dependency-cruiser.mjs").IRevisionChange} IRevisionChange
- * @typedef {import("../../types/dependency-cruiser.mjs").IRevisionData} IRevisionData
- * @typedef {import("../../types/dependency-cruiser.mjs").ICruiseResult} ICruiseResult
- * @typedef {import("../../types/strict-options.mjs").IStrictCruiseOptions} IStrictCruiseOptions
+ * @import {IModule, IRevisionChange, IRevisionData, ICruiseResult } from "../../types/dependency-cruiser.mjs"
+ * @import { IStrictCruiseOptions } from "../../types/strict-options.mjs"
+ * @import { changeType, IChange } from "watskeburt"
  */
 
 export default class MetaDataStrategy {
   /**
    * @param {string} _pDirectory
-   * @param {import("../../types/cruise-result.mjs").ICruiseResult} _pCachedCruiseResult
+   * @param {ICruiseResult} _pCachedCruiseResult
    * @param {Object} pOptions
    * @param {Set<string>} pOptions.extensions
-   * @param {Set<import("watskeburt").changeType>=} pOptions.interestingChangeTypes
+   * @param {Set<changeType>=} pOptions.interestingChangeTypes
    * @param {typeof getSHA=} pOptions.shaRetrievalFn
    * @param {typeof list=} pOptions.diffListFn
    * @param {typeof addCheckSumToChangeSync=} pOptions.checksumFn
@@ -47,7 +45,7 @@ export default class MetaDataStrategy {
       bus.debug("cache: - getting sha");
       const lSHA = await lOptions.shaRetrievalFn();
       bus.debug("cache: - getting diff");
-      const lDiff = /** @type {import("watskeburt").IChange[]} */ (
+      const lDiff = /** @type {IChange[]} */ (
         await lOptions.diffListFn({ oldRevision: lSHA })
       );
       const lChanges = lDiff

package/src/cache/options-compatible.mjs

@@ -2,7 +2,7 @@
 import { isDeepStrictEqual } from "node:util";
 
 /**
- * @typedef {import("../../types/strict-options.mjs").IStrictCruiseOptions} IStrictCruiseOptions
+ * @import { IStrictCruiseOptions } from "../../types/strict-options.mjs"
  */
 
 /*
@@ -105,6 +105,7 @@ export function optionsAreCompatible(pOldOptions, pNewOptions) {
     pOldOptions.preserveSymlinks === pNewOptions.preserveSymlinks &&
     pOldOptions.combinedDependencies === pNewOptions.combinedDependencies &&
     pOldOptions.experimentalStats === pNewOptions.experimentalStats &&
+    pOldOptions.detectJSDocImports === pNewOptions.detectJSDocImports &&
     metricsIsCompatible(pOldOptions.metrics, pNewOptions.metrics) &&
     // includeOnly suffers from a backwards compatibility disease
     includeOnlyIsCompatible(pOldOptions.includeOnly, pNewOptions.includeOnly) &&

package/src/cli/init-config/build-config.mjs

@@ -2,6 +2,10 @@
 import { folderNameArrayToRE } from "./utl.mjs";
 import configTemplate from "./config-template.mjs";
 
+/**
+ * @import { IInitConfig } from "./types.js";
+ */
+
 /**
  * @param {string} pString
  * @returns {string}
@@ -22,7 +26,7 @@ function extensionsToString(pExtensions) {
 }
 
 /**
- * @param {import("./types.js").IInitConfig} pInitOptions
+ * @param {IInitConfig} pInitOptions
  * @returns {string}
  */
 function buildNotToTestRule(pInitOptions) {
@@ -49,7 +53,7 @@ function buildNotToTestRule(pInitOptions) {
 }
 
 /**
- * @param {import("./types.js").IInitConfig} pInitOptions
+ * @param {IInitConfig} pInitOptions
  * @returns {string}
  */
 function buildTsPreCompilationDepsAttribute(pInitOptions) {
@@ -59,7 +63,7 @@ function buildTsPreCompilationDepsAttribute(pInitOptions) {
 }
 
 /**
- * @param {import("./types.js").IInitConfig} pInitOptions
+ * @param {IInitConfig} pInitOptions
  * @returns {string}
  */
 function buildCombinedDependenciesAttribute(pInitOptions) {
@@ -69,7 +73,7 @@ function buildCombinedDependenciesAttribute(pInitOptions) {
 }
 
 /**
- * @param {import("./types.js").IInitConfig} pInitOptions
+ * @param {IInitConfig} pInitOptions
  * @returns {string}
  */
 function buildTsOrJsConfigAttribute(pInitOptions) {
@@ -89,7 +93,7 @@ function buildTsOrJsConfigAttribute(pInitOptions) {
 }
 
 /**
- * @param {import("./types.js").IInitConfig} pInitOptions
+ * @param {IInitConfig} pInitOptions
  * @returns {string}
  */
 function buildWebpackConfigAttribute(pInitOptions) {
@@ -107,7 +111,7 @@ function buildWebpackConfigAttribute(pInitOptions) {
 }
 
 /**
- * @param {import("./types.js").IInitConfig} pInitOptions
+ * @param {IInitConfig} pInitOptions
  * @returns {string}
  */
 function buildBabelConfigAttribute(pInitOptions) {
@@ -121,7 +125,7 @@ function buildBabelConfigAttribute(pInitOptions) {
 }
 
 /**
- * @param {import("./types.js").IInitConfig} pInitOptions
+ * @param {IInitConfig} pInitOptions
  * @returns {string}
  */
 function buildExtensionsAttribute(pInitOptions) {
@@ -131,7 +135,7 @@ function buildExtensionsAttribute(pInitOptions) {
 }
 
 /**
- * @param {import("./types.js").IInitConfig} pInitOptions
+ * @param {IInitConfig} pInitOptions
  * @returns {string}
  */
 function buildMainFieldsAttribute(pInitOptions) {
@@ -149,7 +153,7 @@ function buildMainFieldsAttribute(pInitOptions) {
  * Creates a .dependency-cruiser config with a set of basic validations
  * to the current directory.
  *
- * @param {import("./types.js").IInitConfig} pInitOptions ('Normalized') options that influence the shape of
+ * @param {IInitConfig} pInitOptions ('Normalized') options that influence the shape of
  *                  the configuration
  * @returns {string} the configuration as a string
  */

package/src/cli/init-config/config-template.mjs

@@ -228,6 +228,17 @@ module.exports = {
     
     // moduleSystems: ['cjs', 'es6'],
 
+    /* 
+      false: don't look at JSDoc imports
+      true: dependency-cruiser will detect dependencies in JSDoc-style
+      import statements. Implies "parser": "tsc", so the dependency-cruiser
+      will use the typescript parser for JavaScript files.
+     
+      For this to work the typescript compiler will need to be installed in the
+      same spot as you're running dependency-cruiser from.
+     */
+    // detectJSDocImports: true,
+
     /* prefix for links in html and svg output (e.g. 'https://github.com/you/yourrepo/blob/main/'
        to open it on your online repo or \`vscode://file/$\{process.cwd()}/\` to 
        open it in visual studio code),

package/src/cli/init-config/index.mjs

@@ -20,17 +20,21 @@ import {
 } from "./environment-helpers.mjs";
 import { writeRunScriptsToManifest } from "./write-run-scripts-to-manifest.mjs";
 
+/**
+ * @import { IInitConfig, IPartialInitConfig, OneShotConfigIDType } from "./types.js";
+ */
+
 const PACKAGE_MANIFEST = `./${_PACKAGE_MANIFEST}`;
 
 /**
  * Create a initialization configuration based on guessed defaults
  * (e.g. a tsconfig exists => use it and assume typescript is used)
  *
- * @param {import("./types").OneShotConfigIDType} pOneShotConfigId
- * @return {import("./types").IPartialInitConfig} an initialization configuration
+ * @param {OneShotConfigIDType} pOneShotConfigId
+ * @return {IPartialInitConfig} an initialization configuration
  */
 function getOneShotConfig(pOneShotConfigId) {
-  /** @type {import("./types").IPartialInitConfig} */
+  /** @type {IPartialInitConfig} */
   const lBaseConfig = {
     isMonoRepo: isLikelyMonoRepo(),
     isTypeModule: isTypeModule(),
@@ -46,7 +50,7 @@ function getOneShotConfig(pOneShotConfigId) {
     babelConfig: getBabelConfigCandidates().shift(),
     specifyResolutionExtensions: true,
   };
-  /** @type {Map<import("./types").OneShotConfigIDType, import("./types").IPartialInitConfig>} */
+  /** @type {Map<OneShotConfigIDType, IPartialInitConfig>} */
   const lOneShotConfigs = new Map([
     ["yes", lBaseConfig],
     [
@@ -63,7 +67,7 @@ function getOneShotConfig(pOneShotConfigId) {
 
 /**
  *
- * @param {import("./types").IInitConfig} pNormalizedInitConfig
+ * @param {IInitConfig} pNormalizedInitConfig
  */
 function manifestIsUpdatable(pNormalizedInitConfig) {
   return (
@@ -73,7 +77,7 @@ function manifestIsUpdatable(pNormalizedInitConfig) {
 }
 
 /**
- * @param {boolean|import("./types").OneShotConfigIDType} pInit
+ * @param {boolean|OneShotConfigIDType} pInit
  * @param {string=} pConfigFileName
  * @param {{stdout: NodeJS.WritableStream, stderr: NodeJS.WritableStream}=} pStreams
  */

package/src/cli/init-config/normalize-init-options.mjs

@@ -8,7 +8,11 @@ import findExtensions from "./find-extensions.mjs";
 import meta from "#meta.cjs";
 
 /**
- * @param {import("./types.js").IInitConfig} pInitOptions
+ * @import { IInitConfig, IPartialInitConfig } from "./types.js";
+ */
+
+/**
+ * @param {IInitConfig} pInitOptions
  * @param {string[]} pExtensions
  * @returns {boolean}
  */
@@ -25,7 +29,7 @@ function usesTypeScript(pInitOptions, pExtensions) {
 }
 
 /**
- * @param {import("./types.js").IInitConfig} pInitOptions
+ * @param {IInitConfig} pInitOptions
  * @returns {string[]}
  */
 function getExtensions(pInitOptions) {
@@ -38,8 +42,8 @@ function getExtensions(pInitOptions) {
 }
 
 /**
- * @param {import("./types.js").IPartialInitConfig} pInitOptions
- * @return {import("./types.js").IPartialInitConfig}
+ * @param {IPartialInitConfig} pInitOptions
+ * @return {IPartialInitConfig}
  */
 function populate(pInitOptions) {
   const lReturnValue = {
@@ -66,8 +70,8 @@ function populate(pInitOptions) {
 
 /**
  *
- * @param {import("./types.js").IPartialInitConfig} pInitOptions
- * @return {import("./types.js").IInitConfig}
+ * @param {IPartialInitConfig} pInitOptions
+ * @return {IInitConfig}
  */
 export default function normalizeInitOptions(pInitOptions) {
   let lReturnValue = populate(pInitOptions);

package/src/config-utl/extract-depcruise-options.mjs

@@ -1,9 +1,13 @@
 import extractDepcruiseConfig from "./extract-depcruise-config/index.mjs";
 
 /**
- *
- * @param {import('../../../types/configuration.mjs').IConfiguration}} pConfiguration
- * @returns {import('../../../types/configuration.mjs').ICruiseOptions}
+ * @import { IConfiguration } from "../../types/configuration.mjs";
+ * @import { ICruiseOptions } from "../../types/options.mjs";
+ */
+
+/**
+ * @param {IConfiguration} pConfiguration
+ * @returns {ICruiseOptions}
  */
 function configuration2options(pConfiguration) {
   /* c8 ignore next 1 */
@@ -20,7 +24,7 @@ function configuration2options(pConfiguration) {
 /**
  *
  * @param {string} pConfigFileName
- * @returns {Promise<import('../../../types/configuration.mjs').ICruiseOptions>}
+ * @returns {Promise<ICruiseOptions>}
  */
 export default async function extractDepcruiseOptions(pConfigFileName) {
   const lReturnValue = await extractDepcruiseConfig(pConfigFileName);

package/src/config-utl/extract-known-violations.mjs

@@ -3,8 +3,8 @@ import json5 from "json5";
 import makeAbsolute from "./make-absolute.mjs";
 
 /**
- * @typedef {import("../../types/violations.d.mjs").IViolation} IViolation
- * @typedef {import("../../types/shared-types.d.mts").DependencyType} DependencyType
+ * @import { IViolation } from "../../types/violations.mjs"
+ * @import { DependencyType } from "../../types/shared-types.mjs"
  *
  * @typedef {IViolation & {cycle: Array<{name: string, dependencyTypes: Array<DependencyType>}>} | {cycle: Array<DependencyType>}} IMaybeOldFormatViolation
  */

package/src/enrich/summarize/summarize-options.mjs

@@ -4,6 +4,7 @@ const SHAREABLE_OPTIONS = [
   "cache",
   "collapse",
   "combinedDependencies",
+  "detectJSDocImports",
   "doNotFollow",
   "enhancedResolveOptions",
   "exclude",
@@ -20,6 +21,7 @@ const SHAREABLE_OPTIONS = [
   "moduleSystems",
   "outputTo",
   "outputType",
+  "parser",
   "prefix",
   "preserveSymlinks",
   "reaches",

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))) {
@@ -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

@@ -8,8 +8,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 +40,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 +92,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,