Passando variáveis ​​dependentes do ambiente no webpack

Estou tentando converter um aplicativo angular do gulp para o webpack. no gulp, uso o gulp-preprocess para substituir algumas variáveis ​​na página html (por exemplo, nome do banco de dados), dependendo do NODE_ENV. Qual é a melhor maneira de obter um resultado semelhante com o webpack?

Existem duas maneiras básicas de conseguir isso.

DefinePlugin

new webpack.DefinePlugin({
    'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV || 'development')
}),

Observe que isso substituirá apenas as correspondências "como estão". É por isso que a string está no formato que está. Você poderia ter uma estrutura mais complexa, como um objeto, mas você entendeu a ideia.

EnvironmentPlugin

new webpack.EnvironmentPlugin(['NODE_ENV'])

EnvironmentPluginusa DefinePlugininternamente e mapeia os valores do ambiente para codificá-lo. Sintaxe Terser.

Alias

Como alternativa, você pode consumir a configuração por meio de um módulo com alias . Do lado do consumidor, ficaria assim:

var config = require('config');

A configuração em si poderia ter esta aparência:

resolve: {
    alias: {
        config: path.join(__dirname, 'config', process.env.NODE_ENV)
    }
}

Digamos que process.env.NODE_ENVé development. Seria mapeado para ./config/development.jsentão. O módulo para o qual ele mapeia pode exportar configurações como esta:

module.exports = {
    testing: 'something',
    ...
};

Apenas outra opção, se você deseja usar apenas uma interface defineCLI , basta usar a opção do webpack. Eu adiciono o seguinte script no meu package.json:

"build-production": "webpack -p --define process.env.NODE_ENV='\"production\"' --progress --colors"

Então eu só tenho que correr npm run build-production.

Eu investiguei algumas opções sobre como definir variáveis ​​específicas do ambiente e acabei com isso:

Atualmente, tenho 2 configurações do webpack:

webpack.production.config.js

new webpack.DefinePlugin({
  'process.env':{
    'NODE_ENV': JSON.stringify('production'),
    'API_URL': JSON.stringify('http://localhost:8080/bands')
  }
}),

webpack.config.js

new webpack.DefinePlugin({
  'process.env':{
    'NODE_ENV': JSON.stringify('development'),
    'API_URL': JSON.stringify('http://10.10.10.10:8080/bands')
  }
}),

No meu código, obtenho o valor de API_URL desta maneira (breve):

const apiUrl = process.env.API_URL;

EDIT 3 de novembro de 2016

Os documentos do Webpack têm um exemplo: https://webpack.js.org/plugins/define-plugin/#usage

new webpack.DefinePlugin({
    PRODUCTION: JSON.stringify(true),
    VERSION: JSON.stringify("5fa3b9"),
    BROWSER_SUPPORTS_HTML5: true,
    TWO: "1+1",
    "typeof window": JSON.stringify("object")
})

Com o ESLint, você precisa permitir especificamente variáveis ​​indefinidas no código, se você tiver uma no-undefregra. http://eslint.org/docs/rules/no-undef assim:

/*global TWO*/
console.log('Running App version ' + TWO);

EDIT 7 de setembro de 2017 (específico para Create-React-App)

Se você não gosta muito de configurar, confira Create-React-App: Create-React-App - Adicionando variáveis ​​de ambiente personalizadas . Sob o capô, o CRA usa o Webpack de qualquer maneira.

Você pode passar qualquer argumento da linha de comando sem plugins adicionais usando --envdesde o webpack 2:

webpack --config webpack.config.js --env.foo=bar

Usando a variável em webpack.config.js:

module.exports = function(env) {
    if (env.foo === 'bar') {
        // do something
    }
}

Fonte

Você pode usar diretamente o EnvironmentPlugindisponível emwebpack para ter acesso a qualquer variável de ambiente durante a transpilação.

Você apenas tem que declarar o plugin no seu webpack.config.jsarquivo:

var webpack = require('webpack');

module.exports = {
    /* ... */
    plugins = [
        new webpack.EnvironmentPlugin(['NODE_ENV'])
    ]
};

Observe que você deve declarar explicitamente o nome das variáveis ​​de ambiente que deseja usar.

Para adicionar pessoalmente ao grupo de respostas, prefiro o seguinte:

const webpack = require('webpack');
const prod = process.argv.indexOf('-p') !== -1;

module.exports = {
  ...
  plugins: [
    new webpack.DefinePlugin({
      process: {
        env: {
          NODE_ENV: prod? `"production"`: '"development"'
        }
      }
    }),
    ...
  ]
};

Usando isso, não há problemas na variável de ambiente ou entre plataformas (com env vars). Tudo o que você faz é executar o normal webpackou o desenvolvimento webpack -pou a produção, respectivamente.

Referência: Problema no Github

Como minha Edição na postagem acima, pela thevangelist, não foi aprovada , postando informações adicionais.

Se você deseja escolher o valor do package.json como um número de versão definido e acessá-lo através do DefinePlugin dentro do Javascript.

{"version": "0.0.1"}

Em seguida, importe package.json dentro do respectivo webpack.config , acesse o atributo usando a variável import e use o atributo no DefinePlugin .

const PACKAGE = require('../package.json');
const _version = PACKAGE.version;//Picks the version number from package.json

Por exemplo, determinada configuração no webpack.config está usando o METADATA for DefinePlugin:

const METADATA = webpackMerge(commonConfig({env: ENV}).metadata, {
  host: HOST,
  port: PORT,
  ENV: ENV,
  HMR: HMR,
  RELEASE_VERSION:_version//Version attribute retrieved from package.json
});

new DefinePlugin({
        'ENV': JSON.stringify(METADATA.ENV),
        'HMR': METADATA.HMR,
        'process.env': {
          'ENV': JSON.stringify(METADATA.ENV),
          'NODE_ENV': JSON.stringify(METADATA.ENV),
          'HMR': METADATA.HMR,
          'VERSION': JSON.stringify(METADATA.RELEASE_VERSION)//Setting it for the Scripts usage.
        }
      }),

Acesse isso dentro de qualquer arquivo datilografado:

this.versionNumber = process.env.VERSION;

A maneira mais inteligente seria assim:

// webpack.config.js
plugins: [
    new webpack.DefinePlugin({
      VERSION: JSON.stringify(require("./package.json").version)
    })
  ]

Agradecimentos a Ross Allen

Apenas outra resposta semelhante à resposta do @ zer0chain. No entanto, com uma distinção.

A configuração webpack -pé suficiente.

É o mesmo que:

--define process.env.NODE_ENV="production"

E isso é o mesmo que

// webpack.config.js
const webpack = require('webpack');

module.exports = {
  //...

  plugins:[
    new webpack.DefinePlugin({
      'process.env.NODE_ENV': JSON.stringify('production')
    })
  ]
};

Portanto, você pode precisar apenas de algo assim no package.jsonarquivo Node:

{
  "name": "projectname",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "debug": "webpack -d",
    "production": "webpack -p"
  },
  "author": "prosti",
  "license": "ISC",
  "dependencies": {    
    "webpack": "^2.2.1",
    ...
  }
}

Apenas algumas dicas do DefinePlugin :

O DefinePlugin permite criar constantes globais que podem ser configuradas em tempo de compilação. Isso pode ser útil para permitir comportamentos diferentes entre compilações de desenvolvimento e compilações de versão. Por exemplo, você pode usar uma constante global para determinar se o log ocorre; talvez você faça logon na sua construção de desenvolvimento, mas não na versão. Esse é o tipo de cenário que o DefinePlugin facilita.

Isso é para que você possa verificar se digita webpack --help

Config options:
  --config  Path to the config file
                         [string] [default: webpack.config.js or webpackfile.js]
  --env     Enviroment passed to the config, when it is a function

Basic options:
  --context    The root directory for resolving entry point and stats
                                       [string] [default: The current directory]
  --entry      The entry point                                          [string]
  --watch, -w  Watch the filesystem for changes                        [boolean]
  --debug      Switch loaders to debug mode                            [boolean]
  --devtool    Enable devtool for better debugging experience (Example:
               --devtool eval-cheap-module-source-map)                  [string]
  -d           shortcut for --debug --devtool eval-cheap-module-source-map
               --output-pathinfo                                       [boolean]
  -p           shortcut for --optimize-minimize --define
               process.env.NODE_ENV="production" 

                      [boolean]
  --progress   Print compilation progress in percentage                [boolean]

Para adicionar ao grupo de respostas:

Use ExtendedDefinePlugin em vez de DefinePlugin

npm install extended-define-webpack-plugin --save-dev.

O ExtendedDefinePlugin é muito mais simples de usar e está documentado :-) link

Como o DefinePlugin não possui boa documentação, quero ajudar, dizendo que ele realmente funciona como # DEFINE em c # .

#if (DEBUG)
        Console.WriteLine("Debugging is enabled.");
#endif

Portanto, se você quiser entender como o DefinePlugin funciona, leia a c # #define a duplicação. ligação

Eu prefiro usar o arquivo .env para ambiente diferente.

1. Use webpack.dev.config para copiar env.devpara .env na pasta raiz
2. Use webpack.prod.config para copiar env.prodpara .env

e no código

usar

require('dotenv').config(); const API = process.env.API ## which will store the value from .env file

Eu achei a solução a seguir mais fácil de configurar a variável de ambiente para o Webpack 2:

Por exemplo, temos as configurações de um webpack:

var webpack = require('webpack')

let webpackConfig = (env) => { // Passing envirmonment through
                                // function is important here
    return {
        entry: {
        // entries
        },

        output: {
        // outputs
        },

        plugins: [
        // plugins
        ],

        module: {
        // modules
        },

        resolve: {
        // resolves
        }

    }
};

module.exports = webpackConfig;

Adicionar variável de ambiente no Webpack:

plugins: [
    new webpack.EnvironmentPlugin({
       NODE_ENV: 'development',
       }),
]

Defina a variável de plug-in e adicione-a a plugins:

    new webpack.DefinePlugin({
        'NODE_ENV': JSON.stringify(env.NODE_ENV || 'development')
    }),

Agora, ao executar o comando webpack, passe env.NODE_ENVcomo argumento:

webpack --env.NODE_ENV=development

// OR

webpack --env.NODE_ENV development

Agora você pode acessar a NODE_ENVvariável em qualquer lugar do seu código.

Desde o Webpack v4, basta definir modena sua configuração do Webpack o conjunto NODE_ENVpara você (via DefinePlugin). Documentos aqui.

Aqui está uma maneira que funcionou para mim e me permitiu manter minhas variáveis ​​de ambiente secas reutilizando um arquivo json.

const webpack = require('webpack');
let config = require('./settings.json');
if (__PROD__) {
    config = require('./settings-prod.json');
}

const envVars = {};
Object.keys(config).forEach((key) => {
    envVars[key] = JSON.stringify(config[key]);
});

new webpack.DefinePlugin({
    'process.env': envVars
}),

Eu não sou um grande fã de ...

new webpack.DefinePlugin({
  'process.env': envVars
}),

... como não fornece nenhum tipo de segurança. em vez disso, você acaba aprimorando suas coisas secretas, a menos que você adicione um webpack ao gitignore there️, existe uma solução melhor.

Basicamente, com esta configuração, quando você compilar seu código, todas as variáveis ​​env do processo serão removidas de todo o código, não haverá um único processo.env.VAR, graças ao plugin babel transform-inline-environment-variables PS, se você não quiser acabar com várias definições indefinidas, chame o env.js antes de o webpack chamar babel-loader, é por isso que é a primeira coisa que o webpack chama. a matriz de vars no arquivo babel.config.js deve corresponder ao objeto em env.js. Agora, há apenas uma coisa a ser cortada. adicione um .envarquivo, coloque todas as suas variáveis ​​env lá, o arquivo deve estar na raiz do projeto ou fique à vontade para adicioná-lo onde quiser, apenas certifique-se de definir o mesmo local no arquivo env.js e adicioná-lo a gitignore

const dotFiles = ['.env'].filter(Boolean);

if (existsSync(dotFiles)) {
    require("dotenv-expand")(require("dotenv").config((dotFiles)));
}

Se você quiser ver todo o babel + webpack + ts obtê-lo do heaw https://github.com/EnetoJara/Node-typescript-babel-webpack.git

e a mesma lógica se aplica para reagir e todos os outros

config
---webpack.js
---env.js
src
---source code world
.env
bunch of dotFiles

env.js

"use strict";
/***
I took the main idea from CRA, but mine is more cooler xD
*/
const {realpathSync, existsSync} = require('fs');
const {resolve, isAbsolute, delimiter} = require('path');

const NODE_ENV = process.env.NODE_ENV || "development";

const appDirectory = realpathSync(process.cwd());

if (typeof NODE_ENV !== "string") {
    throw new Error("falle and stuff");
}

const dotFiles = ['.env'].filter(Boolean);

if (existsSync(dotFiles)) {
    require("dotenv-expand")(require("dotenv").config((dotFiles)));
}

process.env.NODE_PATH = (process.env.NODE_PATH || "")
    .split(delimiter)
    .filter(folder => folder && isAbsolute(folder))
    .map(folder => resolve(appDirectory, folder))
    .join(delimiter);

const ENETO_APP = /^ENETO_APP_/i;

module.exports = (function () {
    const raw = Object.keys ( process.env )
        .filter ( key => ENETO_APP.test ( key ) )
        .reduce ( ( env, key ) => {
                env[ key ] = process.env[ key ];
                return env;
            },
            {
                BABEL_ENV: process.env.ENETO_APP_BABEL_ENV,
                ENETO_APP_DB_NAME: process.env.ENETO_APP_DB_NAME,
                ENETO_APP_DB_PASSWORD: process.env.ENETO_APP_DB_PASSWORD,
                ENETO_APP_DB_USER: process.env.ENETO_APP_DB_USER,
                GENERATE_SOURCEMAP: process.env.ENETO_APP_GENERATE_SOURCEMAP,
                NODE_ENV: process.env.ENETO_APP_NODE_ENV,
                PORT: process.env.ENETO_APP_PORT,
                PUBLIC_URL: "/"
            } );

    const stringyField = {
        "process.env": Object.keys(raw).reduce((env, key)=> {
            env[key]=JSON.stringify(raw[key]);
            return env;
        },{}),

    };

    return {
        raw, stringyField
    }
})();

arquivo webpack sem plugins troll

"use strict";

require("core-js");
require("./env.js");

const path = require("path");
const nodeExternals = require("webpack-node-externals");

module.exports = env => {
    return {
        devtool: "source-map",
        entry: path.join(__dirname, '../src/dev.ts'),
        externals: [nodeExternals()],
        module: {
            rules: [
                {
                    exclude: /node_modules/,
                    test: /\.ts$/,
                    use: [
                        {
                            loader: "babel-loader",
                        },
                        {
                            loader: "ts-loader"
                        }
                    ],
                },
                {
                    test: /\.(png|jpg|gif)$/,
                    use: [
                        {
                            loader: "file-loader",
                        },
                    ],
                },
            ],
        },
        node: {
            __dirname: false,
            __filename: false,
        },
        optimization: {
            splitChunks: {
                automaticNameDelimiter: "_",
                cacheGroups: {
                    vendor: {
                        chunks: "initial",
                        minChunks: 2,
                        name: "vendor",
                        test: /[\\/]node_modules[\\/]/,
                    },
                },
            },
        },
        output: {
            chunkFilename: "main.chunk.js",
            filename: "name-bundle.js",
            libraryTarget: "commonjs2",
        },
        plugins: [],
        resolve: {
            extensions: ['.ts', '.js']
        }   ,
        target: "node"
    };
};

babel.config.js

module.exports = api => {

    api.cache(() => process.env.NODE_ENV);

    return {

        plugins: [
            ["@babel/plugin-proposal-decorators", { legacy: true }],
            ["@babel/plugin-transform-classes", {loose: true}],
            ["@babel/plugin-external-helpers"],
            ["@babel/plugin-transform-runtime"],
            ["@babel/plugin-transform-modules-commonjs"],
            ["transform-member-expression-literals"],
            ["transform-property-literals"],
            ["@babel/plugin-transform-reserved-words"],
            ["@babel/plugin-transform-property-mutators"],
            ["@babel/plugin-transform-arrow-functions"],
            ["@babel/plugin-transform-block-scoped-functions"],
            [
                "@babel/plugin-transform-async-to-generator",
                {
                    method: "coroutine",
                    module: "bluebird",
                },
            ],
            ["@babel/plugin-proposal-async-generator-functions"],
            ["@babel/plugin-transform-block-scoping"],
            ["@babel/plugin-transform-computed-properties"],
            ["@babel/plugin-transform-destructuring"],
            ["@babel/plugin-transform-duplicate-keys"],
            ["@babel/plugin-transform-for-of"],
            ["@babel/plugin-transform-function-name"],
            ["@babel/plugin-transform-literals"],
            ["@babel/plugin-transform-object-super"],
            ["@babel/plugin-transform-shorthand-properties"],
            ["@babel/plugin-transform-spread"],
            ["@babel/plugin-transform-template-literals"],
            ["@babel/plugin-transform-exponentiation-operator"],
            ["@babel/plugin-proposal-object-rest-spread"],
            ["@babel/plugin-proposal-do-expressions"],
            ["@babel/plugin-proposal-export-default-from"],
            ["@babel/plugin-proposal-export-namespace-from"],
            ["@babel/plugin-proposal-logical-assignment-operators"],
            ["@babel/plugin-proposal-throw-expressions"],
            [
                "transform-inline-environment-variables",
                {
                    include: [
                        "ENETO_APP_PORT",
                        "ENETO_APP_NODE_ENV",
                        "ENETO_APP_BABEL_ENV",
                        "ENETO_APP_DB_NAME",
                        "ENETO_APP_DB_USER",
                        "ENETO_APP_DB_PASSWORD",
                    ],
                },
            ],
        ],
        presets: [["@babel/preset-env",{
            targets: {
                node: "current",
                esmodules: true
            },
            useBuiltIns: 'entry',
            corejs: 2,
            modules: "cjs"
        }],"@babel/preset-typescript"],
    };
};

Não sei por que, mas ninguém realmente menciona a solução mais simples. Isso funciona para mim para nodejs e grunhido. Quanto a muitas pessoas, o webpack pode ser confuso, basta usar a linha abaixo:

process.env.NODE_ENV = 'production';

Com a solução acima, você realmente não precisa usar o envify ou o webpack. Às vezes, a solução simples codificada pode funcionar para algumas pessoas.