dependency-cruiser 18.2.0 → 18.3.0

package/src/utl/try-import.mjs

@@ -14,7 +14,7 @@ function getVersion(pModuleName) {
 	// The 'proper' way to do this would be with a dynamic import with an
 	// import assertion. Because it's 'experimental' since node 16 and prints
 	// an ugly warning on stderr since node 19 we'll be using the require
-	// hack below in stead. Code would otherwise have been:
+	// hack below instead. Code would otherwise have been:
 	//
 	// const lManifest = await import(
 	//   // @ts-expect-error TS2345 extractRootModuleName can return either a string or

package/types/dependency-cruiser.d.mts

@@ -26,6 +26,12 @@ export interface IReporterOutput {
 	 * a string.
 	 */
 	output: ICruiseResult | string;
+	/**
+	 * Textual meta information to show in a side-channel (like stderr). E.g.
+	 * the baseline reporter returns the numerical diffs between the current
+	 * and the new baseline.
+	 */
+	meta?: string;
 	/**
 	 * The exit code - reporters can return a non-zero value when they find
 	 * errors here. api consumers (like a cli) can use this to return a

package/types/options.d.mts

@@ -16,6 +16,7 @@ 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 interface ITsConfig {
 	fileName?: string;
@@ -109,6 +110,11 @@ export interface ICruiseOptions {
 	 * as 'highlighted' in its output
 	 */
 	highlight?: string | string[] | IHighlightType;
+	/*
+	 * whether or not to ignore known violations (whether passed in a separate
+	 * file or directly in knownViolations)
+	 */
+	ignoreKnown?: boolean;
 	/*
 	 * baseline of known validations. Typically you'd specify these in a file called
 	 * .dependency-cruiser-known-violations.json (which you'd generate with the --outputType
@@ -234,7 +240,7 @@ export interface ICruiseOptions {
 	 *
 	 * Hasn't had any effect on dependency-cruiser's behaviour since a few major
 	 * versions ago. If there's a need to manipulate this use the `skipAnalysisNotInRules`
-	 * option in stead.
+	 * option instead.
 	 *
 	 * Previously documented behavior:
 	 * > When true includes denormalized dependents in the cruise-result, even
@@ -424,6 +430,16 @@ export interface ICruiseOptions {
 	 * When caching is switched on the default cache folder is 'node_modules/.cache/dependency-cruiser/'
 	 */
 	cache?: boolean | string | Partial<ICacheOptions>;
+
+	baseline?: {
+		/**
+		 * How to update the baseline;
+		 * '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.
+		 */
+		mode?: BaselineModeType;
+	};
 }
 
 export interface IFormatOptions {

package/types/restrictions.d.mts

@@ -84,13 +84,13 @@ export interface IToRestriction extends IBaseRestrictionType {
 	 * _only_ modules that don't satisfy this regular expression. E.g. to disallow all cycles,
 	 * except when they go through one specific module. Typically to temporarily
 	 * allow some cycles until they're removed.
-	 * @deprecated use viaOnly.pathNot in stead
+	 * @deprecated use viaOnly.pathNot instead
 	 */
 	viaNot?: string | string[];
 	/**
 	 * "For circular dependencies - whether or not to match cycles that include
 	 * _some_ modules that don't satisfy this regular expression.
-	 * @deprecated use via.pathNot in stead
+	 * @deprecated use via.pathNot instead
 	 */
 	viaSomeNot?: string | string[];
 	/**

package/types/shared-types.d.mts

@@ -3,26 +3,29 @@ export type ModuleSystemType = "cjs" | "amd" | "es6" | "tsd";
 
 // cruise options, dependency-cruiser
 export type OutputType =
-	| "json"
-	| "html"
-	| "dot"
-	| "cdot"
+	| "anon"
 	| "archi"
+	| "azure-devops"
+	| "baseline"
+	| "cdot"
+	| "csv"
+	| "d2"
 	| "ddot"
+	| "dot-webpage"
+	| "dot"
+	| "err-html"
+	| "err-long"
+	| "err"
 	| "fdot"
 	| "flat"
-	| "csv"
-	| "err"
-	| "err-long"
-	| "err-html"
-	| "teamcity"
-	| "anon"
-	| "text"
-	| "metrics"
+	| "html"
+	| "json"
 	| "markdown"
 	| "mermaid"
-	| "d2"
+	| "metrics"
 	| "null"
+	| "teamcity"
+	| "text"
 	// for plugins: string. TODO: research whether it's possible to
 	// tie this down to the `^plugin:[^:]+-reporter-plugin.[cm]?js$` regex
 	| (string & {}); // autocompletion hack