55 lines
3.3 KiB
Markdown
55 lines
3.3 KiB
Markdown
# @pushrocks/qenv
|
|
easy promised environments
|
|
|
|
## Availabililty and Links
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/qenv)
|
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/qenv)
|
|
* [github.com (source mirror)](https://github.com/pushrocks/qenv)
|
|
* [docs (typedoc)](https://pushrocks.gitlab.io/qenv/)
|
|
|
|
## Status for master
|
|
|
|
Status Category | Status Badge
|
|
-- | --
|
|
GitLab Pipelines | [](https://lossless.cloud)
|
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
|
npm | [](https://lossless.cloud)
|
|
Snyk | [](https://lossless.cloud)
|
|
TypeScript Support | [](https://lossless.cloud)
|
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
Code Style | [](https://lossless.cloud)
|
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
|
|
|
## Usage
|
|
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
qenv works with two files:
|
|
|
|
- **qenv.yml** - specifies which ENV vars are required.
|
|
- **env.yml** - specifies all env vars that are not already set in the current environment.
|
|
|
|
Now obviously you can set build specific env vars in many CI environments.
|
|
So there we do not need an **env.yml** since all ENV vars are in place
|
|
However when on another machine you can have a env.yml that will be added to the environment by qenv.
|
|
|
|
```javascript
|
|
import { Qenv } from 'qenv';
|
|
|
|
const myQenv = new Qenv('path/to/dir/where/qenv.yml/is/', 'path/to/dir/where/env.yml/is(');
|
|
```
|
|
|
|
## Contribution
|
|
|
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
|
|
|
[](https://maintainedby.lossless.com)
|