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

@boll/core › Globals › FileContext

Class: FileContext

Hierarchy

  • FileContext

Index

Constructors

  • constructor

Properties

  • _ignoredChecks
  • _ignoredChecksByLine
  • _parsedIgnoreChecks
  • _parsedIgnoreChecksByLine
  • _sourceFile
  • _sourceFileLoaded
  • content
  • filename
  • packageContext
  • packageRoot

Accessors

  • ignoredChecks
  • ignoredChecksByLine
  • packageDependencies
  • packageDevDependencies
  • relativeFilename
  • source

Methods

  • shouldSkip

Constructors

constructor

+ new FileContext(packageRoot: BollDirectory, packageContext: Partial‹Package›, filename: BollFile, content: string): FileContext

Defined in file-context.ts:16

Parameters:

NameType
packageRootBollDirectory
packageContextPartial‹Package›
filenameBollFile
contentstring

Returns: FileContext

Properties

Private _ignoredChecks

• _ignoredChecks: string[] = []

Defined in file-context.ts:13


Private _ignoredChecksByLine

• _ignoredChecksByLine: Map‹number, string[]› = new Map()

Defined in file-context.ts:16


Private _parsedIgnoreChecks

• _parsedIgnoreChecks: boolean = false

Defined in file-context.ts:11


Private _parsedIgnoreChecksByLine

• _parsedIgnoreChecksByLine: boolean = false

Defined in file-context.ts:12


Private Optional _sourceFile

• _sourceFile? : ts.SourceFile = undefined

Defined in file-context.ts:15


Private _sourceFileLoaded

• _sourceFileLoaded: boolean = false

Defined in file-context.ts:14


content

• content: string

Defined in file-context.ts:22


filename

• filename: BollFile

Defined in file-context.ts:21


packageContext

• packageContext: Partial‹Package›

Defined in file-context.ts:20


packageRoot

• packageRoot: BollDirectory

Defined in file-context.ts:19

Accessors

ignoredChecks

• get ignoredChecks(): string[]

Defined in file-context.ts:40

Returns: string[]


ignoredChecksByLine

• get ignoredChecksByLine(): Map‹number, string[]›

Defined in file-context.ts:57

Returns: Map‹number, string[]›


packageDependencies

• get packageDependencies(): Package["dependencies"] | undefined

Defined in file-context.ts:32

Returns: Package["dependencies"] | undefined


packageDevDependencies

• get packageDevDependencies(): Package["devDependencies"] | undefined

Defined in file-context.ts:36

Returns: Package["devDependencies"] | undefined


relativeFilename

• get relativeFilename(): string

Defined in file-context.ts:81

Returns: string


source

• get source(): SourceFile

Defined in file-context.ts:25

Returns: SourceFile

Methods

shouldSkip

▸ shouldSkip(r: Rule): boolean

Defined in file-context.ts:85

Parameters:

NameType
rRule

Returns: boolean

Prev
Class: FakeRule2
Next
Class: GlobsForIgnorePattern