dependency-cruiser 18.3.1 → 18.5.0

package/types/cruise-result.d.mts

@@ -342,6 +342,20 @@ export interface ISummary {
 	 * the number of informational level notices in the dependencies
 	 */
 	info: number;
+	/**
+	 * the number of violations in the baseline
+	 */
+	baselineSize?: number;
+	/**
+	 * the number of violations in the baseline that matched violations from the current cruise
+	 */
+	baselineStale?: number;
+	/**
+	 * for reporters that emit non-zero exit codes: the number of errors encountered OR, in case
+	 * options.baseline.staleEntriesSeverity equals 'error' - the number of errors encountered +
+	 * the number of stale entries in the baseline.
+	 */
+	advisedExitCode: number;
 	optionsUsed: IOptions;
 	/**
 	 * rules used in the cruise

package/types/options.d.mts

@@ -10,13 +10,17 @@ import type {
 } from "./filter-types.mjs";
 import type { IReporterOptions } from "./reporter-options.mjs";
 import type { IFlattenedRuleSet } from "./rule-set.mjs";
-import type { ModuleSystemType, OutputType } from "./shared-types.mjs";
+import type {
+	ModuleSystemType,
+	OutputType,
+	SeverityType,
+} from "./shared-types.mjs";
 
 export type ExternalModuleResolutionStrategyType = "node_modules" | "yarn-pnp";
 export type ProgressType =
 	"cli-feedback" | "performance-log" | "ndjson" | "none";
 export type ParserType = "acorn" | "tsc" | "swc";
-export type BaselineModeType = "full" | "shrink-only";
+export type BaselineModeType = "full" | "shrink-only" | "format";
 
 export interface ITsConfig {
 	fileName?: string;
@@ -152,6 +156,11 @@ export interface ICruiseOptions {
 	 * import statements. Implies `"parser": "tsc"`. Defaults to false.'
 	 */
 	detectJSDocImports?: boolean;
+	/**
+	 * When true, dependency-cruiser will detect imports in ambient module and
+	 * namespace declarations. Implies `"parser": "tsc"`. Defaults to false.
+	 */
+	detectImportsInAmbientModules?: boolean;
 	/**
 	 * When true, dependency-cruiser will detect calls to `process.getBuiltinModule`/
 	 * `globalThis.process.getBuiltinModule` as imports.
@@ -437,8 +446,18 @@ export interface ICruiseOptions {
 		 * 'full' - replaces all violations with the current set (the default behaviour)
 		 * 'shrink-only' - keeps existing violations, removes fixed violations, but
 		 *  does not add new ones.
+		 * 'format' - rewrites the baseline, but doesn't remove or add anything - only
+		 *  showing the stats.
 		 */
 		mode?: BaselineModeType;
+		/**
+		 * Severity to use when there's stale entries in the baseline. In reporters that can
+		 * emit non-zero exit codes (like err, err-long and null), when the value of this attribute
+		 * equals 'error' and there's stale entries in the baseline, they'll exit with a non-zero
+		 * exit code.
+		 * Defaults to 'warn'
+		 */
+		staleEntriesSeverity?: SeverityType;
 	};
 }
 

package/types/reporter-options.d.mts

@@ -220,6 +220,11 @@ export interface IMarkdownReporterOptions {
 	 * Whether or not to collapse the list of violations in a <details> block. Defaults to true.
 	 */
 	collapseDetails?: boolean;
+	/**
+	 * The text to show in the <summary> section of the <details> block. E.g. 'click to see all violations'
+	 * When left out shows a default value.
+	 */
+	collapsedMessage?: string;
 	/**
 	 * For external modules (typically those in node_modules) show the unresolved module name instead
 	 * of the resolved one in the error overview.
@@ -235,16 +240,36 @@ export interface IMarkdownReporterOptions {
 	 * 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.
-	 */
-	collapsedMessage?: string;
 	/**
 	 * The text to show when no violations were found. E.g. 'No violations found'.
 	 * When left out shows a default value.
 	 */
 	noViolationsMessage?: string;
+	/**
+	 * Whether or not to show a detailed list of stale violations in the baseline (if any).
+	 * Defaults to true
+	 */
+	showStaleBaselineDetails?: boolean;
+	/**
+	 * Text shown as the heading above stale baseline violations. Defaults to the
+	 * standard stale-baseline heading.
+	 */
+	staleBaselineHeader?: string;
+	/**
+	 * Whether or not to wrap stale baseline violations in a collapsible
+	 * <details> block. Defaults to true.
+	 */
+	collapseStaleBaseline?: boolean;
+	/**
+	 * Text shown in the <summary> element when stale baseline details are
+	 * collapsible. Defaults to 'Stale violations in the baseline - click to expand'.
+	 */
+	collapseStaleBaselineMessage?: string;
+	/**
+	 * Introductory text shown before stale baseline violations. Defaults to an
+	 * explanation of why they are stale and how to remove them.
+	 */
+	staleBaselineIntro?: string;
 	/**
 	 * Whether or not to show a footer (with version & run date) at the bottom of the report.
 	 * Defaults to true