lib/config
lib/config.js
Functions(2)
Load and return config from `configPath` (default: cwd/.jsdoc-scribe.json).
Returns an empty object if the file doesn't exist.
| Parameter | Type | Optional | Description |
|---|---|---|---|
configPath | string | yes | - Explicit path to config file. |
Returns:
{ out?, title?, theme?, json?, readme?, ignore?, sourceUrl? } Signature
loadConfig(configPath: any): any
Merge config file values with CLI args.
CLI args take precedence over config file (explicit undefined values are skipped).
| Parameter | Type | Optional | Description |
|---|---|---|---|
fileConfig | object | - Values from .jsdoc-scribe.json | |
cliArgs | object | - Values parsed from argv (undefined = not set) |
Returns:
object — Merged options objectSignature
mergeConfig(fileConfig: any, cliArgs: any): any
Variables & Constants(5)