dependency-cruiser 18.0.0 → 18.1.0

package/src/utl/regex-util.mjs

@@ -29,7 +29,7 @@ export function clearRegExpCache() {
  * This fills our current need. Later we can expand it to return all group
  * matches.
  *
- * @param {import("../../types/restrictions").IFromRestriction} pFromRestriction
+ * @param {import("../../types/restrictions.mjs").IFromRestriction} pFromRestriction
  * @param {string} pActualPath
  * @returns {string[]|null}
  */

package/types/cruise-result.d.mts

@@ -6,10 +6,15 @@ import type {
 	ModuleSystemType,
 	ProtocolType,
 	ExperimentalStatsType,
+	SeverityType,
 } from "./shared-types.mjs";
 import type { IViolation } from "./violations.mjs";
 import type { IRuleSummary } from "./rule-summary.mjs";
 import type { IChange } from "watskeburt";
+import type {
+	IAvailableExtension,
+	IAvailableTranspiler,
+} from "./environment.mjs";
 
 export interface IRevisionChange extends IChange {
 	// optional because
@@ -359,6 +364,28 @@ export interface ISummary {
 	 * the number of warnings in the dependencies
 	 */
 	warn: number;
+	/**
+	 * information on the environment the cruise ran on
+	 */
+	environment: {
+		version: string;
+		nodeVersionSupported: string;
+		nodeVersionFound: string;
+		osVersionFound: string;
+		transpilersFound: IAvailableTranspiler[];
+		extensionsFound: IAvailableExtension[];
+		/**
+		 * Issues detected in the environment that might have influenced the cruise
+		 * e.g. a missing (supported) typescript transpiler, while there's a tsconfig
+		 */
+		issues?: IEnvironmentIssue[];
+	};
+}
+
+export interface IEnvironmentIssue {
+	severity: SeverityType;
+	name: string;
+	description: string;
 }
 
 /**

package/types/dependency-cruiser.d.mts

@@ -1,6 +1,10 @@
 import type { ICruiseResult } from "./cruise-result.mjs";
 import type { ICruiseOptions, IFormatOptions } from "./options.mjs";
 import type { IResolveOptions } from "./resolve-options.mjs";
+import type {
+	IAvailableExtension,
+	IAvailableTranspiler,
+} from "./environment.mjs";
 
 export type * from "./rule-set.mjs";
 export type * from "./options.mjs";
@@ -8,6 +12,7 @@ export type * from "./configuration.mjs";
 export type * from "./shared-types.mjs";
 export type * from "./cruise-result.mjs";
 export type * from "./resolve-options.mjs";
+export type * from "./environment.mjs";
 
 /**
  * all supported extensions; for each extension whether or not
@@ -15,32 +20,6 @@ export type * from "./resolve-options.mjs";
  */
 export const allExtensions: IAvailableExtension[];
 
-export interface IAvailableExtension {
-	/**
-	 * File extension (e.g. ".js", ".ts", ".jsx")
-	 */
-	extension: string;
-	/**
-	 * Whether or not the extension is available as supported in the current environment
-	 */
-	available: boolean;
-}
-
-export interface IAvailableTranspiler {
-	/**
-	 * The name of the transpiler (e.g. "typescript", "coffeescript")
-	 */
-	name: string;
-	/**
-	 * A semver version range (e.g. ">=2.0.0 <3.0.0")
-	 */
-	version: string;
-	/**
-	 * Whether or not the transpiler is available in the current environment
-	 */
-	available: boolean;
-}
-
 export interface IReporterOutput {
 	/**
 	 * The output proper of the reporter. For most reporters this will be

package/types/environment.d.mts

@@ -0,0 +1,29 @@
+export interface IAvailableExtension {
+	/**
+	 * File extension (e.g. ".js", ".ts", ".jsx")
+	 */
+	extension: string;
+	/**
+	 * Whether or not the extension is available as supported in the current environment
+	 */
+	available: boolean;
+}
+
+export interface IAvailableTranspiler {
+	/**
+	 * The name of the transpiler (e.g. "typescript", "coffeescript")
+	 */
+	name: string;
+	/**
+	 * A semver version range (e.g. ">=2.0.0 <3.0.0")
+	 */
+	version: string;
+	/**
+	 * The currently installed version (e.g. 2.3.4). '-' if not installed
+	 */
+	currentVersion: string;
+	/**
+	 * Whether or not the transpiler is available in the current environment
+	 */
+	available: boolean;
+}

package/types/options.d.mts

@@ -14,10 +14,7 @@ import type { ModuleSystemType, OutputType } from "./shared-types.mjs";
 
 export type ExternalModuleResolutionStrategyType = "node_modules" | "yarn-pnp";
 export type ProgressType =
-	| "cli-feedback"
-	| "performance-log"
-	| "ndjson"
-	| "none";
+	"cli-feedback" | "performance-log" | "ndjson" | "none";
 export type ParserType = "acorn" | "tsc" | "swc";
 
 export interface ITsConfig {

package/types/rule-set.d.mts

@@ -128,13 +128,10 @@ export interface IRegularAllowedRuleType {
 }
 
 export type IAllowedRuleType =
-	| IRegularAllowedRuleType
-	| IReachabilityAllowedRuleType;
+	IRegularAllowedRuleType | IReachabilityAllowedRuleType;
 
 export type IAnyRuleType =
-	| IForbiddenRuleType
-	| IAllowedRuleType
-	| IRequiredRuleType;
+	IForbiddenRuleType | IAllowedRuleType | IRequiredRuleType;
 
 export interface IFlattenedRuleSet {
 	/**

package/types/shared-types.d.mts

@@ -75,11 +75,7 @@ export type DependencyType =
 export type ProtocolType = "data:" | "file:" | "node:";
 
 export type ViolationType =
-	| "dependency"
-	| "module"
-	| "cycle"
-	| "reachability"
-	| "instability";
+	"dependency" | "module" | "cycle" | "reachability" | "instability";
 
 export type RuleScopeType = "module" | "folder";
 

package/types/strict-rule-set.d.mts

@@ -54,13 +54,10 @@ export interface IStrictRegularAllowedRuleType extends IRegularAllowedRuleType {
 	to: IStrictToRestriction;
 }
 export type IStrictAllowedRuleType =
-	| IStrictRegularAllowedRuleType
-	| IStrictReachabilityAllowedRuleType;
+	IStrictRegularAllowedRuleType | IStrictReachabilityAllowedRuleType;
 
 export type IStrictAnyRuleType =
-	| IStrictForbiddenRuleType
-	| IStrictAllowedRuleType
-	| IStrictRequiredRuleType;
+	IStrictForbiddenRuleType | IStrictAllowedRuleType | IStrictRequiredRuleType;
 
 export interface IStrictRuleSet extends IFlattenedRuleSet {
 	forbidden?: IStrictForbiddenRuleType[];