@boll/core
@boll/core
Index
Enumerations
Classes
- BasePackageRule
- Config
- ConfigRegistry
- Failure
- FakeFile
- FakeGlob
- FakeRule
- FakeRule2
- FileContext
- GlobsForIgnorePattern
- IgnorePattern
- IgnoredFiles
- InstantiatedPackageMetaRule
- InstantiatedPackageRule
- Logger
- PackageJsonGlob
- ResultSet
- RuleRegistry
- RuleSet
- Success
- Suite
- TypescriptSourceGlob
- WorkspacesGlob
Interfaces
- CheckConfiguration
- CheckFunctionOptions
- Checks
- ConfigDefinition
- FileGlob
- FileGlobOptions
- GroupedResult
- IgnoreFileToGlobs
- IgnoreFileToIgnorePatterns
- IgnoredFilesOptions
- ImportPathAndLineNumber
- InstantiatedRule
- LoadedConfigDefinition
- PackageMetaRule
- PackageRule
- Result
- Rule
- RuleOptions
- RuleResult
- RuleSetConfiguration
Type aliases
Variables
- ConfigRegistryInstance
- DefaultLogger
- NullLogger
- RuleRegistryInstance
- configFileName
- defaultIgnoreFileName
- ignoreFiles
- readFileAsync
- repoRoot
- test
Functions
- addRule
- asBollDirectory
- asBollFile
- asBollLineNumber
- assertArrayContentsEqual
- assertContains
- empty
- findFiles
- getIgnoreFiles
- getRepoRoot
- getSourceFile
- parse
Type aliases
BollDirectory
Ƭ BollDirectory: string & object
Defined in boll-directory.ts:3
BollFile
Ƭ BollFile: string & object
Defined in boll-file.ts:3
BollLineNumber
Ƭ BollLineNumber: number & object
Defined in boll-line-number.ts:1
CheckSeverity
Ƭ CheckSeverity: "warn" | "error"
Defined in types.ts:81
MessagePrinter
Ƭ MessagePrinter: function
Defined in logger.ts:1
Type declaration:
▸ (msg: string): void
Parameters:
| Name | Type |
|---|---|
msg | string |
RuleDefinition
Ƭ RuleDefinition: function
Defined in rule-registry.ts:4
Type declaration:
▸ (logger: Logger, options?: undefined | object): T
Parameters:
| Name | Type |
|---|---|
logger | Logger |
options? | undefined | object |
Variables
Const ConfigRegistryInstance
• ConfigRegistryInstance: ConfigRegistry‹› = new ConfigRegistry()
Defined in config-registry.ts:67
Const DefaultLogger
• DefaultLogger: Logger‹› = new Logger(console.log, console.warn, console.error)
Defined in logger.ts:22
Const NullLogger
• NullLogger: Logger‹› = new Logger(empty, empty, empty)
Defined in logger.ts:24
Const RuleRegistryInstance
• RuleRegistryInstance: RuleRegistry‹› = new RuleRegistry()
Defined in rule-registry.ts:38
Const configFileName
• configFileName: ".boll.config.js" = ".boll.config.js"
Defined in constants.ts:1
Const defaultIgnoreFileName
• defaultIgnoreFileName: ".gitignore" = ".gitignore"
Defined in git-utils.ts:5
Let ignoreFiles
• ignoreFiles: object
Defined in git-utils.ts:8
Type declaration:
[ cwd: string]: object
[ ignoreFileName: string]: string[]
Const readFileAsync
• readFileAsync: promisify = promisify(fs.readFile)
Defined in file-context.ts:8
Defined in suite.ts:11
Let repoRoot
• repoRoot: string | undefined = undefined
Defined in git-utils.ts:7
Const test
• test: any = baretest("Source detector")
Defined in tests/config.test.ts:11
Defined in tests/format.test.ts:8
Defined in tests/git-utils.test.ts:7
Defined in tests/glob.test.ts:8
Defined in tests/ignore.test.ts:7
Defined in tests/pragma.test.ts:6
Defined in tests/result.test.ts:15
Defined in tests/suite.test.ts:9
Functions
Const addRule
▸ addRule‹T›(rule: T, instance: RuleRegistry): void
Defined in rule-registry.ts:34
Type parameters:
▪ T: Rule
Parameters:
| Name | Type | Default |
|---|---|---|
rule | T | - |
instance | RuleRegistry | RuleRegistryInstance |
Returns: void
asBollDirectory
▸ asBollDirectory(dirPath: string): BollDirectory
Defined in boll-directory.ts:5
Parameters:
| Name | Type |
|---|---|
dirPath | string |
Returns: BollDirectory
asBollFile
▸ asBollFile(filePath: string): BollFile
Defined in boll-file.ts:5
Parameters:
| Name | Type |
|---|---|
filePath | string |
Returns: BollFile
asBollLineNumber
▸ asBollLineNumber(lineNumber: number): BollLineNumber
Defined in boll-line-number.ts:3
Parameters:
| Name | Type |
|---|---|
lineNumber | number |
Returns: BollLineNumber
assertArrayContentsEqual
▸ assertArrayContentsEqual(actual: string[], expected: string[]): void
Defined in tests/ignore.test.ts:9
Parameters:
| Name | Type |
|---|---|
actual | string[] |
expected | string[] |
Returns: void
Const assertContains
▸ assertContains(needle: string, haystack: string): void
Defined in tests/format.test.ts:10
Parameters:
| Name | Type |
|---|---|
needle | string |
haystack | string |
Returns: void
Const empty
▸ empty(a: string): void
Defined in logger.ts:23
Parameters:
| Name | Type |
|---|---|
a | string |
Returns: void
findFiles
▸ findFiles(pattern: string | string[], include: string[], exclude: string[]): Promise‹BollFile[]›
Defined in glob.ts:6
Parameters:
| Name | Type |
|---|---|
pattern | string | string[] |
include | string[] |
exclude | string[] |
Returns: Promise‹BollFile[]›
getIgnoreFiles
▸ getIgnoreFiles(cwd?: undefined | string, ignoreFileName?: undefined | string): Promise‹string[]›
Defined in git-utils.ts:23
Parameters:
| Name | Type |
|---|---|
cwd? | undefined | string |
ignoreFileName? | undefined | string |
Returns: Promise‹string[]›
getRepoRoot
▸ getRepoRoot(): string
Defined in git-utils.ts:10
Returns: string
getSourceFile
▸ getSourceFile(projectRoot: BollDirectory, filename: string, packageContext: Partial‹Package›): Promise‹FileContext›
Defined in file-context.ts:90
Parameters:
| Name | Type |
|---|---|
projectRoot | BollDirectory |
filename | string |
packageContext | Partial‹Package› |
Returns: Promise‹FileContext›
Const parse
▸ parse(fileContents: string): PackageInfo
Defined in package.ts:4
Parameters:
| Name | Type |
|---|---|
fileContents | string |
Returns: PackageInfo