dependency-cruiser 10.3.0 → 10.4.0-beta-1

package/package.json

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

package/src/extract/ast-extractors/extract-typescript-deps.js

@@ -30,6 +30,9 @@ function extractImportsAndExports(pAST) {
       module: pStatement.moduleSpecifier.text,
       moduleSystem: "es6",
       exoticallyRequired: false,
+      ...(pStatement.importClause && pStatement.importClause.isTypeOnly
+        ? { typeOnly: true }
+        : {}),
     }));
 }
 

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

@@ -144,7 +144,7 @@ function determineExternalModuleDependencyTypes(
 /* eslint max-params:0, complexity:0 */
 /**
  *
- * @param {import("../../../types/cruise-result").IModule} pModule the dependency object with all information found hitherto
+ * @param {import("../../../types/cruise-result").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)
@@ -154,7 +154,7 @@ function determineExternalModuleDependencyTypes(
  * @return {import("../../../types/shared-types").DependencyType[]} an array of dependency types for the dependency
  */
 module.exports = function determineDependencyTypes(
-  pModule,
+  pDependency,
   pModuleName,
   pManifest,
   pFileDirectory,
@@ -165,7 +165,7 @@ module.exports = function determineDependencyTypes(
   let lReturnValue = ["undetermined"];
   pResolveOptions = pResolveOptions || {};
 
-  if (pModule.couldNotResolve) {
+  if (pDependency.couldNotResolve) {
     lReturnValue = ["unknown"];
   } else if (isCore(pModuleName)) {
     // this 'isCore' business seems duplicate (it's already in
@@ -177,20 +177,28 @@ module.exports = function determineDependencyTypes(
   } else if (isRelativeModuleName(pModuleName)) {
     lReturnValue = ["local"];
   } else if (
-    isExternalModule(pModule.resolved, pResolveOptions.modules, pBaseDirectory)
+    isExternalModule(
+      pDependency.resolved,
+      pResolveOptions.modules,
+      pBaseDirectory
+    )
   ) {
     lReturnValue = determineExternalModuleDependencyTypes(
-      pModule,
+      pDependency,
       pModuleName,
       pManifest,
       pFileDirectory,
       pResolveOptions,
       pBaseDirectory
     );
-  } else if (isAliassy(pModuleName, pModule.resolved, pResolveOptions)) {
+  } else if (isAliassy(pModuleName, pDependency.resolved, pResolveOptions)) {
     lReturnValue = ["aliased"];
   }
 
+  if (pDependency.typeOnly) {
+    lReturnValue.push("type-only");
+  }
+
   return lReturnValue;
 };
 

package/src/meta.js

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

package/src/schema/configuration.schema.js

@@ -234,6 +234,7 @@ module.exports = {
         "npm-unknown",
         "undetermined",
         "unknown",
+        "type-only",
       ],
     },
     REAsStringsType: {

package/src/schema/cruise-result.schema.js

@@ -116,6 +116,7 @@ module.exports = {
         matchesDoNotFollow: { type: "boolean" },
         couldNotResolve: { type: "boolean" },
         preCompilationOnly: { type: "boolean" },
+        typeOnly: { type: "boolean" },
         circular: { type: "boolean" },
         cycle: { type: "array", items: { type: "string" } },
         moduleSystem: { $ref: "#/definitions/ModuleSystemType" },
@@ -143,6 +144,7 @@ module.exports = {
         "npm-unknown",
         "undetermined",
         "unknown",
+        "type-only",
       ],
     },
     ModuleSystemType: { type: "string", enum: ["cjs", "es6", "amd", "tsd"] },

package/src/validate/match-dependency-rule.js

@@ -41,7 +41,7 @@ function match(pFrom, pTo) {
       // is in the rule but not in the dependency there won't be a match
       // anyway, so we can use the default propertyEquals method regardless
       propertyEquals(pTo, pRule, "preCompilationOnly") &&
-      // couldNotResolve, circular, dynamic and exoticallyRequired are
+      // couldNotResolve, circular, dynamic and exoticallyRequired _are_ mandatory
       propertyEquals(pTo, pRule, "couldNotResolve") &&
       propertyEquals(pTo, pRule, "circular") &&
       propertyEquals(pTo, pRule, "dynamic") &&

package/types/cruise-result.d.ts

@@ -122,6 +122,13 @@ export interface IDependency {
    * then only when the option 'tsPreCompilationDeps' has the value 'specify'.
    */
   preCompilationOnly?: boolean;
+  /**
+   * 'true' when the module included the module explicitly as type only with the '
+   * type' keyword e.g. import type { IThingus } from 'thing' Dependency-cruiser
+   * will only specify this attribute for TypeScript and when the 'tsPreCompilationDeps'
+   * option has either the value true or 'specify'.
+   */
+  typeOnly?: boolean;
   /**
    * If following this dependency will ultimately return to the source (circular === true),
    * this attribute will contain an (ordered) array of module names that shows (one of) the

package/types/shared-types.d.ts

@@ -37,6 +37,7 @@ export type DependencyType =
   | "npm-peer"
   | "npm-unknown"
   | "undetermined"
-  | "unknown";
+  | "unknown"
+  | "type-only";
 
-export type ProtocolType = "data:" | "file:" | "node";
+export type ProtocolType = "data:" | "file:" | "node:";