willfrew / node-btrconf Goto Github PK

The API for this is a bit weird, given that it reads the file from disk itself. There's no real need.

Proposed changes:

• Export just the function that does the merging etc.
• Consumers would therefore just write the config file themselves and import as normal. Then use said function to pull out the correct subset of configuration.
• Don't depend on NODE_ENV directly, or at least allow downstream projects to use different config methods.
• Provide types for the input config structure, something like:

interface BtrConfInput<Config> {
  default: DeepPartial<Config>;
  [env: string]: DeepPartial<Config>;
}

• The above would still want you to validate the final config against a json schema. (Possibly generated from the Config type interface).

It would be good to add Typescript definitions and make these available to users of the typings, somehow.