Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CorentinTh/figue
Configuration management library, like convict but with zod
https://github.com/CorentinTh/figue
config configuration-management env environment-variables zod
Last synced: 3 months ago
JSON representation
Configuration management library, like convict but with zod
- Host: GitHub
- URL: https://github.com/CorentinTh/figue
- Owner: CorentinTh
- License: mit
- Created: 2022-05-16T07:09:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-09T22:38:27.000Z (6 months ago)
- Last Synced: 2024-07-14T12:06:31.649Z (4 months ago)
- Topics: config, configuration-management, env, environment-variables, zod
- Language: TypeScript
- Homepage:
- Size: 229 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Figue
[](https://github.com/CorentinTh/figue/actions/workflows/ci.yml)
> Platform agnostic configuration management library, with environmental variables and validation, like [convict](https://github.com/mozilla/node-convict/tree/master/packages/convict) but simpler, cross env and using [zod schemas](https://github.com/colinhacks/zod).
## Usage
Install package:
```sh
# npm
npm install figue
# yarn
yarn install figue
# pnpm
pnpm install figue
```
Import:
```js
// ESM
import { defineConfig, z } from "figue";
// CommonJS
const { defineConfig, z } = require("figue");
```
## API
### Basic example
```typescript
import { defineConfig, z } from "figue";
const { config } = defineConfig(
{
env: {
doc: "Application current environment",
default: "development",
schema: z.enum(["development", "production", "test"]),
env: "NODE_ENV",
},
port: {
doc: "Application port to listen",
schema: z.coerce.number().int().positive(),
default: 3000,
env: "PORT",
},
db: {
host: {
doc: "Database server url",
schema: z.string().url(),
default: "localhost",
env: "APP_DB_HOST",
},
username: {
doc: "Database server username",
schema: z.string(),
default: "pg",
env: "APP_DB_USERNAME",
},
password: {
doc: "Database server password",
schema: z.string(),
default: "",
env: "APP_DB_PASSWORD",
},
},
},
{
envSource: process.env,
}
);
console.log(config);
// {
// env: "development",
// port: 3000,
// db: {
// url: "https://localhost",
// username: "pg",
// password: "",
// },
// }
```
### Load environnement
Use the `envSource` key of the second argument of `defineConfig` to specify the source of the environment variables:
```typescript
const { config } = defineConfig(
{
/* ... */
},
{
envSource: process.env,
}
);
```
In some case you don't have access to a `process.env` variable, like with `vite`, just simply load what stores your env variables :
```typescript
const { config } = defineConfig(
{
/* ... */
},
{
envSource: import.meta.env,
}
);
```
You can even specify you custom environment storage as long as it's a simple flat object map, for example:
```typescript
const { config } = defineConfig(
{
env: {
doc: "Application current environment",
default: "development",
schema: z.enum(["development", "production", "test"]),
env: "NODE_ENV",
},
/* ... */
},
{
envSource: {
NODE_ENV: "development",
PORT: "3000",
APP_DB_HOST: "localhost",
APP_DB_USERNAME: "pg",
APP_DB_PASSWORD: "",
},
}
);
```
If, for some reason, you have multiple sources of environment variables, you can use the `envSources` key of the second argument of `defineConfig` to specify an array of sources:
```typescript
const { config } = defineConfig(
{
/* ... */
},
{
envSource: [import.meta.env, myEnvs],
}
);
```
## What's wrong with convict?
Convict is meant to be used in node based environnement, it needs to have access to global variables that may may not be present in some environnement (like `process`, `global`), and it also imports `fs`.
## Figue?
**Figue** is the french for _fig_ -> con-fig.
## Development
- Clone this repository
- Install dependencies using `pnpm install`
- Run interactive tests using `pnpm dev`
## Credits
Coded with ❤️ by [Corentin Thomasset](//corentin-thomasset.fr).
## License
This project is under the [MIT license](LICENSE).