Skip to content

ConfigSettings

Config discovery settings for automatic config file loading.

Stored in CLISchema and consumed by () to call discoverConfig before dispatching to a command.

Signatures

ts
interface ConfigSettings {}

Members

Properties

appName

Application name used to build config search paths.

Search paths: .{appName}.json (cwd), {appName}.config.json (cwd), and {configDir}/{appName}/config.json where configDir is $XDG_CONFIG_HOME / ~/.config on Unix or %APPDATA% / %USERPROFILE%\\AppData\\Roaming on Windows.

ts
appName: string;

loaders

Additional format loaders beyond the built-in JSON loader.

ts
loaders: readonly FormatLoader[] | undefined;

See Also

Released under the MIT License.