boll

# @boll/core

@boll/core › Globals

# @boll/core

# Index

# Enumerations

# Classes

# Interfaces

# Type aliases

# Variables

# Functions

# 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

# DependencyMap

Ƭ DependencyMap: object

Defined in package.ts:1

# Type declaration:

  • [ depdencyName: string]: string

# 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): PackageRule

Parameters:

Name Type
logger Logger

# Variables

# Const ConfigRegistryInstance

• ConfigRegistryInstance: ConfigRegistry‹› = new ConfigRegistry()

Defined in config-registry.ts:25

# 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:23

# Const configFileName

• configFileName: ".boll.config.js" = ".boll.config.js"

Defined in constants.ts:1

# Const globAsync

• globAsync: promisify = promisify(glob)

Defined in glob.ts:5

# Const readFileAsync

• readFileAsync: promisify = promisify(fs.readFile)

Defined in file-context.ts:8

Defined in suite.ts:11

# Const test

• test: any = baretest("Source detector")

Defined in tests/config.test.ts:11

Defined in tests/format.test.ts:8

Defined in tests/glob.test.ts:8

Defined in tests/pragma.test.ts:6

# Functions

# 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

# 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

# getConfigFileType

▸ getConfigFileType(file: BollFile): ConfigFileType

Defined in parse-config.ts:33

Parameters:

Name Type
file BollFile

Returns: ConfigFileType

# getSourceFile

▸ getSourceFile(projectRoot: BollDirectory, filename: string, packageContext: Package): Promise‹FileContext›

Defined in file-context.ts:56

Parameters:

Name Type
projectRoot BollDirectory
filename string
packageContext Package

Returns: Promise‹FileContext›

# parseConfig

▸ parseConfig(file: BollFile): any

Defined in parse-config.ts:19

This function returns a parsed config file providedit is in one of the following formats:

  • *.js
  • *.yaml
  • *.yml
  • *.json

Parameters:

Name Type
file BollFile

Returns: any

# parseJsConfig

▸ parseJsConfig(file: BollFile): any

Defined in parse-config.ts:49

Parameters:

Name Type
file BollFile

Returns: any

# parseJsonConfig

▸ parseJsonConfig(file: BollFile): any

Defined in parse-config.ts:66

Parameters:

Name Type
file BollFile

Returns: any

# parseYamlConfig

▸ parseYamlConfig(file: BollFile): any

Defined in parse-config.ts:57

Parameters:

Name Type
file BollFile

Returns: any

# readFile

▸ readFile(file: BollFile): string

Defined in parse-config.ts:75

Parameters:

Name Type
file BollFile

Returns: string

# suite

▸ suite(): Promise‹void›

Defined in tests/all.test.ts:6

Returns: Promise‹void›

← Interface: CheckConfiguration →