市场夺宝奇兵
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

405 lines
15 KiB

  1. <div align="center">
  2. 🎉 announcing <a href="https://github.com/dotenvx/dotenvx">dotenvx</a>. <em>run anywhere, multi-environment, encrypted envs</em>.
  3. </div>
  4. &nbsp;
  5. <div align="center">
  6. **Special thanks to [our sponsors](https://github.com/sponsors/motdotla)**
  7. <a href="https://tuple.app/dotenv">
  8. <div>
  9. <img src="https://res.cloudinary.com/dotenv-org/image/upload/w_1000,ar_16:9,c_fill,g_auto,e_sharpen/v1756831704/github_repo_sponsorship_gq4hvx.png" width="600" alt="Tuple">
  10. </div>
  11. <b>Tuple, the premier screen sharing app for developers on macOS and Windows.</b>
  12. </a>
  13. <hr>
  14. </div>
  15. # dotenv [![NPM version](https://img.shields.io/npm/v/dotenv.svg?style=flat-square)](https://www.npmjs.com/package/dotenv)
  16. <img src="https://raw.githubusercontent.com/motdotla/dotenv/master/dotenv.svg" alt="dotenv" align="right" width="200" />
  17. 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).
  18. [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
  19. [![LICENSE](https://img.shields.io/github/license/motdotla/dotenv.svg)](LICENSE)
  20. ## Instalación
  21. ```bash
  22. # instalación local (recomendado)
  23. npm install dotenv --save
  24. ```
  25. O installación con yarn? `yarn add dotenv`
  26. ## Uso
  27. Cree un archivo `.env` en la raíz de su proyecto:
  28. ```dosini
  29. S3_BUCKET="YOURS3BUCKET"
  30. SECRET_KEY="YOURSECRETKEYGOESHERE"
  31. ```
  32. Tan prónto como sea posible en su aplicación, importe y configure dotenv:
  33. ```javascript
  34. require('dotenv').config()
  35. console.log(process.env) // elimine esto después que haya confirmado que esta funcionando
  36. ```
  37. .. o usa ES6?
  38. ```javascript
  39. import * as dotenv from 'dotenv' // vea en https://github.com/motdotla/dotenv#como-uso-dotenv-con-import
  40. // REVISAR LINK DE REFERENCIA DE IMPORTACIÓN
  41. dotenv.config()
  42. import express from 'express'
  43. ```
  44. Eso es todo. `process.env` ahora tiene las claves y los valores que definiste en tu archivo `.env`:
  45. ```javascript
  46. require('dotenv').config()
  47. ...
  48. s3.getBucketCors({Bucket: process.env.S3_BUCKET}, function(err, data) {})
  49. ```
  50. ### Valores multilínea
  51. 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:
  52. ```dosini
  53. PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
  54. ...
  55. Kh9NV...
  56. ...
  57. -----END RSA PRIVATE KEY-----"
  58. ```
  59. Alternativamente, puede usar comillas dobles y usar el carácter `\n`:
  60. ```dosini
  61. PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nKh9NV...\n-----END RSA PRIVATE KEY-----\n"
  62. ```
  63. ### Comentarios
  64. Los comentarios pueden ser agregados en tu archivo o en la misma línea:
  65. ```dosini
  66. # This is a comment
  67. SECRET_KEY=YOURSECRETKEYGOESHERE # comment
  68. SECRET_HASH="something-with-a-#-hash"
  69. ```
  70. 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.
  71. ### Análisis
  72. 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.
  73. ```javascript
  74. const dotenv = require('dotenv')
  75. const buf = Buffer.from('BASICO=basico')
  76. const config = dotenv.parse(buf) // devolverá un objeto
  77. console.log(typeof config, config) // objeto { BASICO : 'basico' }
  78. ```
  79. ### Precarga
  80. 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.
  81. ```bash
  82. $ node -r dotenv/config tu_script.js
  83. ```
  84. Las opciones de configuración a continuación se admiten como argumentos de línea de comandos en el formato `dotenv_config_<option>=value`
  85. ```bash
  86. $ node -r dotenv/config tu_script.js dotenv_config_path=/custom/path/to/.env dotenv_config_debug=true
  87. ```
  88. Además, puede usar variables de entorno para establecer opciones de configuración. Los argumentos de línea de comandos precederán a estos.
  89. ```bash
  90. $ DOTENV_CONFIG_<OPTION>=value node -r dotenv/config tu_script.js
  91. ```
  92. ```bash
  93. $ DOTENV_CONFIG_ENCODING=latin1 DOTENV_CONFIG_DEBUG=true node -r dotenv/config tu_script.js dotenv_config_path=/custom/path/to/.env
  94. ```
  95. ### Expansión Variable
  96. Necesitaras agregar el valor de otro variable en una de sus variables? Usa [dotenv-expand](https://github.com/motdotla/dotenv-expand).
  97. ## Ejemplos
  98. Vea [ejemplos](https://github.com/dotenv-org/examples) sobre el uso de dotenv con varios frameworks, lenguajes y configuraciones.
  99. * [nodejs](https://github.com/dotenv-org/examples/tree/master/dotenv-nodejs)
  100. * [nodejs (depurar en)](https://github.com/dotenv-org/examples/tree/master/dotenv-nodejs-debug)
  101. * [nodejs (anular en)](https://github.com/dotenv-org/examples/tree/master/dotenv-nodejs-override)
  102. * [esm](https://github.com/dotenv-org/examples/tree/master/dotenv-esm)
  103. * [esm (precarga)](https://github.com/dotenv-org/examples/tree/master/dotenv-esm-preload)
  104. * [typescript](https://github.com/dotenv-org/examples/tree/master/dotenv-typescript)
  105. * [typescript parse](https://github.com/dotenv-org/examples/tree/master/dotenv-typescript-parse)
  106. * [typescript config](https://github.com/dotenv-org/examples/tree/master/dotenv-typescript-config)
  107. * [webpack](https://github.com/dotenv-org/examples/tree/master/dotenv-webpack)
  108. * [webpack (plugin)](https://github.com/dotenv-org/examples/tree/master/dotenv-webpack2)
  109. * [react](https://github.com/dotenv-org/examples/tree/master/dotenv-react)
  110. * [react (typescript)](https://github.com/dotenv-org/examples/tree/master/dotenv-react-typescript)
  111. * [express](https://github.com/dotenv-org/examples/tree/master/dotenv-express)
  112. * [nestjs](https://github.com/dotenv-org/examples/tree/master/dotenv-nestjs)
  113. ## Documentación
  114. Dotenv expone dos funciones:
  115. * `configuración`
  116. * `analizar`
  117. ### Configuración
  118. `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),
  119. y devolverá un Objeto con una clave `parsed` que contiene el contenido cargado o una clave `error` si falla.
  120. ```js
  121. const result = dotenv.config()
  122. if (result.error) {
  123. throw result.error
  124. }
  125. console.log(result.parsed)
  126. ```
  127. Adicionalmente, puede pasar opciones a `configuracion`.
  128. #### Opciones
  129. ##### Ruta
  130. Por defecto: `path.resolve(process.cwd(), '.env')`
  131. Especifique una ruta personalizada si el archivo que contiene las variables de entorno se encuentra localizado en otro lugar.
  132. ```js
  133. require('dotenv').config({ path: '/personalizado/ruta/a/.env' })
  134. ```
  135. ##### Codificación
  136. Por defecto: `utf8`
  137. Especifique la codificación del archivo que contiene las variables de entorno.
  138. ```js
  139. require('dotenv').config({ encoding: 'latin1' })
  140. ```
  141. ##### Depurar
  142. Por defecto: `false`
  143. Active el registro de ayuda para depurar por qué ciertas claves o valores no se inician como lo esperabas.
  144. ```js
  145. require('dotenv').config({ debug: process.env.DEBUG })
  146. ```
  147. ##### Anular
  148. Por defecto: `false`
  149. Anule cualquier variable de entorno que ya se haya configurada en su maquina con los valores de su archivo .env.
  150. ```js
  151. require('dotenv').config({ override: true })
  152. ```
  153. ### Analizar
  154. 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.
  155. ```js
  156. const dotenv = require('dotenv')
  157. const buf = Buffer.from('BASICO=basico')
  158. const config = dotenv.parse(buf) // devolverá un objeto
  159. console.log(typeof config, config) // objeto { BASICO : 'basico' }
  160. ```
  161. #### Opciones
  162. ##### Depurar
  163. Por defecto: `false`
  164. Active el registro de ayuda para depurar por qué ciertas claves o valores no se inician como lo esperabas.
  165. ```js
  166. const dotenv = require('dotenv')
  167. const buf = Buffer.from('hola mundo')
  168. const opt = { debug: true }
  169. const config = dotenv.parse(buf, opt)
  170. // espere por un mensaje de depuración porque el búfer no esta listo KEY=VAL
  171. ```
  172. ## FAQ
  173. ### ¿Por qué el archivo `.env` no carga mis variables de entorno correctamente?
  174. 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).
  175. Active el modo de depuración y vuelva a intentarlo...
  176. ```js
  177. require('dotenv').config({ debug: true })
  178. ```
  179. Recibirá un error apropiado en su consola.
  180. ### ¿Debo confirmar mi archivo `.env`?
  181. 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.
  182. ### ¿Debería tener multiples archivos `.env`?
  183. 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.
  184. > 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.
  185. >
  186. > – [La Apliación de los Doce Factores](https://12factor.net/es/)
  187. ### ¿Qué reglas sigue el motor de análisis?
  188. El motor de análisis actualmente admite las siguientes reglas:
  189. - `BASICO=basico` se convierte en `{BASICO: 'basico'}`
  190. - las líneas vacías se saltan
  191. - las líneas que comienzan con `#` se tratan como comentarios
  192. - `#` marca el comienzo de un comentario (a menos que el valor esté entre comillas)
  193. - valores vacíos se convierten en cadenas vacías (`VACIO=` se convierte en `{VACIO: ''}`)
  194. - las comillas internas se mantienen (piensa en JSON) (`JSON={"foo": "bar"}` se convierte en `{JSON:"{\"foo\": \"bar\"}"`)
  195. - 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'}`)
  196. - los valores entre comillas simples y dobles se escapan (`CITA_SIMPLE='citado'` se convierte en `{CITA_SIMPLE: "citado"}`)
  197. - los valores entre comillas simples y dobles mantienen los espacios en blanco en ambos extremos (`FOO=" algo "` se convierte en `{FOO: ' algo '}`)
  198. - los valores entre comillas dobles expanden nuevas líneas (`MULTILINEA="nueva\nlínea"` se convierte en
  199. ```
  200. {MULTILINEA: 'nueva
  201. línea'}
  202. ```
  203. - se admite la comilla simple invertida (`` SIGNO_ACENTO=`Esto tiene comillas 'simples' y "dobles" en su interior.` ``)
  204. ### ¿Qué sucede con las variables de entorno que ya estaban configuradas?
  205. 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á.
  206. Si por el contrario, quieres anular `process.env` utiliza la opción `override`.
  207. ```javascript
  208. require('dotenv').config({ override: true })
  209. ```
  210. ### ¿Por qué mis variables de entorno no aparecen para React?
  211. 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.
  212. 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.
  213. 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.
  214. ### ¿Puedo personalizar/escribir plugins para dotenv?
  215. 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:
  216. ```js
  217. const dotenv = require('dotenv')
  218. const variableExpansion = require('dotenv-expand')
  219. const miEnv = dotenv.config()
  220. variableExpansion(miEnv)
  221. ```
  222. ### Cómo uso dotnev con `import`?
  223. Simplemente..
  224. ```javascript
  225. // index.mjs (ESM)
  226. import * as dotenv from 'dotenv' // vea https://github.com/motdotla/dotenv#como-uso-dotenv-con-import
  227. dotenv.config()
  228. import express from 'express'
  229. ```
  230. Un poco de historia...
  231. > 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.
  232. >
  233. > – [ES6 en Profundidad: Módulos](https://hacks.mozilla.org/2015/08/es6-in-depth-modules/)
  234. ¿Qué significa esto en lenguaje sencillo? Significa que se podrías pensar que lo siguiente funcionaría pero no lo hará.
  235. ```js
  236. // notificarError.mjs
  237. import { Cliente } from 'mejor-servicio-para-notificar-error'
  238. export default new Client(process.env.CLAVE_API)
  239. // index.mjs
  240. import dotenv from 'dotenv'
  241. dotenv.config()
  242. import notificarError from './notificarError.mjs'
  243. notificarError.report(new Error('ejemplo documentado'))
  244. ```
  245. `process.env.CLAVE_API` será vacio.
  246. En su lugar, el código anterior debe ser escrito como...
  247. ```js
  248. // notificarError.mjs
  249. import { Cliente } from 'mejor-servicio-para-notificar-errores'
  250. export default new Client(process.env.CLAVE_API)
  251. // index.mjs
  252. import * as dotenv from 'dotenv'
  253. dotenv.config()
  254. import notificarError from './notificarError.mjs'
  255. notificarError.report(new Error('ejemplo documentado'))
  256. ```
  257. ¿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).
  258. Existen dos arternativas a este planteamiento:
  259. 1. Precarga dotenv: `node --require dotenv/config index.js` (_Nota: no es necesario usar `import` dotenv con este método_)
  260. 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)
  261. ### ¿Qué pasa con la expansión de variable?
  262. Prueba [dotenv-expand](https://github.com/motdotla/dotenv-expand)
  263. ## Guía de contribución
  264. Vea [CONTRIBUTING.md](CONTRIBUTING.md)
  265. ## REGISTRO DE CAMBIOS
  266. Vea [CHANGELOG.md](CHANGELOG.md)
  267. ## ¿Quiénes utilizan dotenv?
  268. [Estos módulos npm dependen de él.](https://www.npmjs.com/browse/depended/dotenv)
  269. Los proyectos que lo amplían suelen utilizar la [palabra clave "dotenv" en npm](https://www.npmjs.com/search?q=keywords:dotenv).