wrap-env 16.3.2 → 16.3.4

package/README.md

@@ -1,14 +1,12 @@
+### Note: This package is an wrap of `dotenv`
+
 <div align="center">
 
-<p>
-  <sup>
-    <a href="https://github.com/sponsors/motdotla">Dotenv is supported by the community.</a>
-  </sup>
-</p>
 <sup>Special thanks to:</sup>
 <br>
 <br>
 <a href="https://www.warp.dev/?utm_source=github&utm_medium=referral&utm_campaign=dotenv_p_20220831">
+
   <div>
     <img src="https://res.cloudinary.com/dotenv-org/image/upload/v1661980709/warp_hi8oqj.png" width="230" alt="Warp">
   </div>
@@ -48,16 +46,16 @@ Dotenv is a zero-dependency module that loads environment variables from a `.env
 
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
 [![LICENSE](https://img.shields.io/github/license/motdotla/dotenv.svg)](LICENSE)
-[![dotenv-vault](https://badge.dotenv.org/works-with.svg?r=1)](https://www.dotenv.org/r/github.com/dotenv-org/dotenv-vault?r=1) 
+[![dotenv-vault](https://badge.dotenv.org/works-with.svg?r=1)](https://www.dotenv.org/r/github.com/dotenv-org/dotenv-vault?r=1)
 
-* [🌱 Install](#-install)
-* [🏗️ Usage (.env)](#%EF%B8%8F-usage)
-* [🚀 Deploying (.env.vault) 🆕](#-deploying)
-* [🌴 Multiple Environments 🆕](#-manage-multiple-environments)
-* [📚 Examples](#-examples)
-* [📖 Docs](#-documentation)
-* [❓ FAQ](#-faq)
-* [⏱️ Changelog](./CHANGELOG.md)
+- [🌱 Install](#-install)
+- [🏗️ Usage (.env)](#%EF%B8%8F-usage)
+- [🚀 Deploying (.env.vault) 🆕](#-deploying)
+- [🌴 Multiple Environments 🆕](#-manage-multiple-environments)
+- [📚 Examples](#-examples)
+- [📖 Docs](#-documentation)
+- [❓ FAQ](#-faq)
+- [⏱️ Changelog](./CHANGELOG.md)
 
 ## 🌱 Install
 
@@ -87,14 +85,14 @@ SECRET_KEY="YOURSECRETKEYGOESHERE"
 As early as possible in your application, import and configure dotenv:
 
 ```javascript
-require('dotenv').config()
-console.log(process.env) // remove this after you've confirmed it is working
+require("dotenv").config();
+console.log(process.env); // remove this after you've confirmed it is working
 ```
 
 .. [or using ES6?](#how-do-i-use-dotenv-with-import)
 
 ```javascript
-import 'dotenv/config'
+import "dotenv/config";
 ```
 
 That's it. `process.env` now has the keys and values you defined in your `.env` file:
@@ -142,10 +140,10 @@ Comments begin where a `#` exists, so if your value contains a `#` please wrap i
 The engine which parses the contents of your file containing environment variables is available to use. It accepts a String or Buffer and will return an Object with the parsed keys and values.
 
 ```javascript
-const dotenv = require('dotenv')
-const buf = Buffer.from('BASIC=basic')
-const config = dotenv.parse(buf) // will return an object
-console.log(typeof config, config) // object { BASIC : 'basic' }
+const dotenv = require("dotenv");
+const buf = Buffer.from("BASIC=basic");
+const config = dotenv.parse(buf); // will return an object
+console.log(typeof config, config); // object { BASIC : 'basic' }
 ```
 
 ### Preload
@@ -190,7 +188,7 @@ You need to manage your secrets across different environments and apply them as
 
 ## 🚀 Deploying
 
-*Note: Requires dotenv >= 16.1.0*
+_Note: Requires dotenv >= 16.1.0_
 
 Encrypt your `.env.vault` file.
 
@@ -213,7 +211,7 @@ heroku config:set DOTENV_KEY=dotenv://:key_1234…@dotenv.org/vault/.env.vault?e
 
 That's it! On deploy, your `.env.vault` file will be decrypted and its secrets injected as environment variables – just in time.
 
-*ℹ️ A note from [Mot](https://github.com/motdotla): Until recently, we did not have an opinion on how and where to store your secrets in production. We now strongly recommend generating a `.env.vault` file. It's the best way to prevent your secrets from being scattered across multiple servers and cloud providers – protecting you from breaches like the [CircleCI breach](https://techcrunch.com/2023/01/05/circleci-breach/). Also it unlocks interoperability WITHOUT native third-party integrations. Third-party integrations are [increasingly risky](https://coderpad.io/blog/development/heroku-github-breach/) to our industry. They may be the 'du jour' of today, but we imagine a better future.*
+_ℹ️ A note from [Mot](https://github.com/motdotla): Until recently, we did not have an opinion on how and where to store your secrets in production. We now strongly recommend generating a `.env.vault` file. It's the best way to prevent your secrets from being scattered across multiple servers and cloud providers – protecting you from breaches like the [CircleCI breach](https://techcrunch.com/2023/01/05/circleci-breach/). Also it unlocks interoperability WITHOUT native third-party integrations. Third-party integrations are [increasingly risky](https://coderpad.io/blog/development/heroku-github-breach/) to our industry. They may be the 'du jour' of today, but we imagine a better future._
 
 <a href="https://github.com/dotenv-org/dotenv-vault#dotenv-vault-">Learn more at dotenv-vault: Deploying</a>
 
@@ -231,7 +229,7 @@ Regenerate your `.env.vault` file.
 $ npx dotenv-vault build
 ```
 
-*ℹ️  🔐 Vault Managed vs 💻 Locally Managed: The above example, for brevity's sake, used the 🔐 Vault Managed solution to manage your `.env.vault` file. You can instead use the 💻 Locally Managed solution. [Read more here](https://github.com/dotenv-org/dotenv-vault#how-do-i-use--locally-managed-dotenv-vault). Our vision is that other platforms and orchestration tools adopt the `.env.vault` standard as they did the `.env` standard. We don't expect to be the only ones providing tooling to manage and generate `.env.vault` files.*
+_ℹ️ 🔐 Vault Managed vs 💻 Locally Managed: The above example, for brevity's sake, used the 🔐 Vault Managed solution to manage your `.env.vault` file. You can instead use the 💻 Locally Managed solution. [Read more here](https://github.com/dotenv-org/dotenv-vault#how-do-i-use--locally-managed-dotenv-vault). Our vision is that other platforms and orchestration tools adopt the `.env.vault` standard as they did the `.env` standard. We don't expect to be the only ones providing tooling to manage and generate `.env.vault` files._
 
 <a href="https://github.com/dotenv-org/dotenv-vault#-manage-multiple-environments">Learn more at dotenv-vault: Manage Multiple Environments</a>
 
@@ -239,32 +237,32 @@ $ npx dotenv-vault build
 
 See [examples](https://github.com/dotenv-org/examples) of using dotenv with various frameworks, languages, and configurations.
 
-* [nodejs](https://github.com/dotenv-org/examples/tree/master/dotenv-nodejs)
-* [nodejs (debug on)](https://github.com/dotenv-org/examples/tree/master/dotenv-nodejs-debug)
-* [nodejs (override on)](https://github.com/dotenv-org/examples/tree/master/dotenv-nodejs-override)
-* [nodejs (processEnv override)](https://github.com/dotenv-org/examples/tree/master/dotenv-custom-target)
-* [nodejs (DOTENV_KEY override)](https://github.com/dotenv-org/examples/tree/master/dotenv-vault-custom-target)
-* [esm](https://github.com/dotenv-org/examples/tree/master/dotenv-esm)
-* [esm (preload)](https://github.com/dotenv-org/examples/tree/master/dotenv-esm-preload)
-* [typescript](https://github.com/dotenv-org/examples/tree/master/dotenv-typescript)
-* [typescript parse](https://github.com/dotenv-org/examples/tree/master/dotenv-typescript-parse)
-* [typescript config](https://github.com/dotenv-org/examples/tree/master/dotenv-typescript-config)
-* [webpack](https://github.com/dotenv-org/examples/tree/master/dotenv-webpack)
-* [webpack (plugin)](https://github.com/dotenv-org/examples/tree/master/dotenv-webpack2)
-* [react](https://github.com/dotenv-org/examples/tree/master/dotenv-react)
-* [react (typescript)](https://github.com/dotenv-org/examples/tree/master/dotenv-react-typescript)
-* [express](https://github.com/dotenv-org/examples/tree/master/dotenv-express)
-* [nestjs](https://github.com/dotenv-org/examples/tree/master/dotenv-nestjs)
-* [fastify](https://github.com/dotenv-org/examples/tree/master/dotenv-fastify)
+- [nodejs](https://github.com/dotenv-org/examples/tree/master/dotenv-nodejs)
+- [nodejs (debug on)](https://github.com/dotenv-org/examples/tree/master/dotenv-nodejs-debug)
+- [nodejs (override on)](https://github.com/dotenv-org/examples/tree/master/dotenv-nodejs-override)
+- [nodejs (processEnv override)](https://github.com/dotenv-org/examples/tree/master/dotenv-custom-target)
+- [nodejs (DOTENV_KEY override)](https://github.com/dotenv-org/examples/tree/master/dotenv-vault-custom-target)
+- [esm](https://github.com/dotenv-org/examples/tree/master/dotenv-esm)
+- [esm (preload)](https://github.com/dotenv-org/examples/tree/master/dotenv-esm-preload)
+- [typescript](https://github.com/dotenv-org/examples/tree/master/dotenv-typescript)
+- [typescript parse](https://github.com/dotenv-org/examples/tree/master/dotenv-typescript-parse)
+- [typescript config](https://github.com/dotenv-org/examples/tree/master/dotenv-typescript-config)
+- [webpack](https://github.com/dotenv-org/examples/tree/master/dotenv-webpack)
+- [webpack (plugin)](https://github.com/dotenv-org/examples/tree/master/dotenv-webpack2)
+- [react](https://github.com/dotenv-org/examples/tree/master/dotenv-react)
+- [react (typescript)](https://github.com/dotenv-org/examples/tree/master/dotenv-react-typescript)
+- [express](https://github.com/dotenv-org/examples/tree/master/dotenv-express)
+- [nestjs](https://github.com/dotenv-org/examples/tree/master/dotenv-nestjs)
+- [fastify](https://github.com/dotenv-org/examples/tree/master/dotenv-fastify)
 
 ## 📖 Documentation
 
 Dotenv exposes four functions:
 
-* `config`
-* `parse`
-* `populate`
-* `decrypt`
+- `config`
+- `parse`
+- `populate`
+- `decrypt`
 
 ### Config
 
@@ -273,13 +271,13 @@ Dotenv exposes four functions:
 and return an Object with a `parsed` key containing the loaded content or an `error` key if it failed.
 
 ```js
-const result = dotenv.config()
+const result = dotenv.config();
 
 if (result.error) {
-  throw result.error
+  throw result.error;
 }
 
-console.log(result.parsed)
+console.log(result.parsed);
 ```
 
 You can additionally, pass options to `config`.
@@ -293,7 +291,7 @@ Default: `path.resolve(process.cwd(), '.env')`
 Specify a custom path if your file containing environment variables is located elsewhere.
 
 ```js
-require('dotenv').config({ path: '/custom/path/to/.env' })
+require("dotenv").config({ path: "/custom/path/to/.env" });
 ```
 
 ##### encoding
@@ -303,7 +301,7 @@ Default: `utf8`
 Specify the encoding of your file containing environment variables.
 
 ```js
-require('dotenv').config({ encoding: 'latin1' })
+require("dotenv").config({ encoding: "latin1" });
 ```
 
 ##### debug
@@ -313,7 +311,7 @@ Default: `false`
 Turn on logging to help debug why certain keys or values are not being set as you expect.
 
 ```js
-require('dotenv').config({ debug: process.env.DEBUG })
+require("dotenv").config({ debug: process.env.DEBUG });
 ```
 
 ##### override
@@ -323,7 +321,7 @@ Default: `false`
 Override any environment variables that have already been set on your machine with values from your .env file.
 
 ```js
-require('dotenv').config({ override: true })
+require("dotenv").config({ override: true });
 ```
 
 ##### processEnv
@@ -333,11 +331,11 @@ Default: `process.env`
 Specify an object to write your secrets to. Defaults to `process.env` environment variables.
 
 ```js
-const myObject = {}
-require('dotenv').config({ processEnv: myObject })
+const myObject = {};
+require("dotenv").config({ processEnv: myObject });
 
-console.log(myObject) // values from .env or .env.vault live here now.
-console.log(process.env) // this was not changed or written to
+console.log(myObject); // values from .env or .env.vault live here now.
+console.log(process.env); // this was not changed or written to
 ```
 
 ##### DOTENV_KEY
@@ -347,7 +345,10 @@ Default: `process.env.DOTENV_KEY`
 Pass the `DOTENV_KEY` directly to config options. Defaults to looking for `process.env.DOTENV_KEY` environment variable. Note this only applies to decrypting `.env.vault` files. If passed as null or undefined, or not passed at all, dotenv falls back to its traditional job of parsing a `.env` file.
 
 ```js
-require('dotenv').config({ DOTENV_KEY: 'dotenv://:key_1234…@dotenv.org/vault/.env.vault?environment=production' })
+require("dotenv").config({
+  DOTENV_KEY:
+    "dotenv://:key_1234…@dotenv.org/vault/.env.vault?environment=production",
+});
 ```
 
 ### Parse
@@ -357,10 +358,10 @@ variables is available to use. It accepts a String or Buffer and will return
 an Object with the parsed keys and values.
 
 ```js
-const dotenv = require('dotenv')
-const buf = Buffer.from('BASIC=basic')
-const config = dotenv.parse(buf) // will return an object
-console.log(typeof config, config) // object { BASIC : 'basic' }
+const dotenv = require("dotenv");
+const buf = Buffer.from("BASIC=basic");
+const config = dotenv.parse(buf); // will return an object
+console.log(typeof config, config); // object { BASIC : 'basic' }
 ```
 
 #### Options
@@ -372,10 +373,10 @@ Default: `false`
 Turn on logging to help debug why certain keys or values are not being set as you expect.
 
 ```js
-const dotenv = require('dotenv')
-const buf = Buffer.from('hello world')
-const opt = { debug: true }
-const config = dotenv.parse(buf, opt)
+const dotenv = require("dotenv");
+const buf = Buffer.from("hello world");
+const opt = { debug: true };
+const config = dotenv.parse(buf, opt);
 // expect a debug message because the buffer is not in KEY=VAL form
 ```
 
@@ -386,24 +387,24 @@ The engine which populates the contents of your .env file to `process.env` is av
 For example, customizing the source:
 
 ```js
-const dotenv = require('dotenv')
-const parsed = { HELLO: 'world' }
+const dotenv = require("dotenv");
+const parsed = { HELLO: "world" };
 
-dotenv.populate(process.env, parsed)
+dotenv.populate(process.env, parsed);
 
-console.log(process.env.HELLO) // world
+console.log(process.env.HELLO); // world
 ```
 
 For example, customizing the source AND target:
 
 ```js
-const dotenv = require('dotenv')
-const parsed = { HELLO: 'universe' }
-const target = { HELLO: 'world' } // empty object
+const dotenv = require("dotenv");
+const parsed = { HELLO: "universe" };
+const target = { HELLO: "world" }; // empty object
 
-dotenv.populate(target, parsed, { override: true, debug: true })
+dotenv.populate(target, parsed, { override: true, debug: true });
 
-console.log(target) // { HELLO: 'universe' }
+console.log(target); // { HELLO: 'universe' }
 ```
 
 #### options
@@ -427,13 +428,15 @@ The engine which decrypts the ciphertext contents of your .env.vault file is ava
 For example, decrypting a simple ciphertext:
 
 ```js
-const dotenv = require('dotenv')
-const ciphertext = 's7NYXa809k/bVSPwIAmJhPJmEGTtU0hG58hOZy7I0ix6y5HP8LsHBsZCYC/gw5DDFy5DgOcyd18R'
-const decryptionKey = 'ddcaa26504cd70a6fef9801901c3981538563a1767c297cb8416e8a38c62fe00'
+const dotenv = require("dotenv");
+const ciphertext =
+  "s7NYXa809k/bVSPwIAmJhPJmEGTtU0hG58hOZy7I0ix6y5HP8LsHBsZCYC/gw5DDFy5DgOcyd18R";
+const decryptionKey =
+  "ddcaa26504cd70a6fef9801901c3981538563a1767c297cb8416e8a38c62fe00";
 
-const decrypted = dotenv.decrypt(ciphertext, decryptionKey)
+const decrypted = dotenv.decrypt(ciphertext, decryptionKey);
 
-console.log(decrypted) // # development@v6\nALPHA="zeta"
+console.log(decrypted); // # development@v6\nALPHA="zeta"
 ```
 
 ## ❓ FAQ
@@ -445,7 +448,7 @@ Most likely your `.env` file is not in the correct place. [See this stack overfl
 Turn on debug mode and try again..
 
 ```js
-require('dotenv').config({ debug: true })
+require("dotenv").config({ debug: true });
 ```
 
 You will receive a helpful error outputted to your console.
@@ -494,7 +497,7 @@ By default, we will never modify any environment variables that have already bee
 If instead, you want to override `process.env` use the `override` option.
 
 ```javascript
-require('dotenv').config({ override: true })
+require("dotenv").config({ override: true });
 ```
 
 ### How come my environment variables are not showing up for React?
@@ -510,10 +513,10 @@ If you are using other frameworks (e.g. Next.js, Gatsby...), you need to consult
 Yes! `dotenv.config()` returns an object representing the parsed `.env` file. This gives you everything you need to continue setting values on `process.env`. For example:
 
 ```js
-const dotenv = require('dotenv')
-const variableExpansion = require('dotenv-expand')
-const myEnv = dotenv.config()
-variableExpansion(myEnv)
+const dotenv = require("dotenv");
+const variableExpansion = require("dotenv-expand");
+const myEnv = dotenv.config();
+variableExpansion(myEnv);
 ```
 
 ### How do I use dotenv with `import`?
@@ -522,8 +525,8 @@ Simply..
 
 ```javascript
 // index.mjs (ESM)
-import 'dotenv/config' // see https://github.com/motdotla/dotenv#how-do-i-use-dotenv-with-import
-import express from 'express'
+import "dotenv/config"; // see https://github.com/motdotla/dotenv#how-do-i-use-dotenv-with-import
+import express from "express";
 ```
 
 A little background..
@@ -535,19 +538,22 @@ A little background..
 What does this mean in plain language? It means you would think the following would work but it won't.
 
 `errorReporter.mjs`:
+
 ```js
-import { Client } from 'best-error-reporting-service'
+import { Client } from "best-error-reporting-service";
 
-export default new Client(process.env.API_KEY)
+export default new Client(process.env.API_KEY);
 ```
+
 `index.mjs`:
+
 ```js
 // Note: this is INCORRECT and will not work
-import * as dotenv from 'dotenv'
-dotenv.config()
+import * as dotenv from "dotenv";
+dotenv.config();
 
-import errorReporter from './errorReporter.mjs'
-errorReporter.report(new Error('documented example'))
+import errorReporter from "./errorReporter.mjs";
+errorReporter.report(new Error("documented example"));
 ```
 
 `process.env.API_KEY` will be blank.
@@ -555,10 +561,10 @@ errorReporter.report(new Error('documented example'))
 Instead, `index.mjs` should be written as..
 
 ```js
-import 'dotenv/config'
+import "dotenv/config";
 
-import errorReporter from './errorReporter.mjs'
-errorReporter.report(new Error('documented example'))
+import errorReporter from "./errorReporter.mjs";
+errorReporter.report(new Error("documented example"));
 ```
 
 Does that make sense? It's a bit unintuitive, but it is how importing of ES6 modules work. Here is a [working example of this pitfall](https://github.com/dotenv-org/examples/tree/master/dotenv-es6-import-pitfall).
@@ -579,28 +585,28 @@ npm install node-polyfill-webpack-plugin
 Configure your `webpack.config.js` to something like the following.
 
 ```js
-require('dotenv').config()
+require("dotenv").config();
 
-const path = require('path');
-const webpack = require('webpack')
+const path = require("path");
+const webpack = require("webpack");
 
-const NodePolyfillPlugin = require('node-polyfill-webpack-plugin')
+const NodePolyfillPlugin = require("node-polyfill-webpack-plugin");
 
 module.exports = {
-  mode: 'development',
-  entry: './src/index.ts',
+  mode: "development",
+  entry: "./src/index.ts",
   output: {
-    filename: 'bundle.js',
-    path: path.resolve(__dirname, 'dist'),
+    filename: "bundle.js",
+    path: path.resolve(__dirname, "dist"),
   },
   plugins: [
     new NodePolyfillPlugin(),
     new webpack.DefinePlugin({
-      'process.env': {
-        HELLO: JSON.stringify(process.env.HELLO)
-      }
+      "process.env": {
+        HELLO: JSON.stringify(process.env.HELLO),
+      },
     }),
-  ]
+  ],
 };
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wrap-env",
-  "version": "16.3.2",
+  "version": "16.3.4",
   "description": "Loads environment variables from .env file",
   "main": "lib/main.js",
   "types": "lib/main.d.ts",
@@ -13,6 +13,7 @@
     "./config": "./config.js",
     "./config.js": "./config.js",
     "./lib/env-options": "./lib/env-options.js",
+    "./lib/sys.env": "./lib/sys.env.js",
     "./lib/env-options.js": "./lib/env-options.js",
     "./lib/cli-options": "./lib/cli-options.js",
     "./lib/cli-options.js": "./lib/cli-options.js",

package/README-es.md

@@ -1 +0,0 @@
-This package is an wrap of `dotenv`