Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matii96/unifig
Universal, typed and validated configuration manager.
https://github.com/matii96/unifig
configuration nestjs typescript
Last synced: 3 months ago
JSON representation
Universal, typed and validated configuration manager.
- Host: GitHub
- URL: https://github.com/matii96/unifig
- Owner: Matii96
- License: mit
- Created: 2022-10-10T19:12:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-02T09:15:51.000Z (4 months ago)
- Last Synced: 2024-10-29T14:25:28.779Z (3 months ago)
- Topics: configuration, nestjs, typescript
- Language: TypeScript
- Homepage:
- Size: 3.88 MB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Unifig
Universal, typed and validated configuration manager.
[](/LICENSE)
[](https://www.npmjs.com/package/@unifig/core)
[](http://commitizen.github.io/cz-cli)
[](https://codecov.io/gh/Matii96/unifig)
[](https://github.com/Matii96/unifig/actions?workflow=main-build)
## Table of Contents
- [Goal](#goal)
- [Packages](#packages)
- [Examples](#examples)
- [Local Development](#local_development)
- [Building Packages](#local_development_building_packages)
- [Testing](#local_development_testing)
- [Committing](#local_development_committing)
- [Authors](#authors)
- [License](#license)
## 💡 Goal
Unifig aims to provides simple and abstract way of handling app's configuration. It allows to load configuration data from multiple sources without changing defined config template. Many templates can be defined to further organize the code eg. MainConfiguration and ModuleConfiguration.
Adapted configuration data is transformed into templates and validated via [class-transformer](https://github.com/typestack/class-transformer) and [class-validator](https://github.com/typestack/class-validator). Once initialized configurations can be reloaded without app restart.
## Packages
- [Core](https://github.com/Matii96/unifig/tree/main/packages/core) - project implementation for vanilla typescript
- [Nest](https://github.com/Matii96/unifig/tree/main/packages/nest) - nestjs integration
- [Adapter: env](https://github.com/Matii96/unifig/tree/main/packages/adapter-env) - adapter for environment variables and .env files
- [Validation presenter: table](https://github.com/Matii96/unifig/tree/main/packages/validation-presenter-table) - transforms configuration validation errors into table format
- [Validation presenter: JSON](https://github.com/Matii96/unifig/tree/main/packages/validation-presenter-json) - transforms configuration validation errors into JSON string
## Examples
- [Express + typescript](https://github.com/Matii96/unifig/tree/main/examples/01-express)
- [NestJS](https://github.com/Matii96/unifig/tree/main/examples/02-nest)
## Local Development
Project uses [yarn workspaces](https://yarnpkg.com/features/workspaces) in combination with [lerna](https://lerna.js.org). To initialize the project run
```bash
yarn
```
### Building Packages
As project uses typescript for the package to be seen as other packages dependency they need to be built first.
```bash
yarn build
```
### Testing
```bash
yarn lint:staged # linting staged files
yarn test # running unit tests for packages changed since HEAD
yarn test:cov # running unit tests for whole repo with coverage report
yarn test:e2e # running e2e tests for packages changed since HEAD with packages dependent on them
yarn test:all # combining test and test:e2e
```
### Committing
The project follows [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) standard. To conveniently create commit message use [commitizen](https://commitizen-tools.github.io/commitizen) by typing
```bash
yarn cz
```
## Authors
**Mateusz Fonfara**
- Github: [@Matii96](https://github.com/Matii96)
- Medium: [@Matii96](https://medium.com/@matii96)
See also the full list of [contributors](https://github.com/Matii96/unifig/contributors).
## License
This project is licensed under the MIT License - see the [LICENSE file](https://github.com/Matii96/unifig/tree/main/LICENSE) for details.