dependency-cruiser/types/strict-rule-set.d.ts

Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.

import { SeverityType, RuleScopeType } from "./shared-types";
import {
  IBaseRuleType,
  IRegularAllowedRuleType,
  IFlattenedRuleSet,
} from "./rule-set";
import {
  IStrictToRestriction,
  IStrictFromRestriction,
  IStrictBaseRestrictionType,
  IStrictReachabilityToRestrictionType,
  IStrictDependentsModuleRestrictionType,
  IStrictRequiredToRestrictionType,
} from "./strict-restrictions";

export interface IStrictBaseRuleType extends IBaseRuleType {
  name: string;
  severity: SeverityType;
}

export interface IStrictRegularForbiddenRuleType extends IStrictBaseRuleType {
  from: IStrictFromRestriction;
  to: IStrictToRestriction;
  scope: RuleScopeType;
}

export interface IStrictReachabilityForbiddenRuleType
  extends IStrictBaseRuleType {
  from: IStrictBaseRestrictionType;
  to: IStrictReachabilityToRestrictionType;
}

export interface IStrictDependentsForbiddenRuleType
  extends IStrictBaseRuleType {
  module: IStrictDependentsModuleRestrictionType;
  from: IStrictBaseRestrictionType;
}

export interface IStrictReachabilityAllowedRuleType {
  from: IStrictBaseRestrictionType;
  to: IStrictReachabilityToRestrictionType;
}

export type IStrictForbiddenRuleType =
  | IStrictRegularForbiddenRuleType
  | IStrictReachabilityForbiddenRuleType
  | IStrictDependentsForbiddenRuleType;

export interface IStrictRequiredRuleType extends IStrictBaseRuleType {
  module: IStrictBaseRestrictionType;
  to: IStrictRequiredToRestrictionType;
}

export interface IStrictRegularAllowedRuleType extends IRegularAllowedRuleType {
  from: IStrictFromRestriction;
  to: IStrictToRestriction;
}
export type IStrictAllowedRuleType =
  | IStrictRegularAllowedRuleType
  | IStrictReachabilityAllowedRuleType;

export type IStrictAnyRuleType =
  | IStrictForbiddenRuleType
  | IStrictAllowedRuleType
  | IStrictRequiredRuleType;

export interface IStrictRuleSet extends IFlattenedRuleSet {
  forbidden?: IStrictForbiddenRuleType[];
  allowed?: IStrictAllowedRuleType[];
  allowedSeverity?: SeverityType;
  required?: IStrictRequiredRuleType[];
}