Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tusbar/babel-plugin-dotenv-import
Load environment variables using import statements.
https://github.com/tusbar/babel-plugin-dotenv-import
babel babel-plugin dotenv environment-variables
Last synced: 6 days ago
JSON representation
Load environment variables using import statements.
- Host: GitHub
- URL: https://github.com/tusbar/babel-plugin-dotenv-import
- Owner: tusbar
- License: mit
- Created: 2017-10-25T20:01:42.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-06T19:35:14.000Z (11 months ago)
- Last Synced: 2024-10-27T19:57:35.629Z (9 days ago)
- Topics: babel, babel-plugin, dotenv, environment-variables
- Language: JavaScript
- Homepage:
- Size: 2.69 MB
- Stars: 80
- Watchers: 2
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# babel-plugin-dotenv-import
> Load environment variables using `import` statements.
[](https://www.npmjs.com/package/babel-plugin-dotenv-import)
[](https://codecov.io/gh/tusbar/babel-plugin-dotenv-import)
[](https://github.com/xojs/xo)
## CI
[](https://github.com/tusbar/babel-plugin-dotenv-import/actions/workflows/tests.yml)
[](https://github.com/tusbar/babel-plugin-dotenv-import/actions/workflows/release.yml)
## Installation
```sh
$ npm install babel-plugin-dotenv-import
```
## Usage
**.babelrc**
```json
{
"plugins": [
["dotenv-import", {
"moduleName": "@env",
"path": ".env",
"blocklist": null,
"allowlist": null,
"safe": false,
"allowUndefined": false
}]
]
}
```
**.env**
```dosini
API_URL=https://api.example.org
API_TOKEN=
```
In **users.js**
```js
import {API_URL, API_TOKEN} from "@env"
fetch(`${API_URL}/users`, {
headers: {
'Authorization': `Bearer ${API_TOKEN}`
}
})
```
## Allow and block lists
It is possible to limit the scope of env variables that will be imported by specifying a `allowlist` and/or a `blocklist` as an array of strings.
```json
{
"plugins": [
["dotenv-import", {
"blocklist": [
"GITHUB_TOKEN"
]
}]
]
}
```
```json
{
"plugins": [
["dotenv-import", {
"allowlist": [
"API_URL",
"API_TOKEN"
]
}]
]
}
```
## Safe mode
Enable safe mode to only allow environment variables defined in the `.env` file. This will completely ignore everything that is already defined in the environment.
The `.env` file has to exist.
```json
{
"plugins": [
["dotenv-import", {
"safe": true
}]
]
}
```
## Allow undefined
Allow importing undefined variables, their value will be `undefined`.
```json
{
"plugins": [
["dotenv-import", {
"allowUndefined": true
}]
]
}
```
```js
import {UNDEFINED_VAR} from '@env'
console.log(UNDEFINED_VAR === undefined) // true
```
When `false` (default behavior), an error will be thrown.
## Caveats
When using with [`babel-loader`](https://github.com/babel/babel-loader) with caching enabled you will run into issues where environment changes won’t be picked up.
This is due to the fact that `babel-loader` computes a `cacheIdentifier` that does not take your environment into account.
You can easily clear the cache:
```shell
rm -rf node_modules/.cache/babel-loader/*
```
Or you can override the default `cacheIdentifier` to include some of your environment variables.
## Credits
Based on [David Chang](https://github.com/zetachang)’s works on [babel-plugin-dotenv](https://github.com/zetachang/react-native-dotenv/tree/master/babel-plugin-dotenv).
## Miscellaneous
```
╚⊙ ⊙╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
```