dependency-cruiser 17.3.2 → 17.3.3-beta-2

package/types/rule-set.d.mts

@@ -1,165 +1,165 @@
 import type { SeverityType, RuleScopeType } from "./shared-types.mjs";
 import type {
-  IBaseRestrictionType,
-  IFromRestriction,
-  IToRestriction,
-  IReachabilityToRestrictionType,
-  IRequiredToRestrictionType,
-  IDependentsModuleRestrictionType,
+	IBaseRestrictionType,
+	IFromRestriction,
+	IToRestriction,
+	IReachabilityToRestrictionType,
+	IRequiredToRestrictionType,
+	IDependentsModuleRestrictionType,
 } from "./restrictions.mjs";
 
 interface IBaseRuleType {
-  /**
-   * A short name for the rule - will appear in reporters to enable customers to
-   * quickly identify a violated rule. Try to keep them short, eslint style.
-   * E.g. 'not-to-core' for a rule forbidding dependencies on core modules, or
-   * 'not-to-unresolvable' for one that prevents dependencies on modules that
-   * probably don't exist.
-   */
-  name?: string;
-  /**
-   * How severe a violation of the rule is. The 'error' severity will make some
-   * reporters return a non-zero exit code, so if you want e.g. a build to stop
-   * when there's a rule violated: use that.
-   */
-  severity?: SeverityType;
-  /**
-   * You can use this field to document why the rule is there.
-   */
-  comment?: string;
+	/**
+	 * A short name for the rule - will appear in reporters to enable customers to
+	 * quickly identify a violated rule. Try to keep them short, eslint style.
+	 * E.g. 'not-to-core' for a rule forbidding dependencies on core modules, or
+	 * 'not-to-unresolvable' for one that prevents dependencies on modules that
+	 * probably don't exist.
+	 */
+	name?: string;
+	/**
+	 * How severe a violation of the rule is. The 'error' severity will make some
+	 * reporters return a non-zero exit code, so if you want e.g. a build to stop
+	 * when there's a rule violated: use that.
+	 */
+	severity?: SeverityType;
+	/**
+	 * You can use this field to document why the rule is there.
+	 */
+	comment?: string;
 }
 
 export interface IRegularForbiddenRuleType extends IBaseRuleType {
-  /**
-   * Criteria the 'from' end of a dependency should match to be caught by this
-   * rule. Leave it empty if you want any module to be matched.
-   */
-  from: IFromRestriction;
-  /**
-   * Criteria the 'to' end of a dependency should match to be caught by this
-   * rule. Leave it empty if you want any module to be matched.
-   */
-  to: IToRestriction;
-  /**
-   * What to apply the rule to - modules (the default) or folders. Switching
-   * the scope to 'folder' can be useful in rules where this makes a difference
-   * like those regarding circular dependencies or instability.
-   * Only the to.moreUnstable, to.circular, and path (both from and to)
-   * attributes work at the moment. Other attributes will follow suit in later
-   * releases (depending on demand).
-   */
-  scope?: RuleScopeType;
+	/**
+	 * Criteria the 'from' end of a dependency should match to be caught by this
+	 * rule. Leave it empty if you want any module to be matched.
+	 */
+	from: IFromRestriction;
+	/**
+	 * Criteria the 'to' end of a dependency should match to be caught by this
+	 * rule. Leave it empty if you want any module to be matched.
+	 */
+	to: IToRestriction;
+	/**
+	 * What to apply the rule to - modules (the default) or folders. Switching
+	 * the scope to 'folder' can be useful in rules where this makes a difference
+	 * like those regarding circular dependencies or instability.
+	 * Only the to.moreUnstable, to.circular, and path (both from and to)
+	 * attributes work at the moment. Other attributes will follow suit in later
+	 * releases (depending on demand).
+	 */
+	scope?: RuleScopeType;
 }
 
 export interface IReachabilityForbiddenRuleType extends IBaseRuleType {
-  /**
-   * Criteria the 'from' end of a dependency should match to be caught by this
-   * rule. Leave it empty if you want any module to be matched.
-   */
-  from: IBaseRestrictionType;
-  /**
-   * Criteria the 'to' end of a dependency should match to be caught by this
-   * rule. Leave it empty if you want any module to be matched.
-   */
-  to: IReachabilityToRestrictionType;
+	/**
+	 * Criteria the 'from' end of a dependency should match to be caught by this
+	 * rule. Leave it empty if you want any module to be matched.
+	 */
+	from: IBaseRestrictionType;
+	/**
+	 * Criteria the 'to' end of a dependency should match to be caught by this
+	 * rule. Leave it empty if you want any module to be matched.
+	 */
+	to: IReachabilityToRestrictionType;
 }
 
 export interface IDependentsForbiddenRuleType extends IBaseRuleType {
-  /**
-   * Criteria to select the module(s) this restriction should apply to
-   */
-  module: IDependentsModuleRestrictionType;
-  /**
-   * Criteria at least one dependency of each matching module must
-   * adhere to.
-   */
-  from: IBaseRestrictionType;
+	/**
+	 * Criteria to select the module(s) this restriction should apply to
+	 */
+	module: IDependentsModuleRestrictionType;
+	/**
+	 * Criteria at least one dependency of each matching module must
+	 * adhere to.
+	 */
+	from: IBaseRestrictionType;
 }
 
 export interface IReachabilityAllowedRuleType {
-  /**
-   * You can use this field to document why the rule is there.
-   */
-  comment?: string;
-  /**
-   * Criteria the 'from' end of a dependency should match to be caught by this rule.
-   * Leave it empty if you want any module to be matched.
-   */
-  from: IBaseRestrictionType;
-  /**
-   * Criteria the 'to' end of a dependency should match to be caught by this rule.
-   * Leave it empty if you want any module to be matched.
-   */
-  to: IReachabilityToRestrictionType;
+	/**
+	 * You can use this field to document why the rule is there.
+	 */
+	comment?: string;
+	/**
+	 * Criteria the 'from' end of a dependency should match to be caught by this rule.
+	 * Leave it empty if you want any module to be matched.
+	 */
+	from: IBaseRestrictionType;
+	/**
+	 * Criteria the 'to' end of a dependency should match to be caught by this rule.
+	 * Leave it empty if you want any module to be matched.
+	 */
+	to: IReachabilityToRestrictionType;
 }
 
 export type IForbiddenRuleType =
-  | IRegularForbiddenRuleType
-  | IReachabilityForbiddenRuleType
-  | IDependentsForbiddenRuleType;
+	| IRegularForbiddenRuleType
+	| IReachabilityForbiddenRuleType
+	| IDependentsForbiddenRuleType;
 
 export interface IRequiredRuleType extends IBaseRuleType {
-  /**
-   * Criteria to select the module(s) this restriction should apply to
-   */
-  module: IBaseRestrictionType;
-  /**
-   * Criteria at least one dependency of each matching module must
-   * adhere to.
-   */
-  to: IRequiredToRestrictionType;
+	/**
+	 * Criteria to select the module(s) this restriction should apply to
+	 */
+	module: IBaseRestrictionType;
+	/**
+	 * Criteria at least one dependency of each matching module must
+	 * adhere to.
+	 */
+	to: IRequiredToRestrictionType;
 }
 
 export interface IRegularAllowedRuleType {
-  /**
-   * You can use this field to document why the rule is there.
-   */
-  comment?: string;
-  /**
-   * Criteria the 'from' end of a dependency should match to be caught by this rule.
-   * Leave it empty if you want any module to be matched.
-   */
-  from: IFromRestriction;
-  /**
-   * Criteria the 'to' end of a dependency should match to be caught by this rule.
-   * Leave it empty if you want any module to be matched.
-   */
-  to: IToRestriction;
+	/**
+	 * You can use this field to document why the rule is there.
+	 */
+	comment?: string;
+	/**
+	 * Criteria the 'from' end of a dependency should match to be caught by this rule.
+	 * Leave it empty if you want any module to be matched.
+	 */
+	from: IFromRestriction;
+	/**
+	 * Criteria the 'to' end of a dependency should match to be caught by this rule.
+	 * Leave it empty if you want any module to be matched.
+	 */
+	to: IToRestriction;
 }
 
 export type IAllowedRuleType =
-  | IRegularAllowedRuleType
-  | IReachabilityAllowedRuleType;
+	| IRegularAllowedRuleType
+	| IReachabilityAllowedRuleType;
 
 export type IAnyRuleType =
-  | IForbiddenRuleType
-  | IAllowedRuleType
-  | IRequiredRuleType;
+	| IForbiddenRuleType
+	| IAllowedRuleType
+	| IRequiredRuleType;
 
 export interface IFlattenedRuleSet {
-  /**
-   * A list of rules that describe dependencies that are not allowed.
-   * dependency-cruiser will emit a separate error (warning/ informational)
-   * messages for each violated rule.
-   */
-  forbidden?: IForbiddenRuleType[];
-  /**
-   * A list of rules that describe dependencies that are allowed.
-   * dependency-cruiser will emit the warning message 'not-in-allowed' for
-   * each dependency that does not at least one of them.
-   */
-  allowed?: IAllowedRuleType[];
-  /**
-   * Severity to use when a dependency is not in the 'allowed' set of rules.
-   * Defaults to 'warn'
-   */
-  allowedSeverity?: SeverityType;
-  /**
-   * A list of rules that describe what dependencies modules _must_ have.
-   * E.g.
-   * - every controller needs to (directly) depend on a base controller.
-   * - each source file should be the dependency of a spec file with the same
-   *   base name
-   */
-  required?: IRequiredRuleType[];
+	/**
+	 * A list of rules that describe dependencies that are not allowed.
+	 * dependency-cruiser will emit a separate error (warning/ informational)
+	 * messages for each violated rule.
+	 */
+	forbidden?: IForbiddenRuleType[];
+	/**
+	 * A list of rules that describe dependencies that are allowed.
+	 * dependency-cruiser will emit the warning message 'not-in-allowed' for
+	 * each dependency that does not at least one of them.
+	 */
+	allowed?: IAllowedRuleType[];
+	/**
+	 * Severity to use when a dependency is not in the 'allowed' set of rules.
+	 * Defaults to 'warn'
+	 */
+	allowedSeverity?: SeverityType;
+	/**
+	 * A list of rules that describe what dependencies modules _must_ have.
+	 * E.g.
+	 * - every controller needs to (directly) depend on a base controller.
+	 * - each source file should be the dependency of a spec file with the same
+	 *   base name
+	 */
+	required?: IRequiredRuleType[];
 }

package/types/rule-summary.d.mts

@@ -6,18 +6,18 @@ import type { SeverityType } from "./shared-types.mjs";
  */
 
 export interface IRuleSummary {
-  /**
-   * The (short, eslint style) name of the violated rule. Typically something like
-   * 'no-core-punycode' or 'no-outside-deps'.
-   */
-  name: string;
-  /**
-   * How severe a violation of a rule is. The 'error' severity will make some reporters return
-   * a non-zero exit code, so if you want e.g. a build to stop when there's a rule violated:
-   * use that. The absence of the 'ignore' severity here is by design; ignored rules don't
-   * show up in the output.
-   *
-   * Severity to use when a dependency is not in the 'allowed' set of rules. Defaults to 'warn'
-   */
-  severity: SeverityType;
+	/**
+	 * The (short, eslint style) name of the violated rule. Typically something like
+	 * 'no-core-punycode' or 'no-outside-deps'.
+	 */
+	name: string;
+	/**
+	 * How severe a violation of a rule is. The 'error' severity will make some reporters return
+	 * a non-zero exit code, so if you want e.g. a build to stop when there's a rule violated:
+	 * use that. The absence of the 'ignore' severity here is by design; ignored rules don't
+	 * show up in the output.
+	 *
+	 * Severity to use when a dependency is not in the 'allowed' set of rules. Defaults to 'warn'
+	 */
+	severity: SeverityType;
 }

package/types/shared-types.d.mts

@@ -3,109 +3,109 @@ export type ModuleSystemType = "cjs" | "amd" | "es6" | "tsd";
 
 // cruise options, dependency-cruiser
 export type OutputType =
-  | "json"
-  | "html"
-  | "dot"
-  | "cdot"
-  | "archi"
-  | "ddot"
-  | "fdot"
-  | "flat"
-  | "csv"
-  | "err"
-  | "err-long"
-  | "err-html"
-  | "teamcity"
-  | "anon"
-  | "text"
-  | "metrics"
-  | "markdown"
-  | "mermaid"
-  | "d2"
-  | "null"
-  // for plugins: string. TODO: research whether it's possible to
-  // tie this down to the `^plugin:[^:]+-reporter-plugin.[cm]?js$` regex
-  | (string & {}); // autocompletion hack
+	| "json"
+	| "html"
+	| "dot"
+	| "cdot"
+	| "archi"
+	| "ddot"
+	| "fdot"
+	| "flat"
+	| "csv"
+	| "err"
+	| "err-long"
+	| "err-html"
+	| "teamcity"
+	| "anon"
+	| "text"
+	| "metrics"
+	| "markdown"
+	| "mermaid"
+	| "d2"
+	| "null"
+	// for plugins: string. TODO: research whether it's possible to
+	// tie this down to the `^plugin:[^:]+-reporter-plugin.[cm]?js$` regex
+	| (string & {}); // autocompletion hack
 
 export type SeverityType = "error" | "warn" | "info" | "ignore";
 
 // cruise options, cruise result, rule set
 export type DependencyType =
-  | "aliased-subpath-import"
-  | "aliased-tsconfig-base-url"
-  | "aliased-tsconfig-paths"
-  | "aliased-tsconfig"
-  | "aliased-webpack"
-  | "aliased-workspace"
-  | "aliased"
-  | "amd-define"
-  | "amd-require"
-  | "amd-exotic-require"
-  | "core"
-  | "deprecated"
-  | "dynamic-import"
-  | "exotic-require"
-  | "export"
-  | "import-equals"
-  | "import"
-  | "jsdoc"
-  | "jsdoc-bracket-import"
-  | "jsdoc-import-tag"
-  | "local"
-  | "localmodule"
-  | "npm-bundled"
-  | "npm-dev"
-  | "npm-no-pkg"
-  | "npm-optional"
-  | "npm-peer"
-  | "npm-unknown"
-  | "npm"
-  | "pre-compilation-only"
-  | "process-get-builtin-module"
-  | "require"
-  | "triple-slash-amd-dependency"
-  | "triple-slash-directive"
-  | "triple-slash-file-reference"
-  | "triple-slash-type-reference"
-  | "type-import"
-  | "type-only"
-  | "undetermined"
-  | "unknown";
+	| "aliased-subpath-import"
+	| "aliased-tsconfig-base-url"
+	| "aliased-tsconfig-paths"
+	| "aliased-tsconfig"
+	| "aliased-webpack"
+	| "aliased-workspace"
+	| "aliased"
+	| "amd-define"
+	| "amd-require"
+	| "amd-exotic-require"
+	| "core"
+	| "deprecated"
+	| "dynamic-import"
+	| "exotic-require"
+	| "export"
+	| "import-equals"
+	| "import"
+	| "jsdoc"
+	| "jsdoc-bracket-import"
+	| "jsdoc-import-tag"
+	| "local"
+	| "localmodule"
+	| "npm-bundled"
+	| "npm-dev"
+	| "npm-no-pkg"
+	| "npm-optional"
+	| "npm-peer"
+	| "npm-unknown"
+	| "npm"
+	| "pre-compilation-only"
+	| "process-get-builtin-module"
+	| "require"
+	| "triple-slash-amd-dependency"
+	| "triple-slash-directive"
+	| "triple-slash-file-reference"
+	| "triple-slash-type-reference"
+	| "type-import"
+	| "type-only"
+	| "undetermined"
+	| "unknown";
 
 export type ProtocolType = "data:" | "file:" | "node:";
 
 export type ViolationType =
-  | "dependency"
-  | "module"
-  | "cycle"
-  | "reachability"
-  | "instability";
+	| "dependency"
+	| "module"
+	| "cycle"
+	| "reachability"
+	| "instability";
 
 export type RuleScopeType = "module" | "folder";
 
 export interface IMiniDependency {
-  /**
-   * The name of the module
-   */
-  name: string;
-  /**
-   * The dependency types of the module relative to the previous module " +
-   * in the chain it is a part of (e.g. a cycle)
-   */
-  dependencyTypes: DependencyType[];
+	/**
+	 * The name of the module
+	 */
+	name: string;
+	/**
+	 * The dependency types of the module relative to the previous module " +
+	 * in the chain it is a part of (e.g. a cycle)
+	 */
+	dependencyTypes: DependencyType[];
 }
 
 export type ExperimentalStatsType = {
-  /**
-   * the number of top level statements in the module. Attribute only
-   * available when the cruise was executed with the 'experimentalStats
-   * option set to 'true'.
-   */
-  topLevelStatementCount: number;
-  /**
-   * the size of the module in bytes. Attribute only available when
-   * the cruise was executed with the 'experimentalStats' option set to
-   * 'true'.
-   */
-  size: number;
+	/**
+	 * the number of top level statements in the module. Attribute only
+	 * available when the cruise was executed with the 'experimentalStats
+	 * option set to 'true'.
+	 */
+	topLevelStatementCount: number;
+	/**
+	 * the size of the module in bytes. Attribute only available when
+	 * the cruise was executed with the 'experimentalStats' option set to
+	 * 'true'.
+	 */
+	size: number;
 };

package/types/strict-filter-types.d.mts

@@ -1,73 +1,73 @@
 import type {
-  IDoNotFollowType,
-  IExcludeType,
-  IFocusType,
-  IIncludeOnlyType,
-  IReachesType,
-  IHighlightType,
+	IDoNotFollowType,
+	IExcludeType,
+	IFocusType,
+	IIncludeOnlyType,
+	IReachesType,
+	IHighlightType,
 } from "./filter-types.mjs";
 import type { DependencyType } from "./shared-types.mjs";
 
 export interface IStrictDoNotFollowType extends IDoNotFollowType {
-  /**
-   * a regular expression for modules to include, but not follow further
-   */
-  path?: string;
-  /**
-   * an array of dependency types to include, but not follow further
-   */
-  dependencyTypes?: DependencyType[];
+	/**
+	 * a regular expression for modules to include, but not follow further
+	 */
+	path?: string;
+	/**
+	 * an array of dependency types to include, but not follow further
+	 */
+	dependencyTypes?: DependencyType[];
 }
 
 export interface IStrictExcludeType extends IExcludeType {
-  /**
-   * a regular expression for modules to exclude
-   */
-  path?: string;
-  /**
-   * a boolean indicating whether or not to exclude dynamic dependencies
-   * leave out to match both
-   */
-  dynamic?: boolean;
+	/**
+	 * a regular expression for modules to exclude
+	 */
+	path?: string;
+	/**
+	 * a boolean indicating whether or not to exclude dynamic dependencies
+	 * leave out to match both
+	 */
+	dynamic?: boolean;
 }
 
 export interface IStrictIncludeOnlyType extends IIncludeOnlyType {
-  /**
-   * regular expression describing which dependencies the function
-   * should cruise - anything not matching this will be skipped
-   */
-  path: string;
+	/**
+	 * regular expression describing which dependencies the function
+	 * should cruise - anything not matching this will be skipped
+	 */
+	path: string;
 }
 
 export interface IStrictFocusType extends IFocusType {
-  /**
-   * dependency-cruiser will include modules matching this regular expression
-   * in its output, as well as their neighbours (direct dependencies and
-   * dependents)
-   */
-  path: string;
-  /**
-   * by default 'focus' only includes the direct neighbours of the focus'ed module(s).
-   * This property makes dependency-cruiser will also include neighbors of neighbors,
-   * up to the specified depth.
-   */
-  depth?: number;
+	/**
+	 * dependency-cruiser will include modules matching this regular expression
+	 * in its output, as well as their neighbours (direct dependencies and
+	 * dependents)
+	 */
+	path: string;
+	/**
+	 * by default 'focus' only includes the direct neighbours of the focus'ed module(s).
+	 * This property makes dependency-cruiser will also include neighbors of neighbors,
+	 * up to the specified depth.
+	 */
+	depth?: number;
 }
 
 export interface IStrictReachesType extends IReachesType {
-  /**
-   * dependency-cruiser will include modules matching this regular expression
-   * in its output, as well as _any_ module that reaches them - either directly
-   * or via via.
-   */
-  path: string;
+	/**
+	 * dependency-cruiser will include modules matching this regular expression
+	 * in its output, as well as _any_ module that reaches them - either directly
+	 * or via via.
+	 */
+	path: string;
 }
 
 export interface IStrictHighlightType extends IHighlightType {
-  /**
-   * dependency-cruiser will include modules matching this regular expression
-   * in its output, as well as _any_ module that reaches them - either directly
-   * or via via.
-   */
-  path: string;
+	/**
+	 * dependency-cruiser will include modules matching this regular expression
+	 * in its output, as well as _any_ module that reaches them - either directly
+	 * or via via.
+	 */
+	path: string;
 }