Webpack-encore: Document how to works with environment variables

[Kocal]

Just a reminder to write a documentation for Encore.configureDefinePlugin(), and the integration with Symfony .env files and process.env.*.

• https://github.com/motdotla/dotenv

Encore.configureDefinePlugin(options => {
  options['process.env'].MY_OPTION = JSON.stringify('foo');
});

For example for configuring sentry DNS from .env file:

Encore.configureDefinePlugin(options => {
  const env = dotenv.config();

  if (env.error) {
    throw env.error;
  }

  options['process.env'].SENTRY_DSN = JSON.stringify(env.parsed.SENTRY_DSN);
});

[Lyrkan]

We'll have to be careful about that one: there could be confusion related to the fact that it will be interpretated at build time and not on the server it'll be deployed to (like Symfony).

[Kocal]

Yup, we should note that

[Kocal]

In fact, what about adding a new method like .injectEnvironmentVariables(['NODE_ENV', '...']) that will:

• resolve environment variables like Symfony do
• automatically inject them with DefinePlugin + JSON.stringify

?

It can be a bit hard to implement it properly, but it will be 100 times more user friendly

[anaelChardan]

What about this issue ? Would be very helpful ;)

[Kocal]

A proposal has been opened on #568, but it's totally not an easy feature in fact :p

[yaotzin1]

I start using https://www.npmjs.com/package/dotenv-webpack in my project.

After installation:

In webpack.config.js import it:

const Dotenv = require('dotenv-webpack');

Add it as plugin:

.addPlugin(new Dotenv( { path: './.env.local', systemvars: true } ))

start using it in code:

{process.env.npm_package_version}

@anaelChardan