Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/noblemajo/typenvy
A js&ty environment manager
https://github.com/noblemajo/typenvy
environment environment-variables javascript javascript-library library node nodejs npm npm-library npm-package typescript typescript-library
Last synced: 10 days ago
JSON representation
A js&ty environment manager
- Host: GitHub
- URL: https://github.com/noblemajo/typenvy
- Owner: NobleMajo
- License: mit
- Created: 2021-12-17T17:46:39.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-13T19:36:59.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T06:51:41.001Z (27 days ago)
- Topics: environment, environment-variables, javascript, javascript-library, library, node, nodejs, npm, npm-library, npm-package, typescript, typescript-library
- Language: TypeScript
- Homepage:
- Size: 194 KB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typenvy
# table of contents
- [typenvy](#typenvy)
- [table of contents](#table-of-contents)
- [About](#about)
- [Getting started](#getting-started)
- [other functions](#other-functions)
- [npm scripts](#npm-scripts)
- [use](#use)
- [base scripts](#base-scripts)
- [watch mode](#watch-mode)
- [contribution](#contribution)
# About
`typenvy` is a environment managment library.
## Getting started
### 1. install typenvy
```sh
npm i typenvy
```
### 2. env file
Create a example environment file at `./src/env/env.ts`:
```ts
import * as typenvy from "typenvy"
export const envDefaults = {
PRODUCTION: (process.env.NODE_ENV === "production") as boolean,
VERBOSE: false as boolean,
PORT: 8080 as number,
API_KEY: undefined as string,
API_URL: undefined as string,
}
export const envTypes: typenvy.VariablesTypes = {
PRODUCTION: [typenvy.TC_BOOLEAN],
VERBOSE: [typenvy.TC_BOOLEAN],
PORT: [typenvy.TC_NUMBER],
API_KEY: [typenvy.TC_STRING],
API_URL: [typenvy.TC_STRING],
}
```
### 3. env parser
Create a example environment parser file at `./src/env/envParser.ts`:
```ts
import { parseEnv } from "typenvy"
import { envDefaults, envTypes } from "./env"
export const env = parseEnv(
envDefaults,
envTypes
)
.setProcessEnv()
.errExit()
.env
export default env
```
### 4. load and print env in "./src/index.ts"
```ts
import env from "./env/envParser"
console.log("parser env: ", env)
console.log("process env: ", process.env)
```
### 5. start and error
If you run the `index.js` after compile the app throws an error.
This is because in the `env.ts` there is no default value provided for `API_KEY` and `API_URL`.
There are 3 options to remove this error:
#### 1. Set environment variables
Define the variables in your shell:
```sh
export API_KEY="qwertzui"
export API_URL="https://api.github.io/v2/repo/majo418/testrepo"
```
#### 2. Allow undefined as value
Allow undefined as environment variable value in `env.ts`:
```ts
export const variablesTypes: typenvy.VariablesTypes = {
PRODUCTION: [typenvy.TC_BOOLEAN],
VERBOSE: [typenvy.TC_BOOLEAN],
PORT: [typenvy.TC_NUMBER],
API_KEY: [typenvy.TC_STRING, typenvy.TC_UNDEFINED], // <---
API_URL: [typenvy.TC_STRING, typenvy.TC_UNDEFINED], // <---
}
```
#### 3. Set a default value
Allow default environment values in `envParser.ts`:
```ts
export const defaultEnv = {
PRODUCTION: (process.env.NODE_ENV === "production") as boolean,
VERBOSE: false as boolean,
PORT: 8080 as number,
API_KEY: "myDEfaultAPIkey" as string,
API_URL: "https://api.cloudflare.com/v1/dns" as string,
}
```
# other functions
By using the `parseEnv()` function tou get a `EnvResult`.
Here are all function of the Environment Result:
```ts
export interface EnvResult {
// Overwrite default values
overwriteEnv(
env: { [key: string]: any }
): EnvResult
// Set value if its missing in default values
setMissingEnv(
env: { [key: string]: any }
): EnvResult
// Put all env value as strings into process.env
setProcessEnv(): EnvResult
// Clear all env values from process.env
clearProcessEnv(
justEqualValues: boolean = true
): EnvResult
// Print env errors to console
errPrint(): EnvResult
// Throw env errors
errThrow(): EnvResult
// Exit on error
errExit(
exitCode: number = 1
): EnvResult | never
}
```
# npm scripts
The npm scripts are made for linux but can also work on mac and windows.
## use
You can run npm scripts in the project folder like this:
```sh
npm run
```
Here is an example:
```sh
npm run test
```
## base scripts
You can find all npm scripts in the `package.json` file.
This is a list of the most important npm scripts:
- test // test the app
- build // build the app
- exec // run the app
- start // build and run the app
## watch mode
Like this example you can run all npm scripts in watch mode:
```sh
npm run start:watch
```
# contribution
- 1. fork the project
- 2. implement your idea
- 3. create a pull/merge request
```ts
// please create seperated forks for different kind of featues/ideas/structure changes/implementations
```
---
**cya ;3**
*by majo418*