@stencila/configa

Configa

Application configuration: DRY, flexible and type-safe. Pick any three.

:warning: Configa is in early development. It's been factored out of Sparkla, another project in early development, for more general usage.

Install

npm install --save @stencila/configa

Usage

All configuration options can be set, in descending order of priority, by:

• a command line argument e.g. --<value> <value>
• an environment variable prefixed with CONFIGA_ e.g. CONFIGA_<option>=<value>
• a .json or .ini configuration file, set using the --config option, or .configarc by default

Name	Description	Type	Validators	Default
appName	The name of the application.1	string		undefined
configPath	Path to the configuration file to be parsed.2	string		undefined
jsonSchemaPath	Path to the JSON Schema file to be generated.3	string		undefined
readmePath	Path to the README file to be updated.	string		"README.md"

1. Determines the expected prefix on the names of config files and environment variables. If undefined then parse the name from the package name in ./package.json.
2. If undefined, then will search for a file config.ts in the current directory and its subdirectories.
3. If undefined, then will be the path of the config file with extension .json.schema instead of .ts.