boll
Get started
Documentation
GitHub
Get started
Documentation
GitHub
  • Class: Cli
  • Class: ConfigGenerator
  • Class: DefaultFormatter
  • Class: VsoFormatter
  • Enumeration: Status
  • @boll/cli
  • Interface: Formatter
  • Class: BasePackageRule ‹T›
  • Class: Config
  • Class: ConfigRegistry
  • Class: Failure
  • Class: FakeFile
  • Class: FakeGlob
  • Class: FakeRule
  • Class: FakeRule2
  • Class: FileContext
  • Class: GlobsForIgnorePattern
  • Class: IgnoredFiles
  • Class: IgnorePattern
  • Class: InstantiatedPackageMetaRule
  • Class: InstantiatedPackageRule
  • Class: Logger
  • Class: PackageJsonGlob
  • Class: ResultSet
  • Class: RuleRegistry
  • Class: RuleSet
  • Class: Success
  • Class: Suite
  • Class: TypescriptSourceGlob
  • Class: WorkspacesGlob
  • Enumeration: ResultStatus
  • @boll/core
  • Interface: CheckConfiguration
  • Interface: CheckFunctionOptions
  • Interface: Checks
  • Interface: ConfigDefinition
  • Interface: FileGlob
  • Interface: FileGlobOptions
  • Interface: GroupedResult
  • Interface: IgnoredFilesOptions
  • Interface: IgnoreFileToGlobs
  • Interface: IgnoreFileToIgnorePatterns
  • Interface: ImportPathAndLineNumber
  • Interface: InstantiatedRule
  • Interface: LoadedConfigDefinition
  • Interface: PackageMetaRule
  • Interface: PackageRule
  • Interface: Result
  • Interface: Rule
  • Interface: RuleOptions
  • Interface: RuleResult
  • Interface: RuleSetConfiguration
  • Class: EnforceRationale
  • Class: NoRedundantDepsRule
  • Class: PackageConsistency
  • @boll/rules-core
  • Interface: EnforceRationaleOptions
  • Interface: PackageConsistencyOptions
  • Class: ESLintPreferConstRule
  • Class: ESLintRules
  • @boll/rules-external-tools
  • Interface: ESLintRulesOptions
  • Class: CrossPackageDependencyDetector
  • Class: NodeModulesReferenceDetector
  • Class: RedundantImportsDetector
  • Class: SrcDetector
  • Class: TransitiveDependencyDetector
  • Class: UnusedDependencyDetector
  • @boll/rules-typescript
  • Interface: DependencyCount
  • Interface: Options
  • Interface: SourceLineAndLineNumber
  • Interface: UnusedDependencyDetectorOptions

Class: Config

@boll/core › Globals › Config

Class: Config

Hierarchy

  • Config

Index

Constructors

  • constructor

Properties

  • configRegistry
  • configuration
  • ignoredFiles
  • logger
  • ruleRegistry

Methods

  • buildSuite
  • load
  • loadRuleSets
  • mergeConfigurations
  • resolveExtendsConfiguration
  • resolveParentConfiguration
  • resolvedConfiguration

Constructors

constructor

+ new Config(configRegistry: ConfigRegistry, ruleRegistry: RuleRegistry, logger: Logger): Config

Defined in config.ts:12

Parameters:

NameType
configRegistryConfigRegistry
ruleRegistryRuleRegistry
loggerLogger

Returns: Config

Properties

Private configRegistry

• configRegistry: ConfigRegistry

Defined in config.ts:15


Private configuration

• configuration: LoadedConfigDefinition

Defined in config.ts:11


Private ignoredFiles

• ignoredFiles: IgnoredFiles = new IgnoredFiles({ root: getRepoRoot() })

Defined in config.ts:12


Private logger

• logger: Logger

Defined in config.ts:17


Private ruleRegistry

• ruleRegistry: RuleRegistry

Defined in config.ts:16

Methods

buildSuite

▸ buildSuite(): Promise‹Suite›

Defined in config.ts:20

Returns: Promise‹Suite›


load

▸ load(def: ConfigDefinition): void

Defined in config.ts:74

Parameters:

NameType
defConfigDefinition

Returns: void


loadRuleSets

▸ loadRuleSets(): Promise‹RuleSet[]›

Defined in config.ts:27

Returns: Promise‹RuleSet[]›


Private mergeConfigurations

▸ mergeConfigurations(parentConfiguration: ConfigDefinition, childConfiguration: ConfigDefinition): LoadedConfigDefinition

Defined in config.ts:114

Parameters:

NameType
parentConfigurationConfigDefinition
childConfigurationConfigDefinition

Returns: LoadedConfigDefinition


resolveExtendsConfiguration

▸ resolveExtendsConfiguration(allExtends: LoadedConfigDefinition[]): LoadedConfigDefinition

Defined in config.ts:88

Parameters:

NameType
allExtendsLoadedConfigDefinition[]

Returns: LoadedConfigDefinition


resolveParentConfiguration

▸ resolveParentConfiguration(baseConfigName: string | string[] | undefined): LoadedConfigDefinition

Defined in config.ts:96

Parameters:

NameType
baseConfigNamestring | string[] | undefined

Returns: LoadedConfigDefinition


resolvedConfiguration

▸ resolvedConfiguration(): LoadedConfigDefinition

Defined in config.ts:81

Returns: LoadedConfigDefinition

Prev
Class: BasePackageRule ‹T›
Next
Class: ConfigRegistry