tslint-folders-diagrams
Options
All
  • Public
  • Public/Protected
  • All
Menu

Generate a graph that represents the structure described in the tslint config.

The graph can then be optimized before rendering (mainly to reduce the number of edges).

note: the graph could contain circular references!

Hierarchy

  • GraphGenerator

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private config

config: DocConfig

Private containerId

containerId: number = 0

Private filter

filter: PackageFilter

Private mapIdToNode

mapIdToNode: MapIdToGraphNode = new MapIdToGraphNode()

Private mapNameToId

mapNameToId: MapNameToId = new MapNameToId()

Private root

root: GraphCluster

Methods

Private checkIfNeedsAnyPackage

  • checkIfNeedsAnyPackage(packageFolders: PackageFolder[]): void

Private createAnyPackage

  • createAnyPackage(): PackageFolder

Private createAnySubPackage

  • createAnySubPackage(): PackageSubFolder

generateGraph

  • generateGraph(packageConfig: ImportsBetweenPackagesRuleConfig): GraphCluster

Private generateNode

Private generateNodeFromPackage

Private generateNodesFromPackages

Private generateSubFolders

  • generateSubFolders(cluster: GraphCluster, packageName: string, subFolders: PackageSubFolder[]): GraphNode[]

Private getAnyPackageId

  • getAnyPackageId(): string

Private getNodeType

  • getNodeType(pkg: PackageFolder): NodeType

Private getNodeTypeForSubFolder

  • getNodeTypeForSubFolder(pkg: PackageSubFolder): NodeType

Private getPackageIdKey

  • getPackageIdKey(packageName: string, prefix?: undefined | string): string

Private processEdges

  • processEdges(packageFolders: PackageFolder[]): void

Private processEdgesForPackageNames

  • processEdgesForPackageNames(thisPkgId: string, allowedPackages: string[], packageIdPrefix?: undefined | string): void

Private processPackageSubFolders

  • processPackageSubFolders(parent: GraphCluster, pkg: PackageFolder): void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc