Advanced Webpack Config

Warning: You are browsing the documentation for Symfony 6.0, which is no longer maintained.

Read the updated version of this page for Symfony 7.1 (the current stable version).

Advanced Webpack Config

Summarized, Encore generates the Webpack configuration that's used in your webpack.config.js file. Encore doesn't support adding all of Webpack's configuration options, because many can be added on your own.

For example, suppose you need to automatically resolve a new extension. To do that, modify the config after fetching it from Encore:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        // webpack.config.js

const Encore = require('@symfony/webpack-encore');

// ... all Encore config here

// fetch the config, then modify it!
const config = Encore.getWebpackConfig();

// add an extension
config.resolve.extensions.push('json');

// export the final config
module.exports = config;
    

But be careful not to accidentally override any config from Encore:

        1
2
3
4
5
6
7
8
        // webpack.config.js
// ...

// GOOD - this modifies the config.resolve.extensions array
config.resolve.extensions.push('json');

// BAD - this replaces any extensions added by Encore
// config.resolve.extensions = ['json'];
    

Configuring Watching Options and Polling

Encore provides the method configureWatchOptions() to configure Watching Options when running encore dev --watch or encore dev-server:

        1
2
3
4
5
        Encore.configureWatchOptions(function(watchOptions) {
    // enable polling and check for changes every 250ms
    // polling is useful when running Encore inside a Virtual Machine
    watchOptions.poll = 250;
});
    

Defining Multiple Webpack Configurations

Webpack supports passing an array of configurations, which are processed in parallel. Webpack Encore includes a reset() object allowing to reset the state of the current configuration to build a new one:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
        // define the first configuration
Encore
    .setOutputPath('public/build/first_build/')
    .setPublicPath('/build/first_build')
    .addEntry('app', './assets/app.js')
    .addStyleEntry('global', './assets/styles/global.scss')
    .enableSassLoader()
    .autoProvidejQuery()
    .enableSourceMaps(!Encore.isProduction())
;

// build the first configuration
const firstConfig = Encore.getWebpackConfig();

// Set a unique name for the config (needed later!)
firstConfig.name = 'firstConfig';

// reset Encore to build the second config
Encore.reset();

// define the second configuration
Encore
    .setOutputPath('public/build/second_build/')
    .setPublicPath('/build/second_build')
    .addEntry('mobile', './assets/mobile.js')
    .addStyleEntry('mobile', './assets/styles/mobile.less')
    .enableLessLoader()
    .enableSourceMaps(!Encore.isProduction())
;

// build the second configuration
const secondConfig = Encore.getWebpackConfig();

// Set a unique name for the config (needed later!)
secondConfig.name = 'secondConfig';

// export the final configuration as an array of multiple configurations
module.exports = [firstConfig, secondConfig];
    

When running Encore, both configurations will be built in parallel. If you prefer to build configs separately, pass the --config-name option:

        1
2
3
4
5
        # if you use the Yarn package manager
$ yarn encore dev --config-name firstConfig

# if you use the npm package manager
$ npm run dev -- --config-name firstConfig
    

Next, define the output directories of each build:

        1
2
3
4
5
6
        # config/packages/webpack_encore.yaml
webpack_encore:
    output_path: '%kernel.project_dir%/public/default_build'
    builds:
        firstConfig: '%kernel.project_dir%/public/first_build'
        secondConfig: '%kernel.project_dir%/public/second_build'
    

Also define the asset manifests for each build:

        1
2
3
4
5
6
7
8
        # config/packages/assets.yaml
framework:
    assets:
        packages:
            first_build:
                json_manifest_path: '%kernel.project_dir%/public/first_build/manifest.json'
            second_build:
                json_manifest_path: '%kernel.project_dir%/public/second_build/manifest.json'
    

Finally, use the third optional parameter of the encore_entry_*_tags() functions to specify which build to use:

        1
2
3
4
5
6
7
        {# Using the entrypoints.json file located in ./public/first_build #}
{{ encore_entry_script_tags('app', null, 'firstConfig') }}
{{ encore_entry_link_tags('global', null, 'firstConfig') }}

{# Using the entrypoints.json file located in ./public/second_build #}
{{ encore_entry_script_tags('mobile', null, 'secondConfig') }}
{{ encore_entry_link_tags('mobile', null, 'secondConfig') }}
    

Generating a Webpack Configuration Object without using the Command-Line Interface

Ordinarily you would use your webpack.config.js file by calling Encore from the command-line interface. But sometimes, having access to the generated Webpack configuration can be required by tools that don't use Encore (for instance a test-runner such as Karma).

The problem is that if you try generating that Webpack configuration object without using the encore command you will encounter the following error:

        1
        Error: Encore.setOutputPath() cannot be called yet because the runtime environment doesn't appear to be configured. Make sure you're using the encore executable or call Encore.configureRuntimeEnvironment() first if you're purposely not calling Encore directly.
    

The reason behind that message is that Encore needs to know a few things before being able to create a configuration object, the most important one being what the target environment is.

To solve this issue you can use configureRuntimeEnvironment. This method must be called from a JavaScript file before requiring webpack.config.js.

For instance:

        1
2
3
4
5
6
7
        const Encore = require('@symfony/webpack-encore');

// Set the runtime environment
Encore.configureRuntimeEnvironment('dev');

// Retrieve the Webpack configuration object
const webpackConfig = require('./webpack.config');
    

If needed, you can also pass to that method all the options that you would normally use from the command-line interface:

        1
2
3
4
5
6
        Encore.configureRuntimeEnvironment('dev-server', {
    // Same options you would use with the
    // CLI utility, with their name in camelCase.
    https: true,
    keepPublicPath: true,
});
    

Having the full control on Loaders Rules

The method configureLoaderRule() provides a clean way to configure Webpack loaders rules (module.rules, see Configuration).

This is a low-level method. All your modifications will be applied just before pushing the loaders rules to Webpack. It means that you can override the default configuration provided by Encore, which may break things. Be careful when using it.

One use might be to configure the eslint-loader to lint Vue files too. The following code is equivalent:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        // Manually
const webpackConfig = Encore.getWebpackConfig();

const eslintLoader = webpackConfig.module.rules.find(rule => rule.loader === 'eslint-loader');
eslintLoader.test = /\.(jsx?|vue)$/;

return webpackConfig;

// Using Encore.configureLoaderRule()
Encore.configureLoaderRule('eslint', loaderRule => {
    loaderRule.test = /\.(jsx?|vue)$/
});

return Encore.getWebpackConfig();
    

The following loaders are configurable with configureLoaderRule():

javascript (alias js)
css
images (but use configureImageRule() instead)
fonts (but use configureFontRule() instead)
sass (alias scss)
less
stylus
svelte
vue
eslint
typescript (alias ts)
handlebars

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.

TOC

Version