Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marinerer/gulp-env-loader
A gulp plugin for loading environment variables and replacing them in the contents of files. 👉 处理环境变量的 gulp 插件,用于加载环境变量配置文件并替换内容。
https://github.com/marinerer/gulp-env-loader
dotenv env env-loader gul-env-loader gulp-env gulp-environment gulp-plugin
Last synced: 5 days ago
JSON representation
A gulp plugin for loading environment variables and replacing them in the contents of files. 👉 处理环境变量的 gulp 插件,用于加载环境变量配置文件并替换内容。
- Host: GitHub
- URL: https://github.com/marinerer/gulp-env-loader
- Owner: Marinerer
- License: mit
- Created: 2023-04-24T13:23:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-26T01:07:26.000Z (about 1 year ago)
- Last Synced: 2024-11-16T16:49:41.184Z (about 1 month ago)
- Topics: dotenv, env, env-loader, gul-env-loader, gulp-env, gulp-environment, gulp-plugin
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/gulp-env-loader
- Size: 72.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-env-loader
[ [English](./README.md) | [中文](./README.zh_CN.md) ]
A gulp plugin for loading environment variables and replacing them in file contents.
It can load environment variables from a specified configuration file or from the default `.env` file.
It uses `dotenv` to load additional environment variables from the following files in your environment directory, and it also statically replaces environment variables that appear in the file.
```
.env # loaded in all cases
.env.local # loaded in all cases, but ignored by git
.env.[mode] # only loaded in specified mode
.env.[mode].local # only loaded in specified mode, but ignored by git
```
> ignores `.*.local`, so you also need to add it to your project's `.gitignore` file:
```
# local env files
.env.local
.env.*.local
```
## Install
```
npm install -D gulp-env-loader
```
> `Node.js > 12`
## Usage
1. Create a `.env` file in the root directory of your project, or create different `.env` files for different environments, such as `.env.development`, `.env.production`, etc.
```yml
# .env configuration
APP_MODE="development"
APP_API_URL="http://test-api.com"
```
```yml
# .env.production configuration
APP_MODE="production"
APP_API_URL="https://api.com"
```
2. Create `gulpfile.js`
```js
const gulp = require('gulp')
const envInject = require('gulp-env-loader')() //!recommended to put at the beginning and execute immediately
// Output the configured environment variables
console.log('env', envInject.env)
gulp.task('build', function() {
return gulp.src('./src/*.js', { sourcemaps: true })
.pipe(envInject())
.pipe(gulp.dest('./dist', { sourcemaps: '.' }))
})
```
3. You can add the runtime parameter `mode` at runtime, which will automatically load the corresponding environment variable configuration file.
```
gulp build --mode=production
```
4. Output results
Source file: `./src/api.js`
```js
export function userLogin(params) {
return http.post(`${process.env.APP_API_URL}/user/login`, params)
}
```
Output file: `./dist/api.js`
```js
export function userLogin(params) {
return http.post(`https://api.com/user/login`, params)
}
```
## API
```ts
require('gulp-env-loader')([config])
```
### config
An optional configuration object or configuration file path.
If it is a string, it represents the configuration file path. If it is an object, it can contain the following properties:
- `path` - (`string`) Configuration file path, default is `.env`
- `mode` - (`string`) Environment mode name.
- `modekey` - (`string`) Environment mode key name, default is `mode`
- `ignoreProcessEnv` - (`boolean`) Turn off writing to `process.env`
### Return value
```js
envInject([option])
```
Creates a through2 stream for replacing environment variables in file contents.
- `isVar` - (`boolean`) Replaces environment variables with their corresponding string representations (Single quotation marks). Default is `true`.
- `env` - (`object`) Additional Environment Variables.
## Thanks
* [dotenv](https://www.npmjs.com/package/dotenv)
* [dotenv-expand](https://www.npmjs.com/package/dotenv-expand)
* https://juejin.cn/post/6993224664705138702