@lcdev/app-config

App Config

Easy Configuration Loader with Strict Validation

Features

• Schema Validation: Avoid production typos. Write JSON Schema for your configuration, and we'll have your back.
• Strong Typing: Use it with TypeScript without separate validation. Types are generated based on JSON Schema constraints.
• Powerful and Robust: Flexible parsing extensions and file loading strategies. Provides file merging, environment specific values (eg. production vs development) and more.
• First Class Encryption: Manage your secrets in version control, backed by OpenPGP (optional). Or, keep secrets away from committed files with schema validation.
• Use Your Tools: Don't be constrained by your tools - export environment variables for usage anywhere.
• Multi-Format: Write YAML, TOML, JSON, JSON5 - whatever makes most sense for you.

Using App Config

Read the Introduction or Quick Start guides on our website.

Or, start by installing through your package manager:

yarn add @lcdev/app-config@2

Or, if you use NPM.

npm i @lcdev/app-config@2

Changelog

Version 2 (v2.0.0)

🎁 Features 🔨 Breaking Changes

This new major version is effectively a rewrite, with some powerful constructs being added internally. Much of this is does not change the external semantics of the package, but internally it makes a huge difference.

The selling point for this upgrade is secret encryption. This means that a built-in solution for storing your secrets in a safe, encrypted form.

Previous to v2, secrets were a complimentary feature. This meant it was left to the user how and where secret values were stored.

In general, it's nice to store configuration in version control if possible. This is, of course, impractical for values that should never be public. Having these secrets in plaintext is just asking for trouble.

Solutions have come out to do this - git-secret, git-crypt and blackbox to name a few. We have built a similar solution, but highly integrated. At Launchcode, we tried these solutions, but felt that they were clunky to use for users who weren't very familiar with GPG.

So, we set course on designing an interface that combined the security of these tools with the ergonomics that developers expect. There were many dead ends, actually. It became increasing obvious that such a feature could not be easily added to app-config without a fairly major change in architecture.