Loads your .env file into your application context
Clone or download
ricardogobbosouza and JulienTant Merge options correctly (#22)
* Merge options correctly

* add tests
Latest commit a3e1d80 Oct 19, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci first commit Sep 23, 2017
.github Create ISSUE_TEMPLATE.md Mar 28, 2018
src Merge options correctly (#22) Oct 19, 2018
test Merge options correctly (#22) Oct 19, 2018
.editorconfig first commit Sep 23, 2017
.eslintrc.js first commit Sep 23, 2017
.gitignore first commit Sep 23, 2017
CHANGELOG.md bump 1.3.0 Oct 13, 2018
LICENSE first commit Sep 23, 2017
README.md Move explanation of path to proper location (#21) Oct 17, 2018
package-lock.json bump 1.3.0 Oct 13, 2018
package.json bump 1.3.0 Oct 13, 2018
yarn.lock bump 1.2.1 Oct 13, 2018

README.md

@nuxtjs/dotenv module

npm (scoped with tag) npm CircleCI Codecov Dependencies

js-standard-style

A nuxt.js module that loads your .env file into your context options

📖 Release Notes

Features

The module loads variables from your .env file directly into your nuxt.js application context and process.env.

Setup

  • Add @nuxtjs/dotenv dependency using yarn or npm to your project
  • Add @nuxtjs/dotenv to modules section of nuxt.config.js
{
  modules: [
    // Simple usage
    '@nuxtjs/dotenv',

    // With options
    ['@nuxtjs/dotenv', { /* module options */ }],
 ]
}

Usage

After creating your .env file in the project root, simply run your usual npm run dev. The variable inside the .env file will be added to the context (context.env) and process (process.env)

Options

only

If you want to restrict what's accessible into the context, you can can pass to the module options an only array with the keys you want to allow.

{
  modules: [
    ['@nuxtjs/dotenv', { only: ['some_key'] }],
  ]
}

path

By default, the we'll be loading the .env file from the root of your project. If you want to change the path of the folder where we can find the .env file, then use the path option.

{
  modules: [
    ['@nuxtjs/dotenv', { path: '/path/to/my/global/env/' }],
  ]
}

Note that this is the path to the folder where the .env file live, not to the .env file itself.

The path can be absolute or relative.

systemvars

By default this is false and variables from your system will be ignored. Setting this to true will allow your system set variables to work.

{
  modules: [
    ['@nuxtjs/dotenv', { systemvars: true }],
  ]
}

filename

We can override the filename when we need to use different config files for different environments.

{
  modules: [
    ['@nuxtjs/dotenv', { filename: '.env.prod' }],
  ]
}

Using .env file in nuxt.config.js

The dotenv-module won't overload the environment variables of the process running your build.

If you need to use variables from your .env file at this moment, just append require('dotenv').config() to your nuxt.config.js :

require('dotenv').config()

module.exports = {
    // your usual nuxt config.
}

This will works thanks to the dotenv library provided by this module as a dependency. If you decided to ignore some values from your .env file in the module configuration, this won't apply here.

License

MIT License

Copyright (c) Julien Tant julien@craftyx.fr