npm - wrap-env - Versions diffs - 16.3.1 → 16.3.3 - Mend

wrap-env 16.3.1 → 16.3.3

Files changed (3) hide show

package/README.md CHANGED Viewed

@@ -1,633 +1 @@
-<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>
-  <b>Warp is a blazingly fast, Rust-based terminal reimagined to work like a modern app.</b>
-  <div>
-    <sup>Get more done in the CLI with real text editing, block-based output, and AI command search.</sup>
-  </div>
-</a>
-<br>
-<a href="https://retool.com/?utm_source=sponsor&utm_campaign=dotenv">
-  <div>
-    <img src="https://res.cloudinary.com/dotenv-org/image/upload/c_scale,w_300/v1664466968/logo-full-black_vidfqf.png" width="270" alt="Retool">
-  </div>
-  <b>Retool helps developers build custom internal software, like CRUD apps and admin panels, really fast.</b>
-  <div>
-    <sup>Build UIs visually with flexible components, connect to any data source, and write business logic in JavaScript.</sup>
-  </div>
-</a>
-<br>
-<a href="https://workos.com/?utm_campaign=github_repo&utm_medium=referral&utm_content=dotenv&utm_source=github">
-  <div>
-    <img src="https://res.cloudinary.com/dotenv-org/image/upload/c_scale,w_400/v1665605496/68747470733a2f2f73696e647265736f726875732e636f6d2f6173736574732f7468616e6b732f776f726b6f732d6c6f676f2d77686974652d62672e737667_zdmsbu.svg" width="270" alt="WorkOS">
-  </div>
-  <b>Your App, Enterprise Ready.</b>
-  <div>
-    <sup>Add Single Sign-On, Multi-Factor Auth, and more, in minutes instead of months.</sup>
-  </div>
-</a>
-<hr>
-</div>
-# dotenv [![NPM version](https://img.shields.io/npm/v/dotenv.svg?style=flat-square)](https://www.npmjs.com/package/dotenv)
-<img src="https://raw.githubusercontent.com/motdotla/dotenv/master/dotenv.svg" alt="dotenv" align="right" width="200" />
-Dotenv is a zero-dependency module that loads environment variables from a `.env` file into [`process.env`](https://nodejs.org/docs/latest/api/process.html#process_process_env). Storing configuration in the environment separate from code is based on [The Twelve-Factor App](http://12factor.net/config) methodology.
-[![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)
-* [🌱 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
-```bash
-# install locally (recommended)
-npm install dotenv --save
-```
-Or installing with yarn? `yarn add dotenv`
-## 🏗️ Usage
-<a href="https://www.youtube.com/watch?v=YtkZR0NFd1g">
-<div align="right">
-<img src="https://img.youtube.com/vi/YtkZR0NFd1g/hqdefault.jpg" alt="how to use dotenv video tutorial" align="right" width="330" />
-<img src="https://simpleicons.vercel.app/youtube/ff0000" alt="youtube/@dotenvorg" align="right" width="24" />
-</div>
-</a>
-Create a `.env` file in the root of your project:
-```dosini
-S3_BUCKET="YOURS3BUCKET"
-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
-```
-.. [or using ES6?](#how-do-i-use-dotenv-with-import)
-```javascript
-import 'dotenv/config'
-```
-That's it. `process.env` now has the keys and values you defined in your `.env` file:
-```javascript
-require('dotenv').config()
-...
-s3.getBucketCors({Bucket: process.env.S3_BUCKET}, function(err, data) {})
-```
-### Multiline values
-If you need multiline variables, for example private keys, those are now supported (`>= v15.0.0`) with line breaks:
-```dosini
-PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
-...
-Kh9NV...
-...
------END RSA PRIVATE KEY-----"
-```
-Alternatively, you can double quote strings and use the `\n` character:
-```dosini
-PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nKh9NV...\n-----END RSA PRIVATE KEY-----\n"
-```
-### Comments
-Comments may be added to your file on their own line or inline:
-```dosini
-# This is a comment
-SECRET_KEY=YOURSECRETKEYGOESHERE # comment
-SECRET_HASH="something-with-a-#-hash"
-```
-Comments begin where a `#` exists, so if your value contains a `#` please wrap it in quotes. This is a breaking change from `>= v15.0.0` and on.
-### Parsing
-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' }
-```
-### Preload
-You can use the `--require` (`-r`) [command line option](https://nodejs.org/api/cli.html#-r---require-module) to preload dotenv. By doing this, you do not need to require and load dotenv in your application code.
-```bash
-$ node -r dotenv/config your_script.js
-```
-The configuration options below are supported as command line arguments in the format `dotenv_config_<option>=value`
-```bash
-$ node -r dotenv/config your_script.js dotenv_config_path=/custom/path/to/.env dotenv_config_debug=true
-```
-Additionally, you can use environment variables to set configuration options. Command line arguments will precede these.
-```bash
-$ DOTENV_CONFIG_<OPTION>=value node -r dotenv/config your_script.js
-```
-```bash
-$ DOTENV_CONFIG_ENCODING=latin1 DOTENV_CONFIG_DEBUG=true node -r dotenv/config your_script.js dotenv_config_path=/custom/path/to/.env
-```
-### Variable Expansion
-You need to add the value of another variable in one of your variables? Use [dotenv-expand](https://github.com/motdotla/dotenv-expand).
-### Syncing
-You need to keep `.env` files in sync between machines, environments, or team members? Use [dotenv-vault](https://github.com/dotenv-org/dotenv-vault).
-### Deploying
-You need to deploy your secrets in a cloud-agnostic manner? Use a `.env.vault` file.
-### Multiple Environments
-You need to manage your secrets across different environments and apply them as needed? Use a `.env.vault` file with a `DOTENV_KEY`.
-## 🚀 Deploying
-*Note: Requires dotenv >= 16.1.0*
-Encrypt your `.env.vault` file.
-```bash
-$ npx dotenv-vault build
-```
-Fetch your production `DOTENV_KEY`.
-```bash
-$ npx dotenv-vault keys production
-```
-Set `DOTENV_KEY` on your server.
-```bash
-# heroku example
-heroku config:set DOTENV_KEY=dotenv://:key_1234…@dotenv.org/vault/.env.vault?environment=production
-```
-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 href="https://github.com/dotenv-org/dotenv-vault#dotenv-vault-">Learn more at dotenv-vault: Deploying</a>
-## 🌴 Manage Multiple Environments
-Edit your production environment variables.
-```bash
-$ npx dotenv-vault open production
-```
-Regenerate your `.env.vault` file.
-```bash
-$ 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.*
-<a href="https://github.com/dotenv-org/dotenv-vault#-manage-multiple-environments">Learn more at dotenv-vault: Manage Multiple Environments</a>
-## 📚 Examples
-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)
-## 📖 Documentation
-Dotenv exposes four functions:
-* `config`
-* `parse`
-* `populate`
-* `decrypt`
-### Config
-`config` will read your `.env` file, parse the contents, assign it to
-[`process.env`](https://nodejs.org/docs/latest/api/process.html#process_process_env),
-and return an Object with a `parsed` key containing the loaded content or an `error` key if it failed.
-```js
-const result = dotenv.config()
-if (result.error) {
-  throw result.error
-}
-console.log(result.parsed)
-```
-You can additionally, pass options to `config`.
-#### Options
-##### path
-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' })
-```
-##### encoding
-Default: `utf8`
-Specify the encoding of your file containing environment variables.
-```js
-require('dotenv').config({ encoding: 'latin1' })
-```
-##### debug
-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 })
-```
-##### override
-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 })
-```
-##### processEnv
-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 })
-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
-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' })
-```
-### Parse
-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.
-```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' }
-```
-#### Options
-##### debug
-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)
-// expect a debug message because the buffer is not in KEY=VAL form
-```
-### Populate
-The engine which populates the contents of your .env file to `process.env` is available for use. It accepts a target, a source, and options. This is useful for power users who want to supply their own objects.
-For example, customizing the source:
-```js
-const dotenv = require('dotenv')
-const parsed = { HELLO: 'world' }
-dotenv.populate(process.env, parsed)
-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
-dotenv.populate(target, parsed, { override: true, debug: true })
-console.log(target) // { HELLO: 'universe' }
-```
-#### options
-##### Debug
-Default: `false`
-Turn on logging to help debug why certain keys or values are not being populated as you expect.
-##### override
-Default: `false`
-Override any environment variables that have already been set.
-### Decrypt
-The engine which decrypts the ciphertext contents of your .env.vault file is available for use. It accepts a ciphertext and a decryption key. It uses AES-256-GCM encryption.
-For example, decrypting a simple ciphertext:
-```js
-const dotenv = require('dotenv')
-const ciphertext = 's7NYXa809k/bVSPwIAmJhPJmEGTtU0hG58hOZy7I0ix6y5HP8LsHBsZCYC/gw5DDFy5DgOcyd18R'
-const decryptionKey = 'ddcaa26504cd70a6fef9801901c3981538563a1767c297cb8416e8a38c62fe00'
-const decrypted = dotenv.decrypt(ciphertext, decryptionKey)
-console.log(decrypted) // # development@v6\nALPHA="zeta"
-```
-## ❓ FAQ
-### Why is the `.env` file not loading my environment variables successfully?
-Most likely your `.env` file is not in the correct place. [See this stack overflow](https://stackoverflow.com/questions/42335016/dotenv-file-is-not-loading-environment-variables).
-Turn on debug mode and try again..
-```js
-require('dotenv').config({ debug: true })
-```
-You will receive a helpful error outputted to your console.
-### Should I commit my `.env` file?
-No. We **strongly** recommend against committing your `.env` file to version
-control. It should only include environment-specific values such as database
-passwords or API keys. Your production database should have a different
-password than your development database.
-### Should I have multiple `.env` files?
-No. We **strongly** recommend against having a "main" `.env` file and an "environment" `.env` file like `.env.test`. Your config should vary between deploys, and you should not be sharing values between environments.
-> In a twelve-factor app, env vars are granular controls, each fully orthogonal to other env vars. They are never grouped together as “environments”, but instead are independently managed for each deploy. This is a model that scales up smoothly as the app naturally expands into more deploys over its lifetime.
->
-> – [The Twelve-Factor App](http://12factor.net/config)
-### What rules does the parsing engine follow?
-The parsing engine currently supports the following rules:
-- `BASIC=basic` becomes `{BASIC: 'basic'}`
-- empty lines are skipped
-- lines beginning with `#` are treated as comments
-- `#` marks the beginning of a comment (unless when the value is wrapped in quotes)
-- empty values become empty strings (`EMPTY=` becomes `{EMPTY: ''}`)
-- inner quotes are maintained (think JSON) (`JSON={"foo": "bar"}` becomes `{JSON:"{\"foo\": \"bar\"}"`)
-- whitespace is removed from both ends of unquoted values (see more on [`trim`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/Trim)) (`FOO=  some value  ` becomes `{FOO: 'some value'}`)
-- single and double quoted values are escaped (`SINGLE_QUOTE='quoted'` becomes `{SINGLE_QUOTE: "quoted"}`)
-- single and double quoted values maintain whitespace from both ends (`FOO="  some value  "` becomes `{FOO: '  some value  '}`)
-- double quoted values expand new lines (`MULTILINE="new\nline"` becomes
-```
-{MULTILINE: 'new
-line'}
-```
-- backticks are supported (`` BACKTICK_KEY=`This has 'single' and "double" quotes inside of it.` ``)
-### What happens to environment variables that were already set?
-By default, we will never modify any environment variables that have already been set. In particular, if there is a variable in your `.env` file which collides with one that already exists in your environment, then that variable will be skipped.
-If instead, you want to override `process.env` use the `override` option.
-```javascript
-require('dotenv').config({ override: true })
-```
-### How come my environment variables are not showing up for React?
-Your React code is run in Webpack, where the `fs` module or even the `process` global itself are not accessible out-of-the-box. `process.env` can only be injected through Webpack configuration.
-If you are using [`react-scripts`](https://www.npmjs.com/package/react-scripts), which is distributed through [`create-react-app`](https://create-react-app.dev/), it has dotenv built in but with a quirk. Preface your environment variables with `REACT_APP_`. See [this stack overflow](https://stackoverflow.com/questions/42182577/is-it-possible-to-use-dotenv-in-a-react-project) for more details.
-If you are using other frameworks (e.g. Next.js, Gatsby...), you need to consult their documentation for how to inject environment variables into the client.
-### Can I customize/write plugins for dotenv?
-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)
-```
-### How do I use dotenv with `import`?
-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'
-```
-A little background..
-> When you run a module containing an `import` declaration, the modules it imports are loaded first, then each module body is executed in a depth-first traversal of the dependency graph, avoiding cycles by skipping anything already executed.
->
-> – [ES6 In Depth: Modules](https://hacks.mozilla.org/2015/08/es6-in-depth-modules/)
-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'
-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 errorReporter from './errorReporter.mjs'
-errorReporter.report(new Error('documented example'))
-```
-`process.env.API_KEY` will be blank.
-Instead, `index.mjs` should be written as..
-```js
-import 'dotenv/config'
-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).
-There are two alternatives to this approach:
-1. Preload dotenv: `node --require dotenv/config index.js` (_Note: you do not need to `import` dotenv with this approach_)
-2. Create a separate file that will execute `config` first as outlined in [this comment on #133](https://github.com/motdotla/dotenv/issues/133#issuecomment-255298822)
-### Why am I getting the error `Module not found: Error: Can't resolve 'crypto|os|path'`?
-You are using dotenv on the front-end and have not included a polyfill. Webpack < 5 used to include these for you. Do the following:
-```bash
-npm install node-polyfill-webpack-plugin
-```
-Configure your `webpack.config.js` to something like the following.
-```js
-require('dotenv').config()
-const path = require('path');
-const webpack = require('webpack')
-const NodePolyfillPlugin = require('node-polyfill-webpack-plugin')
-module.exports = {
-  mode: 'development',
-  entry: './src/index.ts',
-  output: {
-    filename: 'bundle.js',
-    path: path.resolve(__dirname, 'dist'),
-  },
-  plugins: [
-    new NodePolyfillPlugin(),
-    new webpack.DefinePlugin({
-      'process.env': {
-        HELLO: JSON.stringify(process.env.HELLO)
-      }
-    }),
-  ]
-};
-```
-Alternatively, just use [dotenv-webpack](https://github.com/mrsteele/dotenv-webpack) which does this and more behind the scenes for you.
-### What about variable expansion?
-Try [dotenv-expand](https://github.com/motdotla/dotenv-expand)
-### What about syncing and securing .env files?
-Use [dotenv-vault](https://github.com/dotenv-org/dotenv-vault)
-### What is a `.env.vault` file?
-A `.env.vault` file is an encrypted version of your development (and ci, staging, production, etc) environment variables. It is paired with a `DOTENV_KEY` to deploy your secrets more securely than scattering them across multiple platforms and tools. Use [dotenv-vault](https://github.com/dotenv-org/dotenv-vault) to manage and generate them.
-## Contributing Guide
-See [CONTRIBUTING.md](CONTRIBUTING.md)
-## CHANGELOG
-See [CHANGELOG.md](CHANGELOG.md)
-## Who's using dotenv?
-[These npm modules depend on it.](https://www.npmjs.com/browse/depended/dotenv)
-Projects that expand it often use the [keyword "dotenv" on npm](https://www.npmjs.com/search?q=keywords:dotenv).
+This package is an wrap of `dotenv`

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "wrap-env",
-  "version": "16.3.1",
+  "version": "16.3.3",
   "description": "Loads environment variables from .env file",
   "main": "lib/main.js",
   "types": "lib/main.d.ts",

package/README-es.md DELETED Viewed

@@ -1,442 +0,0 @@
-<div align="center">
-<p>
-  <sup>
-    <a href="https://github.com/sponsors/motdotla">Dotenv es apoyado por la comunidad.</a>
-  </sup>
-</p>
-<sup>Gracias espaciales a:</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>
-  <b>Warp es una rápida e impresionante terminal basada en Rust, reinventado para funcionar como una aplicación moderna.</b>
-  <div>
-    <sup>Haga más en la CLI con edición de texto real, resultado básado en bloques, y busqueda de comandos de IA.</sup>
-  </div>
-</a>
-<br>
-<a href="https://retool.com/?utm_source=sponsor&utm_campaign=dotenv">
-  <div>
-    <img src="https://res.cloudinary.com/dotenv-org/image/upload/c_scale,w_300/v1664466968/logo-full-black_vidfqf.png" width="270" alt="Retool">
-  </div>
-  <b>Retool ayuda a los desarrolladores a crear software interno personalizado, como aplicaciones CRUD y paneles de administración, realmente rápido.</b>
-  <div>
-    <sup>Construya Interfaces de Usuario de forma visual con componentes flexibles, conéctese a cualquier fuente de datos, y escriba lógica de negocio en JavaScript.</sup>
-  </div>
-</a>
-<br>
-<a href="https://workos.com/?utm_campaign=github_repo&utm_medium=referral&utm_content=dotenv&utm_source=github">
-  <div>
-    <img src="https://res.cloudinary.com/dotenv-org/image/upload/c_scale,w_400/v1665605496/68747470733a2f2f73696e647265736f726875732e636f6d2f6173736574732f7468616e6b732f776f726b6f732d6c6f676f2d77686974652d62672e737667_zdmsbu.svg" width="270" alt="WorkOS">
-  </div>
-  <b>Su Apliación, Lista para la Empresa.</b>
-  <div>
-    <sup>Agrega Inicio de Sesión Único, Autenticación Multi-Factor, y mucho más, en minutos en lugar de meses.</sup>
-  </div>
-</a>
-<hr>
-<br>
-<br>
-<br>
-<br>
-</div>
-# dotenv [![NPM version](https://img.shields.io/npm/v/dotenv.svg?style=flat-square)](https://www.npmjs.com/package/dotenv)
-<img src="https://raw.githubusercontent.com/motdotla/dotenv/master/dotenv.svg" alt="dotenv" align="right" width="200" />
-Dotenv es un módulo de dependencia cero que carga las variables de entorno desde un archivo `.env` en [`process.env`](https://nodejs.org/docs/latest/api/process.html#process_process_env). El almacenamiento de la configuración del entorno separado del código está basado en la metodología [The Twelve-Factor App](http://12factor.net/config).
-[![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)
-## Instalación
-```bash
-# instalación local (recomendado)
-npm install dotenv --save
-```
-O installación con yarn? `yarn add dotenv`
-## Uso
-Cree un archivo `.env` en la raíz de su proyecto:
-```dosini
-S3_BUCKET="YOURS3BUCKET"
-SECRET_KEY="YOURSECRETKEYGOESHERE"
-```
-Tan prónto como sea posible en su aplicación, importe y configure dotenv:
-```javascript
-require('dotenv').config()
-console.log(process.env) // elimine esto después que haya confirmado que esta funcionando
-```
-.. o usa ES6?
-```javascript
-import * as dotenv from 'dotenv' // vea en https://github.com/motdotla/dotenv#como-uso-dotenv-con-import
-// REVISAR LINK DE REFERENCIA DE IMPORTACIÓN
-dotenv.config()
-import express from 'express'
-```
-Eso es todo. `process.env` ahora tiene las claves y los valores que definiste en tu archivo `.env`:
-```javascript
-require('dotenv').config()
-...
-s3.getBucketCors({Bucket: process.env.S3_BUCKET}, function(err, data) {})
-```
-### Valores multilínea
-Si necesita variables de varias líneas, por ejemplo, claves privadas, ahora se admiten en la versión (`>= v15.0.0`) con saltos de línea:
-```dosini
-PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
-...
-Kh9NV...
-...
------END RSA PRIVATE KEY-----"
-```
-Alternativamente, puede usar comillas dobles y usar el carácter `\n`:
-```dosini
-PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nKh9NV...\n-----END RSA PRIVATE KEY-----\n"
-```
-### Comentarios
-Los comentarios pueden ser agregados en tu archivo o en la misma línea:
-```dosini
-# This is a comment
-SECRET_KEY=YOURSECRETKEYGOESHERE # comment
-SECRET_HASH="something-with-a-#-hash"
-```
-Los comentarios comienzan donde existe un `#`, entonces, si su valor contiene un `#`, enciérrelo entre comillas. Este es un cambio importante desde la versión `>= v15.0.0` en adelante.
-### Análisis
-El motor que analiza el contenido de su archivo que contiene variables de entorno está disponible para su uso. Este Acepta una Cadena o un Búfer y devolverá un Objeto con las claves y los valores analizados.
-```javascript
-const dotenv = require('dotenv')
-const buf = Buffer.from('BASICO=basico')
-const config = dotenv.parse(buf) // devolverá un objeto
-console.log(typeof config, config) // objeto { BASICO : 'basico' }
-```
-### Precarga
-Puede usar el `--require` (`-r`) [opción de línea de comando](https://nodejs.org/api/cli.html#-r---require-module) para precargar dotenv. Al hacer esto, no necesita requerir ni cargar dotnev en el código de su aplicación.
-```bash
-$ node -r dotenv/config tu_script.js
-```
-Las opciones de configuración a continuación se admiten como argumentos de línea de comandos en el formato `dotenv_config_<option>=value`
-```bash
-$ node -r dotenv/config tu_script.js dotenv_config_path=/custom/path/to/.env dotenv_config_debug=true
-```
-Además, puede usar variables de entorno para establecer opciones de configuración. Los argumentos de línea de comandos precederán a estos.
-```bash
-$ DOTENV_CONFIG_<OPTION>=value node -r dotenv/config tu_script.js
-```
-```bash
-$ DOTENV_CONFIG_ENCODING=latin1 DOTENV_CONFIG_DEBUG=true node -r dotenv/config tu_script.js dotenv_config_path=/custom/path/to/.env
-```
-### Expansión Variable
-Necesitaras agregar el valor de otro variable en una de sus variables? Usa [dotenv-expand](https://github.com/motdotla/dotenv-expand).
-### Sincronizando
-Necesitas mentener sincronizados los archivos `.env` entre maquinas, entornos, o miembros del equipo? Usa
-[dotenv-vault](https://github.com/dotenv-org/dotenv-vault).
-## Ejemplos
-Vea [ejemplos](https://github.com/dotenv-org/examples) sobre el uso de dotenv con varios frameworks, lenguajes y configuraciones.
-* [nodejs](https://github.com/dotenv-org/examples/tree/master/dotenv-nodejs)
-* [nodejs (depurar en)](https://github.com/dotenv-org/examples/tree/master/dotenv-nodejs-debug)
-* [nodejs (anular en)](https://github.com/dotenv-org/examples/tree/master/dotenv-nodejs-override)
-* [esm](https://github.com/dotenv-org/examples/tree/master/dotenv-esm)
-* [esm (precarga)](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)
-## Documentación
-Dotenv expone dos funciones:
-* `configuración`
-* `analizar`
-### Configuración
-`Configuración` leerá su archivo `.env`, analizará el contenido, lo asignará a [`process.env`](https://nodejs.org/docs/latest/api/process.html#process_process_env),
-y devolverá un Objeto con una clave `parsed` que contiene el contenido cargado o una clave `error` si falla.
-```js
-const result = dotenv.config()
-if (result.error) {
-  throw result.error
-}
-console.log(result.parsed)
-```
-Adicionalmente, puede pasar opciones a `configuracion`.
-#### Opciones
-##### Ruta
-Por defecto: `path.resolve(process.cwd(), '.env')`
-Especifique una ruta personalizada si el archivo que contiene las variables de entorno se encuentra localizado en otro lugar.
-```js
-require('dotenv').config({ path: '/personalizado/ruta/a/.env' })
-```
-##### Codificación
-Por defecto: `utf8`
-Especifique la codificación del archivo que contiene las variables de entorno.
-```js
-require('dotenv').config({ encoding: 'latin1' })
-```
-##### Depurar
-Por defecto: `false`
-Active el registro de ayuda para depurar por qué ciertas claves o valores no se inician como lo esperabas.
-```js
-require('dotenv').config({ debug: process.env.DEBUG })
-```
-##### Anular
-Por defecto: `false`
-Anule cualquier variable de entorno que ya se haya configurada en su maquina con los valores de su archivo .env.
-```js
-require('dotenv').config({ override: true })
-```
-### Analizar
-El motor que analiza el contenido del archivo que contiene las variables de entorno está disponible para su uso. Acepta una Cadena o un Búfer y retornará un objecto con los valores analizados.
-```js
-const dotenv = require('dotenv')
-const buf = Buffer.from('BASICO=basico')
-const config = dotenv.parse(buf) // devolverá un objeto
-console.log(typeof config, config) // objeto { BASICO : 'basico' }
-```
-#### Opciones
-##### Depurar
-Por defecto: `false`
-Active el registro de ayuda para depurar por qué ciertas claves o valores no se inician como lo esperabas.
-```js
-const dotenv = require('dotenv')
-const buf = Buffer.from('hola mundo')
-const opt = { debug: true }
-const config = dotenv.parse(buf, opt)
-// espere por un mensaje de depuración porque el búfer no esta listo KEY=VAL
-```
-## FAQ
-### ¿Por qué el archivo `.env` no carga mis variables de entorno correctamente?
-Lo más probable es que su archivo `.env` no esté en el lugar correcto. [Vea este stack overflow](https://stackoverflow.com/questions/42335016/dotenv-file-is-not-loading-environment-variables).
-Active el modo de depuración y vuelva a intentarlo...
-```js
-require('dotenv').config({ debug: true })
-```
-Recibirá un error apropiado en su consola.
-### ¿Debo confirmar mi archivo `.env`?
-No. Recomendamos **enfáticamente** no enviar su archivo `.env` a la versión de control. Solo debe incluir los valores especificos del entorno, como la base de datos, contraseñas o claves API.
-### ¿Debería tener multiples archivos `.env`?
-No. Recomendamos **enfáticamente** no tener un archivo `.env` "principal" y un archivo `.env` de "entorno" como `.env.test`. Su configuración debe variar entre implementaciones y no debe compartir valores entre entornos.
-> En una Aplicación de Doce Factores, las variables de entorno son controles diferenciados, cada uno totalmente independiente a otras variables de entorno. Nunca se agrupan como "entornos", sino que se gestionan de manera independiente para cada despliegue. Este es un modelo que se escala sin problemas a medida que la aplicación se expande de forma natural en más despliegues a lo largo de su vida.
->
-> – [La Apliación de los Doce Factores](https://12factor.net/es/)
-### ¿Qué reglas sigue el motor de análisis?
-El motor de análisis actualmente admite las siguientes reglas:
-- `BASICO=basico` se convierte en `{BASICO: 'basico'}`
-- las líneas vacías se saltan
-- las líneas que comienzan con `#` se tratan como comentarios
-- `#` marca el comienzo de un comentario (a menos que el valor esté entre comillas)
-- valores vacíos se convierten en cadenas vacías (`VACIO=` se convierte en `{VACIO: ''}`)
-- las comillas internas se mantienen (piensa en JSON) (`JSON={"foo": "bar"}` se convierte en `{JSON:"{\"foo\": \"bar\"}"`)
-- los espacios en blanco se eliminan de ambos extremos de los valores no citanos (aprende más en [`trim`](https://developer.mozilla.org/es/docs/Web/JavaScript/Reference/Global_Objects/String/Trim)) (`FOO=  algo ` se convierte en `{FOO: 'algo'}`)
-- los valores entre comillas simples y dobles se escapan (`CITA_SIMPLE='citado'` se convierte en `{CITA_SIMPLE: "citado"}`)
-- los valores entre comillas simples y dobles mantienen los espacios en blanco en ambos extremos  (`FOO="  algo  "` se convierte en `{FOO: '  algo  '}`)
-- los valores entre comillas dobles expanden nuevas líneas (`MULTILINEA="nueva\nlínea"` se convierte en
-```
-{MULTILINEA: 'nueva
-línea'}
-```
-- se admite la comilla simple invertida (`` SIGNO_ACENTO=`Esto tiene comillas 'simples' y "dobles" en su interior.` ``)
-### ¿Qué sucede con las variables de entorno que ya estaban configuradas?
-Por defecto, nunca modificaremos ninguna variable de entorno que ya haya sido establecida. En particular, si hay una variable en su archivo `.env` que colisiona con una que ya existe en su entorno, entonces esa variable se omitirá.
-Si por el contrario, quieres anular `process.env` utiliza la opción `override`.
-```javascript
-require('dotenv').config({ override: true })
-```
-### ¿Por qué mis variables de entorno no aparecen para React?
-Su código React se ejecuta en Webpack, donde el módulo `fs` o incluso el propio `process` global no son accesibles fuera-de-la-caja. El módulo `process.env` sólo puede ser inyectado a través de la configuración de Webpack.
-Si estás usando [`react-scripts`](https://www.npmjs.com/package/react-scripts), el cual se distribuye a través de [`create-react-app`](https://create-react-app.dev/), tiene dotenv incorporado pero con una singularidad. Escriba sus variables de entorno con `REACT_APP_`. Vea [este stack overflow](https://stackoverflow.com/questions/42182577/is-it-possible-to-use-dotenv-in-a-react-project) para más detalles.
-Si estás utilizando otros frameworks (por ejemplo, Next.js, Gatsby...), debes consultar su documentación para saber cómo injectar variables de entorno en el cliente.
-### ¿Puedo personalizar/escribir plugins para dotenv?
-Sí! `dotenv.config()` devuelve un objeto que representa el archivo `.env` analizado. Esto te da todo lo que necesitas para poder establecer valores en `process.env`. Por ejemplo:
-```js
-const dotenv = require('dotenv')
-const variableExpansion = require('dotenv-expand')
-const miEnv = dotenv.config()
-variableExpansion(miEnv)
-```
-### Cómo uso dotnev con `import`?
-Simplemente..
-```javascript
-// index.mjs (ESM)
-import * as dotenv from 'dotenv' // vea https://github.com/motdotla/dotenv#como-uso-dotenv-con-import
-dotenv.config()
-import express from 'express'
-```
-Un poco de historia...
-> Cuando se ejecuta un módulo que contiene una sentencia `import`, los módulos que importa serán cargados primero, y luego se ejecuta cada bloque del módulo en un recorrido en profundidad del gráfico de dependencias, evitando los ciclos al saltarse todo lo que ya se ha ejecutado.
->
-> – [ES6 en Profundidad: Módulos](https://hacks.mozilla.org/2015/08/es6-in-depth-modules/)
-¿Qué significa esto en lenguaje sencillo? Significa que se podrías pensar que lo siguiente funcionaría pero no lo hará.
-```js
-// notificarError.mjs
-import { Cliente } from 'mejor-servicio-para-notificar-error'
-export default new Client(process.env.CLAVE_API)
-// index.mjs
-import dotenv from 'dotenv'
-dotenv.config()
-import notificarError from './notificarError.mjs'
-notificarError.report(new Error('ejemplo documentado'))
-```
-`process.env.CLAVE_API` será vacio.
-En su lugar, el código anterior debe ser escrito como...
-```js
-// notificarError.mjs
-import { Cliente } from 'mejor-servicio-para-notificar-errores'
-export default new Client(process.env.CLAVE_API)
-// index.mjs
-import * as dotenv from 'dotenv'
-dotenv.config()
-import notificarError from './notificarError.mjs'
-notificarError.report(new Error('ejemplo documentado'))
-```
-¿Esto tiene algo de sentido? Esto es poco poco intuitivo, pero es como funciona la importación de módulos en ES6. Aquí hay un ejemplo [ejemplo práctico de esta trampa](https://github.com/dotenv-org/examples/tree/master/dotenv-es6-import-pitfall).
-Existen dos arternativas a este planteamiento:
-1. Precarga dotenv: `node --require dotenv/config index.js` (_Nota: no es necesario usar `import` dotenv con este método_)
-2. Cree un archivo separado que ejecutará `config` primero como se describe en [este comentario #133](https://github.com/motdotla/dotenv/issues/133#issuecomment-255298822)
-### ¿Qué pasa con la expansión de variable?
-Prueba [dotenv-expand](https://github.com/motdotla/dotenv-expand)
-### ¿Qué pasa con la sincronización y la seguridad de los archivos .env?
-Vea [dotenv-vault](https://github.com/dotenv-org/dotenv-vault)
-## Guía de contribución
-Vea [CONTRIBUTING.md](CONTRIBUTING.md)
-## REGISTRO DE CAMBIOS
-Vea [CHANGELOG.md](CHANGELOG.md)
-## ¿Quiénes utilizan dotenv?
-[Estos módulos npm dependen de él.](https://www.npmjs.com/browse/depended/dotenv)
-Los proyectos que lo amplían suelen utilizar la [palabra clave "dotenv" en npm](https://www.npmjs.com/search?q=keywords:dotenv).