Interface PentfOptions

interface PentfOptions {
    configDir?: string;
    defaultConfig?: (config: Config) => Config;
    description?: string;
    rootDir?: string;
}

Index

Properties

configDir? defaultConfig? description? rootDir?

Properties

`Optional`configDir

configDir?: string

Configuration directory. false disables configuration.

`Optional`defaultConfig

defaultConfig?: (config: Config) => Config

Function to call on the loaded configuration, to set/compute default values.

`Optional`description

description?: string

program description in the --help output

`Optional`rootDir

rootDir?: string

Root directory (assume tests/ contains tests, config/ if exists contains config)