dependency-cruiser 17.3.10 → 17.4.0

package/src/utl/try-import.mjs

@@ -45,7 +45,6 @@ function getVersion(pModuleName) {
  * @param {string} [pSemanticVersion] - An semantic version to check against.
  * @returns {Promise<NodeModule | false>} - The imported module or false if the import fails or the version does not satisfy the provided semantic version.
  */
-
 export default async function tryImport(pModuleName, pSemanticVersion) {
 	try {
 		if (pSemanticVersion) {

package/types/reporter-options.d.mts

@@ -22,6 +22,18 @@ export interface IReporterOptions {
 	 * Options to tweak the output of the ddot reporter
 	 */
 	ddot?: IDotReporterOptions;
+	/**
+	 * Options to tweak the output of the err reporter
+	 */
+	err?: IErrorReporterOptions;
+	/**
+	 * Options to tweak the output of the err-html reporter
+	 */
+	"err-html"?: IErrorReporterOptions;
+	/**
+	 * Options to tweak the output of the err-long reporter
+	 */
+	"err-long"?: IErrorReporterOptions;
 	/**
 	 * Options to tweak the output of the flat /fdot reporter
 	 */
@@ -57,7 +69,7 @@ export interface IAnonReporterOptions {
 	 * List of words to use to replace path elements of file names in the output
 	 * with so the output isn't directly traceable to its intended purpose.
 	 * When the list is exhausted, the anon reporter will use random strings
-	 * patterned after the original file name in stead. The list is empty
+	 * patterned after the original file name instead. The list is empty
 	 * by default.
 	 *
 	 * Read more in https://github.com/sverweij/dependency-cruiser/blob/main/doc/cli.md#anon---obfuscated-json",
@@ -126,6 +138,24 @@ export interface IDotThemeEntry {
 	attributes: any;
 }
 
+export interface IErrorReporterOptions {
+	/**
+	 * For external modules (typically those in node_modules), show the
+	 * unresolved module name instead of the resolved one in the error
+	 * overview.
+	 * E.g. 'snodash' instead of 'node_modules/snodash/dist/esm/bundle.mjs'.
+	 * Defaults to false.
+	 */
+	showExternalModulesUnresolved?: boolean;
+	/**
+	 * For aliased modules (either subpath imports in package.json or via legacy
+	 * tsconfig/ jsconfig/ webpack/ babel constructs) show the unresolved module name instead of the
+	 * resolved one in the error overview.
+	 * E.g. '#utils' instead of 'libs/shared/utils/lib/src/main.cjs'
+	 * Defaults to false.
+	 */
+	showAliasedModulesUnresolved?: boolean;
+}
 export interface IMetricsReporterOptions {
 	hideModules?: boolean;
 	hideFolders?: boolean;
@@ -185,11 +215,26 @@ export interface IMarkdownReporterOptions {
 	 * The text to show as a header on top of the detailed list of violations. E.g. '### All violations'
 	 * When left out shows a default value.
 	 */
-	detailsHeader?: boolean;
+	detailsHeader?: string;
 	/**
 	 * Whether or not to collapse the list of violations in a <details> block. Defaults to true.
 	 */
 	collapseDetails?: boolean;
+	/**
+	 * For external modules (typically those in node_modules) show the unresolved module name instead
+	 * of the resolved one in the error overview.
+	 * E.g 'snodash' instead of 'node_modules/snodash/dist/esm/bundle.mjs'.
+	 * Defaults to false.
+	 */
+	showExternalModulesUnresolved?: boolean;
+	/**
+	 * For aliased modules (either subpath imports in package.json or via legacy
+	 * tsconfig/ jsconfig/ webpack/ babel constructs) show the unresolved module name instead of the
+	 * resolved one in the error overview.
+	 * 'E.g. '#utils' instead of 'libs/shared/utils/lib/src/main.cjs'
+	 * Defaults to false.
+	 */
+	showAliasedModulesUnresolved?: boolean;
 	/**
 	 * The text to in the <summary> section of the <details> block. E.g. 'click to see all violations'
 	 * When left out shows a default value.

package/types/violations.d.mts

@@ -1,5 +1,9 @@
 import type { IRuleSummary } from "./rule-summary.mjs";
-import type { IMiniDependency, ViolationType } from "./shared-types.mjs";
+import type {
+	DependencyType,
+	IMiniDependency,
+	ViolationType,
+} from "./shared-types.mjs";
 
 export interface IMetricsSummary {
 	from: {
@@ -24,9 +28,17 @@ export interface IViolation {
 	 */
 	from: string;
 	/**
-	 * The to part of the dependency this violation is about
+	 * The (resolved) to part of the dependency this violation is about
 	 */
 	to: string;
+	/**
+	 * The (unresolved) to part of the dependency this violation is about
+	 */
+	unresolvedTo?: string;
+	/**
+	 * The dependencyTypes that define the relation between the to and the from
+	 */
+	dependencyTypes?: DependencyType[];
 	/**
 	 * The circular path if the violation is about circularity
 	 */