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

@boll/cli › Globals › Cli

Class: Cli

Hierarchy

  • Cli

Index

Constructors

  • constructor

Properties

  • logger

Methods

  • logGroupedResults
  • logResults
  • run

Constructors

constructor

+ new Cli(logger: Logger): Cli

Defined in cli.ts:15

Parameters:

NameType
loggerLogger

Returns: Cli

Properties

Private logger

• logger: Logger

Defined in cli.ts:16

Methods

Private logGroupedResults

▸ logGroupedResults(result: GroupedResult, formatter: Formatter): void

Defined in cli.ts:60

Parameters:

NameType
resultGroupedResult
formatterFormatter

Returns: void


Private logResults

▸ logResults(result: Record‹"errors" | "warnings", RuleResult[]›, formatter: Formatter): void

Defined in cli.ts:51

Parameters:

NameType
resultRecord‹"errors" | "warnings", RuleResult[]›
formatterFormatter

Returns: void


run

▸ run(args: string[]): Promise‹Status›

Defined in cli.ts:18

Parameters:

NameType
argsstring[]

Returns: Promise‹Status›

Next
Class: ConfigGenerator