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: Suite

@boll/core › Globals › Suite

Class: Suite

Hierarchy

  • Suite

Index

Properties

  • _hasRun
  • ruleSets

Accessors

  • hasRun

Methods

  • addFailuresWithSeverity
  • filterIgnoredChecksByLine
  • loadPackage
  • run
  • runRuleSet

Properties

Private _hasRun

• _hasRun: boolean = false

Defined in suite.ts:14


ruleSets

• ruleSets: RuleSet[] = []

Defined in suite.ts:15

Accessors

hasRun

• get hasRun(): boolean

Defined in suite.ts:17

Returns: boolean

Methods

Private addFailuresWithSeverity

▸ addFailuresWithSeverity(rule: InstantiatedRule, results: Result[], resultSet: ResultSet): void

Defined in suite.ts:95

Parameters:

NameType
ruleInstantiatedRule
resultsResult[]
resultSetResultSet

Returns: void


filterIgnoredChecksByLine

▸ filterIgnoredChecksByLine(results: Result[], sourceFile: FileContext): Promise‹Result[]›

Defined in suite.ts:75

Parameters:

NameType
resultsResult[]
sourceFileFileContext

Returns: Promise‹Result[]›


Private loadPackage

▸ loadPackage(logger: Logger): Promise‹PackageInfo›

Defined in suite.ts:62

Parameters:

NameType
loggerLogger

Returns: Promise‹PackageInfo›


run

▸ run(logger: Logger): Promise‹ResultSet›

Defined in suite.ts:21

Parameters:

NameType
loggerLogger

Returns: Promise‹ResultSet›


runRuleSet

▸ runRuleSet(logger: Logger, ruleSet: RuleSet, resultSet: ResultSet): Promise‹boolean›

Defined in suite.ts:30

Parameters:

NameType
loggerLogger
ruleSetRuleSet
resultSetResultSet

Returns: Promise‹boolean›

Prev
Class: Success
Next
Class: TypescriptSourceGlob