Webpack Encore Bundle

https://github.com/symfony/webpack-encore-bundle
Admin
Webpack Encore Bundle is a Symfony integration that enables the use of Webpack Encore's...
Tokens:41,665
Snippets:285
Trust Score:9.5
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Run Psalm static analysis

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/CONTRIBUTING.md

Install Psalm dependencies in the tools directory and execute the analysis.

```bash
composer install --working-dir=tools/psalm
tools/psalm/vendor/bin/psalm
```

--------------------------------

### Autowire entrypoint lookup services in a constructor

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/ServiceContainer.md

Autowiring example for the default build lookup, the collection of all builds, and the tag renderer. The comments indicate the role of each injected service.

```php
use Symfony\WebpackEncoreBundle\Asset\EntrypointLookupInterface;
use Symfony\WebpackEncoreBundle\Asset\EntrypointLookupCollectionInterface;
use Symfony\WebpackEncoreBundle\Asset\TagRenderer;

class MyService
{
    public function __construct(
        EntrypointLookupInterface $lookup,               // default build lookup
        EntrypointLookupCollectionInterface $collection, // all builds
        TagRenderer $tagRenderer,                        // class-based autowire
    ) {
    }
}
```

--------------------------------

### Injecting and using EntrypointLookupCollection

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointLookupCollection.md

Example of injecting the collection into a service and using it to retrieve JavaScript files for a specific build.

```php
use Symfony\WebpackEncoreBundle\Asset\EntrypointLookupCollectionInterface;

class SomeService
{
    public function __construct(EntrypointLookupCollectionInterface $collection)
    {
        $this->collection = $collection;
    }

    public function scriptTagsFor(string $entryName, ?string $buildName = null): array
    {
        $lookup = $this->collection->getEntrypointLookup($buildName); // default build when null
        return $lookup->getJavaScriptFiles($entryName);
    }
}
```

--------------------------------

### Catching EntrypointNotFoundException

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/errors.md

Example of catching the EntrypointNotFoundException when attempting to retrieve JavaScript files for a non-existent entry.

```php
use Symfony\WebpackEncoreBundle\Asset\EntrypointLookup;
use Symfony\WebpackEncoreBundle\Exception\EntrypointNotFoundException;

$lookup = new EntrypointLookup('/path/to/entrypoints.json');

try {
    $files = $lookup->getJavaScriptFiles('unknown');
} catch (EntrypointNotFoundException $e) {
    // hint at the available keys: $e->getMessage() lists "Found: ..."
}
// Because it extends InvalidArgumentException, catch (\InvalidArgumentException $e) also works.
```

--------------------------------

### EntrypointLookup with error handling, cache, and remote file

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointLookup.md

Shows how to use EntrypointLookup with a cache adapter and a remote entrypoints.json URL. Includes a try-catch block for EntrypointNotFoundException, with example error messages for missing entries or wrong extension.

```php
// Error handling + optional cache + remote file
use Symfony\WebpackEncoreBundle\Asset\EntrypointLookup;
use Symfony\WebpackEncoreBundle\Exception\EntrypointNotFoundException;
use Symfony\Component\Cache\Adapter\ArrayAdapter;

$cache = new ArrayAdapter();
$lookup = new EntrypointLookup('https://cdn.example.com/build/entrypoints.json', $cache, 'my_build');

try {
    $files = $lookup->getJavaScriptFiles('app');
} catch (EntrypointNotFoundException $e) {
    // 'Could not find the entry "app" in "https://...". Found: ...'
    // or 'Could not find the entry "app.js". Try "app" instead (without the extension).'
}
```

--------------------------------

### Render entry tags and file paths in Twig

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntryFilesTwigExtension.md

Examples of rendering script and link tags, using custom attributes, specifying builds, and manually looping through file paths.

```twig
{# Script + stylesheet tags for an entry in the default build #}
{{ encore_entry_script_tags('entry1') }}
{{ encore_entry_link_tags('entry1') }}

{# Custom attribute (named argument) #}
{{ encore_entry_script_tags('entry1', attributes={
    defer: true
}) }}

{# Named build + package #}
{{ encore_entry_script_tags('entry1', 'my_package', 'frontend') }}

{# Lists of raw file paths for manual loops #}
{% for jsFile in encore_entry_js_files('entry1') %}
    <script src="{{ asset(jsFile) }}"></script>
{% endfor %}
{% for cssFile in encore_entry_css_files('entry1') %}
    <link rel="stylesheet" href="{{ asset(cssFile) }}">
{% endfor %}

{# Conditional rendering #}
{% if encore_entry_exists('admin') %}
    {{ encore_entry_script_tags('admin') }}
{% endif %}
```

--------------------------------

### Run PHPStan static analysis

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/CONTRIBUTING.md

Install PHPStan dependencies in the tools directory and execute analysis. You can also generate a baseline file based on the analysis results.

```bash
composer install --working-dir=tools/phpstan
tools/phpstan/vendor/bin/phpstan analyze
# Based on the results, you may want to update the baseline
tools/phpstan/vendor/bin/phpstan analyze --generate-baseline
```

--------------------------------

### Install WebpackEncoreBundle via Composer

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/doc/index.rst

Use this command to install the bundle in your Symfony project.

```terminal
$ composer require symfony/webpack-encore-bundle
```

--------------------------------

### EntrypointLookup

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointLookup.md

Documentation for the EntrypointLookup class, including constructor, methods, exceptions, and usage examples.

```APIDOC
## EntrypointLookup

### Description
Creates a lookup object to retrieve JavaScript and CSS file paths from an entrypoints.json file generated by Webpack Encore. Supports local files, remote URLs, caching, and error handling for missing entries.

### Constructor
`new EntrypointLookup(string $entrypointJsonPath, CacheInterface $cache = null, string $cacheKey = null)`

- **$entrypointJsonPath** (string) - Required - Path or URL to the entrypoints.json file.
- **$cache** (CacheInterface) - Optional - PSR-6 cache adapter for caching the parsed file.
- **$cacheKey** (string) - Optional - Cache key prefix for the cached data.

### Methods

#### getJavaScriptFiles
`getJavaScriptFiles(string $entryName): array`

Returns an array of JavaScript file paths for the given entry name. Files are returned only once per request; subsequent calls for the same file will not include it again until `reset()` is called.

#### getCssFiles
`getCssFiles(string $entryName): array`

Returns an array of CSS file paths for the given entry name. Files are returned only once per request; subsequent calls for the same file will not include it again until `reset()` is called.

#### reset
`reset(): void`

Resets the internal state, allowing the same files to be rendered again in the current request.

### Exceptions
- **EntrypointNotFoundException** - Thrown when the requested entry name is not found in the entrypoints.json file. The exception message includes the entry name and the file path or URL, and suggests trying without the `.js` extension if applicable.

### Example
```php
use Symfony\WebpackEncoreBundle\Asset\EntrypointLookup;

$lookup = new EntrypointLookup('/app/public/build/entrypoints.json');

$jsFiles = $lookup->getJavaScriptFiles('entry1');
$cssFiles = $lookup->getCssFiles('entry1');
// $jsFiles === ['build/vendor~entry1~entry2.js', 'build/entry1.js'] (first call)
// A second call for an entry sharing 'build/file1.js' won't return that file again.

$lookup->reset(); // allow the same files to be rendered again in this request
```

### Example with Cache and Remote File
```php
use Symfony\WebpackEncoreBundle\Asset\EntrypointLookup;
use Symfony\WebpackEncoreBundle\Exception\EntrypointNotFoundException;
use Symfony\Component\Cache\Adapter\ArrayAdapter;

$cache = new ArrayAdapter();
$lookup = new EntrypointLookup('https://cdn.example.com/build/entrypoints.json', $cache, 'my_build');

try {
    $files = $lookup->getJavaScriptFiles('app');
} catch (EntrypointNotFoundException $e) {
    // 'Could not find the entry "app" in "https://...". Found: ...'
    // or 'Could not find the entry "app.js". Try "app" instead (without the extension).'
}
```
```

--------------------------------

### EntrypointLookup constructor

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointLookup.md

Constructor for EntrypointLookup. Takes the path to entrypoints.json, optional cache, cache key, strict mode, and HTTP client. If the path starts with 'http', it is fetched over HTTP using the provided HTTP client, otherwise read from the local filesystem.

```php
public function __construct(string $entrypointJsonPath, ?CacheItemPoolInterface $cache = null, ?string $cacheKey = null, bool $strictMode = true, ?HttpClientInterface $httpClient = null)
```

--------------------------------

### Complete Webpack Encore YAML Configuration

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/configuration.md

A comprehensive example of the webpack_encore configuration block in Symfony, including settings for output paths, script attributes, and multiple build definitions.

```yaml
# config/packages/webpack_encore.yaml
webpack_encore:
    # The path where Encore is building the assets - i.e. Encore.setOutputPath()
    # if you customize this, you will also need to change framework.assets.json_manifest_path (it usually lives in assets.yaml)
    output_path: '%kernel.project_dir%/public/build'
    # If multiple builds are defined (as shown below), you can disable the default build:
    # output_path: false

    # Set attributes that will be rendered on all script and link tags
    script_attributes:
        defer: true
        # referrerpolicy: origin
    # link_attributes:
    #     referrerpolicy: origin

    # if using Encore.enableIntegrityHashes() and need the crossorigin attribute (default: false, or use 'anonymous' or 'use-credentials')
    # crossorigin: 'anonymous'

    # preload all rendered script and link tags automatically via the http2 Link header
    # preload: true

    # Throw an exception if the entrypoints.json file is missing or an entry is missing from the data
    # strict_mode: false

    # if you have multiple builds:
    builds:
        frontend: '%kernel.project_dir%/public/frontend/build'
        # or if you use a CDN:
        # cdn: 'https://cdn.example.com/frontend/build'

    # Cache the entrypoints.json (rebuild Symfony's cache when entrypoints.json changes)
    # cache: true    # typically under config/packages/prod/webpack_encore.yaml
```

--------------------------------

### Event subscriber example for adding nonce to script tags

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/RenderAssetTagEvent.md

Example subscriber class that subscribes to RenderAssetTagEvent and sets a 'nonce' attribute on script tags. The class implements EventSubscriberInterface and registers the onRenderAssetTag method for the event.

```php
// src/EventSubscriber/ScriptNonceSubscriber.php
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\WebpackEncoreBundle\Event\RenderAssetTagEvent;

class ScriptNonceSubscriber implements EventSubscriberInterface
{
    public static function getSubscribedEvents()
    {
        return [
            RenderAssetTagEvent::class => 'onRenderAssetTag'
        ];
    }

    public function onRenderAssetTag(RenderAssetTagEvent $event)
    {
        if ($event->isScriptTag()) {
            $event->setAttribute('nonce', 'lookup-nonce-value');
        }
    }
}
```

--------------------------------

### Catching UndefinedBuildException

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/errors.md

Example of catching the UndefinedBuildException when requesting a build name that has not been configured in the collection.

```php
use Symfony\WebpackEncoreBundle\Asset\EntrypointLookupCollectionInterface;
use Symfony\WebpackEncoreBundle\Exception\UndefinedBuildException;

try {
    $lookup = $collection->getEntrypointLookup('missing_build');
} catch (UndefinedBuildException $e) {
    // The build "missing_build" is not configured
}
```

--------------------------------

### Register WebpackEncoreBundle in kernel

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/WebpackEncoreBundle.md

Example of registering the bundle in a kernel's registerBundles() method, alongside FrameworkBundle and TwigBundle. In a Flex-based app, no PHP code is required; use composer require and configure config/packages/webpack_encore.yaml.

```php
// src/SomeBundle.php
use Symfony\WebpackEncoreBundle\WebpackEncoreBundle;

// in your kernel's registerBundles()
public function registerBundles(): array
{
    return [
        new FrameworkBundle(),
        new TwigBundle(),
        new WebpackEncoreBundle(),
    ];
}
```

--------------------------------

### Fetch named services from the container

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/ServiceContainer.md

Retrieves the entrypoint lookup collection, tag renderer, and cache warmer by their service IDs from the container. The comment notes that container access style depends on the kernel setup.

```php
// Named service lookup (container access style depends on the kernel setup)
$collection = $container->get('webpack_encore.entrypoint_lookup_collection');
$renderer   = $container->get('webpack_encore.tag_renderer');
$warmer     = $container->get('webpack_encore.entrypoint_lookup.cache_warmer');
```

--------------------------------

### Advanced subscriber example removing attribute for link tags

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/RenderAssetTagEvent.md

Advanced example method that removes the 'referrerpolicy' attribute for link tags only. This is shown as a standalone method.

```php
// Advanced: remove a default attribute for link tags only
public function onRenderAssetTag(RenderAssetTagEvent $event)
{
    if ($event->isLinkTag()) {
        $event->removeAttribute('referrerpolicy');
    }
}
```

--------------------------------

### Handling errors and inspecting rendered output

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/TagRenderer.md

Shows how to catch EntrypointNotFoundException and retrieve lists of rendered scripts and styles.

```php
// Error handling + inspecting rendered output
use Symfony\WebpackEncoreBundle\Exception\EntrypointNotFoundException;

try {
    $tagRenderer->renderWebpackLinkTags('unknown_entry');
} catch (EntrypointNotFoundException $e) {
    // missing entry in entrypoints.json
}

// consumed by PreLoadAssetsEventListener: rendered scripts with attributes
$scripts = $tagRenderer->getRenderedScripts(true);   // list<array<string, mixed>>
$styles  = $tagRenderer->getRenderedStyles(true);    // list<array<string, mixed>>
```

--------------------------------

### Dynamic service IDs for entrypoint lookups

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/ServiceContainer.md

Shows the service IDs created dynamically by the extension for the default build and each named build. The default service is only created when output_path is not false.

```text
webpack_encore.entrypoint_lookup[_default]      -> EntrypointLookup  (only when output_path !== false)
webpack_encore.entrypoint_lookup[<build name>]  -> EntrypointLookup  (one per entry in builds)
```

--------------------------------

### Constructor

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointLookup.md

Creates an EntrypointLookup instance that reads an entrypoints.json file from a local path or remote URL, with optional caching and strict mode.

```APIDOC
## Constructor

### Description
Creates an EntrypointLookup instance that reads a Webpack Encore entrypoints.json file and returns CSS/JavaScript files for a given entry.

### Method
`__construct`

### Signature
```php
public function __construct(string $entrypointJsonPath, ?CacheItemPoolInterface $cache = null, ?string $cacheKey = null, bool $strictMode = true, ?HttpClientInterface $httpClient = null)
```

### Parameters
#### Constructor Parameters
- **$entrypointJsonPath** (string) - Required - Path or URL to the `entrypoints.json` file. A value starting with `http` is fetched over HTTP(S) using an `HttpClientInterface`; anything else is read from the local filesystem.
- **$cache** (?CacheItemPoolInterface) - Optional - Optional cache pool (e.g. `Psr\Cache` pool). When set, decoded entries are cached under `$cacheKey` and reused across lookups/requests.
- **$cacheKey** (?string) - Optional - Cache key used for storing/reading the decoded entrypoints data. If `null` and a cache is provided, `getEntriesData()` reads/writes under key `null`.
- **$strictMode** (bool) - Optional - When `true`, missing entries/files raise exceptions; when `false`, missing data yields empty results instead.
- **$httpClient** (?HttpClientInterface) - Optional - HTTP client for remote URLs. When `null` and the path is a URL, the class falls back to `Symfony\Component\HttpClient\HttpClient::create()` — requiring `symfony/http-client` to be installed.

### Return
None (constructor).
```

--------------------------------

### Handle missing entry point errors

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntryFilesTwigExtension.md

Demonstrates that rendering a missing entry point through Twig results in a Twig runtime error.

```twig
{# Error behavior: rendering through Twig wraps lookup exceptions in Twig runtime errors #}
{{ encore_entry_script_tags('missing_entry') }}
{# -> Twig\Error\RuntimeError: Could not find the entry "missing_entry" in "<path>/entrypoints.json". Found: entry1, other_entry. #}
```

--------------------------------

### Run PHPUnit tests

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/CONTRIBUTING.md

Execute the project's test suite using the simple-phpunit wrapper.

```bash
./vendor/bin/simple-phpunit
```

--------------------------------

### Manual extension load in Kernel::configureContainer

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/configuration.md

Demonstrates how to manually load the webpack_encore extension configuration within the Kernel's configureContainer method.

```php
// inside Kernel::configureContainer()
$container->loadFromExtension('webpack_encore', [
    'output_path' => __DIR__.'/public/build',
    'cache' => true,
    'crossorigin' => false,
    'preload' => true,
    'builds' => [
        'frontend' => __DIR__.'/public/frontend/build',
        'cdn' => 'https://cdn.example.com/frontend/build',
    ],
    'strict_mode' => true,
    'script_attributes' => [],
    'link_attributes' => [],
]);
```

--------------------------------

### Load webpack_encore extension with options

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/WebpackEncoreBundle.md

Shows how to load the webpack_encore extension inside Kernel::configureContainer() with all available options. After loading, several public services become available, including webpack_encore.entrypoint_lookup_collection and webpack_encore.tag_renderer.

```php
$container->loadFromExtension('webpack_encore', [
    'output_path' => __DIR__.'/public/build',
    'cache' => true,
    'crossorigin' => false,
    'preload' => true,
    'builds' => [
        'frontend' => __DIR__.'/public/frontend/build',
        'cdn' => 'https://cdn.example.com/frontend/build',
    ],
    'strict_mode' => true,
    'script_attributes' => [],
]);
```

--------------------------------

### Inject and use EntrypointLookupInterface and EntrypointLookupCollectionInterface

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointLookupInterfaces.md

Shows constructor injection of the default lookup (aliased to _default build) and the collection of all builds. The generate method demonstrates resetting the lookup per request and retrieving JavaScript files for an entry.

```php
use Symfony\WebpackEncoreBundle\Asset\EntrypointLookupInterface;
use Symfony\WebpackEncoreBundle\Asset\EntrypointLookupCollectionInterface;
use Symfony\WebpackEncoreBundle\Event\RenderAssetTagEvent;

class DocumentController
{
    public function __construct(
        EntrypointLookupInterface $defaultLookup,            // aliased to the _default build lookup
        EntrypointLookupCollectionInterface $collection       // all builds
    ) {
    }

    public function generate(EntrypointLookupInterface $entrypointLookup): string
    {
        $entrypointLookup->reset();                    // reset per request
        $js = $entrypointLookup->getJavaScriptFiles('entry1');
        $entrypointLookup->reset();
        // ...
    }
}
```

--------------------------------

### Manually invoking the Configuration class

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/Configuration.md

Shows how to manually instantiate the Configuration class and retrieve the config tree builder for the webpack_encore extension.

```php
use Symfony\WebpackEncoreBundle\DependencyInjection\Configuration;
use Symfony\Component\Config\Definition\Builder\CompiledConfig;

$configuration = new Configuration();
$treeBuilder = $configuration->getConfigTreeBuilder(); // -> config tree for 'webpack_encore'
```

--------------------------------

### Asserting Link header behavior in integration tests

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EventListeners.md

Demonstrates how to verify that asset tags are rendered and the Link header is populated in a kernel request.

```php
// Example: asserting the Link header behavior in a request (integration-level)
$tagRenderer->renderWebpackLinkTags('my_entry');
$tagRenderer->renderWebpackScriptTags('my_entry');

$response = $kernel->handle(Request::create('/foo'));
// $response->headers->get('Link')
// => '</build/file1.js>; rel="preload"; as="script"'  (plus a style link, if any)
```

--------------------------------

### TagRenderer constructor

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/TagRenderer.md

The constructor initializes the service with entrypoint lookups, asset packages, default attributes, and an optional event dispatcher.

```php
public function __construct(
    EntrypointLookupCollectionInterface $entrypointLookupCollection,
    Packages $packages,
    array $defaultAttributes = [],
    array $defaultScriptAttributes = [],
    array $defaultLinkAttributes = [],
    ?EventDispatcherInterface $eventDispatcher = null,
)
```

--------------------------------

### Constructor signature for EntrypointCacheWarmer

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointCacheWarmer.md

Constructor accepts an array of cache keys mapping to entrypoints file paths, an optional HTTP client for remote entries, and the target PHP array file path.

```php
public function __construct(array $cacheKeys, ?HttpClientInterface $httpClient, string $phpArrayFile)
```

--------------------------------

### ExceptionListener constructor

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EventListeners.md

Constructor accepting the EntrypointLookupCollection and an array of build names to reset.

```php
public function __construct(EntrypointLookupCollection $entrypointLookupCollection, array $buildNames)
```

--------------------------------

### getConfigTreeBuilder() method

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/Configuration.md

Defines the configuration tree for the webpack_encore bundle. It sets up validation and various node definitions for the bundle's configuration options.

```php
public function getConfigTreeBuilder(): TreeBuilder
{
    $treeBuilder = new TreeBuilder('webpack_encore');
    /** @var ArrayNodeDefinition $rootNode */
    $rootNode = $treeBuilder->getRootNode();

    $rootNode
        ->validate()
            ->ifTrue(function (array $v): bool {
                return false === $v['output_path'] && empty($v['builds']);
            })
            ->thenInvalid('Default build can only be disabled if multiple entry points are defined.')
        ->end()
        ->children()
            ->scalarNode('output_path')
                ->isRequired()
                ->info('The path where Encore is building the assets - i.e. Encore.setOutputPath()')
            ->end()
            ->enumNode('crossorigin')
                ->defaultFalse()
                ->values([false, 'anonymous', 'use-credentials'])
                ->info('crossorigin value when Encore.enableIntegrityHashes() is used, can be false (default), anonymous or use-credentials')
            ->end()
            ->booleanNode('preload')
                ->info('preload all rendered script and link tags automatically via the http2 Link header.')
                ->defaultFalse()
            ->end()
            ->booleanNode('cache')
                ->info('Enable caching of the entry point file(s)')
                ->defaultFalse()
            ->end()
            ->booleanNode('strict_mode')
                ->info('Throw an exception if the entrypoints.json file is missing or an entry is missing from the data')
                ->defaultTrue()
            ->end()
            ->arrayNode('builds')
                ->useAttributeAsKey('name')
                ->normalizeKeys(false)
                ->scalarPrototype()
                    ->validate()
                    ->always(function ($values) {
                        if (isset($values['_default'])) {
                            throw new InvalidDefinitionException("Key '_default' can't be used as build name.");
                        }
                        return $values;
                    })
                    ->end()
                ->end()
            ->end()
            ->arrayNode('script_attributes')
                ->info('Key/value pair of attributes to render on all script tags')
                ->example('{ defer: true, referrerpolicy: "origin" }')
                ->useAttributeAsKey('name')
                ->normalizeKeys(false)
                ->scalarPrototype()->end()
            ->end()
            ->arrayNode('link_attributes')
                ->info('Key/value pair of attributes to render on all CSS link tags')
                ->example('{ referrerpolicy: "origin" }')
                ->useAttributeAsKey('name')
                ->normalizeKeys(false)
                ->scalarPrototype()->end()
            ->end()
        ->end()
    ;

    return $treeBuilder;
}
```

--------------------------------

### reset(): void

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/TagRenderer.md

Re-initializes both rendered-files maps to ['scripts' => [], 'styles' => []]. Useful for clearing state between renders.

```APIDOC
## reset(): void

### Description
Re-initializes both rendered-files maps to ['scripts' => [], 'styles' => []]. This allows re-rendering of files that were previously deduplicated.

### Method
reset

### Return
- **void** - No return value.

### Source
`src/Asset/TagRenderer.php:162`

### Signature
```php
public function reset(): void
```
```

--------------------------------

### Handling UndefinedBuildException

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointLookupCollection.md

Demonstrates error handling when requesting a non-existent build or when no default build is configured.

```php
// Error handling
use Symfony\WebpackEncoreBundle\Exception\UndefinedBuildException;

$lookup = $collection->getEntrypointLookup('not_a_build'); // -> UndefinedBuildException

if (null === $collection->getEntrypointLookup()) {
    // Throws instead: only reachable when output_path: false and no default exists
}
```

--------------------------------

### Basic EntrypointLookup usage

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointLookup.md

Creates an EntrypointLookup instance pointing to a local entrypoints.json file and retrieves JavaScript and CSS files for an entry. The first call returns all files, but subsequent calls for shared files may not return them again until reset() is called.

```php
use Symfony\WebpackEncoreBundle\Asset\EntrypointLookup;

$lookup = new EntrypointLookup('/app/public/build/entrypoints.json');

$jsFiles = $lookup->getJavaScriptFiles('entry1');
$cssFiles = $lookup->getCssFiles('entry1');
// $jsFiles === ['build/vendor~entry1~entry2.js', 'build/entry1.js'] (first call)
// A second call for an entry sharing 'build/file1.js' won't return that file again.

$lookup->reset(); // allow the same files to be rendered again in this request
```

--------------------------------

### TagRenderer::__construct

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/TagRenderer.md

Creates a new TagRenderer instance with the required entrypoint lookup collection and asset packages, plus optional default attributes and event dispatcher.

```APIDOC
## TagRenderer::__construct

### Description
Creates a new TagRenderer instance. The constructor initializes the rendered-files state by calling reset().

### Method
Constructor

### Signature
```php
public function __construct(
    EntrypointLookupCollectionInterface $entrypointLookupCollection,
    Packages $packages,
    array $defaultAttributes = [],
    array $defaultScriptAttributes = [],
    array $defaultLinkAttributes = [],
    ?EventDispatcherInterface $eventDispatcher = null,
)
```

### Parameters
- **$entrypointLookupCollection** (EntrypointLookupCollectionInterface) - Required - Resolves build names to lookups
- **$packages** (Symfony\Component\Asset\Packages) - Required - Resolves asset paths to URLs (`getUrl($path, $packageName)`). If `null` is passed, rendering throws.
- **$defaultAttributes** (array) - Optional - Default `[]` - Attributes merged into **every** rendered script and link tag (the extension injects `['crossorigin' => ...]` here when `crossorigin` is configured)
- **$defaultScriptAttributes** (array) - Optional - Default `[]` - Attributes merged into every script tag only (from `script_attributes` config)
- **$defaultLinkAttributes** (array) - Optional - Default `[]` - Attributes merged into every link tag only (from `link_attributes` config)
- **$eventDispatcher** (?EventDispatcherInterface) - Optional - Default `null` - Optional event dispatcher for `RenderAssetTagEvent`; when `null`, events are constructed but not dispatched

### Notes
The constructor calls `$this->reset()`, initializing the rendered-files state.
```

--------------------------------

### Handling invalid configuration definitions

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/Configuration.md

Demonstrates how the config compiler rejects invalid configuration trees, resulting in an InvalidDefinitionException.

```php
// Error handling: invalid trees are rejected by the config compiler
// webpack_encore:
//     output_path: false
// -> InvalidDefinitionException: 'Default build can only be disabled if multiple entry points are defined.'
```

--------------------------------

### Manual invocation of the cache warmer

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointCacheWarmer.md

Shows how to manually invoke the warmer through the kernel cache warmer infrastructure. It retrieves warmers for the 'dev' environment and calls warmUp on each.

```php
use Psy\Container as PSR; // PSR is the standard bootstrap helper for warming
// Equivalent wiring performed by the container:
// $container->get('webpack_encore.entrypoint_lookup.cache_warmer')

// The warmer is a kernel cache warmer; invoking it manually requires the
// framework's warmUp() entrypoint:
$warmers = $container->get('kernel.cache_warmer')->getWarmers('dev');
foreach ($warmers as $warmer) {
    $warmer->warmUp($kernel->getCacheDir()); // -> writes %build_dir%/webpack_encore.cache.php
}
```

--------------------------------

### entrypointFactory method signature

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/WebpackEncoreBundle.md

Declares the private helper method that creates a Definition for EntrypointLookup. The method signature shows the parameters used to configure the service.

```php
private function entrypointFactory(ContainerBuilder $container, string $name, string $path, bool $cacheEnabled, bool $strictMode): Reference
```

--------------------------------

### Constructor

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntryFilesTwigExtension.md

Constructs the Twig extension with a service locator providing the entrypoint lookup collection and tag renderer services.

```APIDOC
## Constructor

### Description
Constructs the EntryFilesTwigExtension with a service locator that provides the entrypoint lookup collection and tag renderer services.

### Method
__construct

### Signature
public function __construct(ContainerInterface $container)

### Parameters
- **$container** (Psr\Container\ContainerInterface) - Required - Service locator providing 'webpack_encore.entrypoint_lookup_collection' and 'webpack_encore.tag_renderer'.
```

--------------------------------

### RenderAssetTagEvent constructor signature

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/RenderAssetTagEvent.md

The constructor takes a string type (TYPE_SCRIPT or TYPE_LINK), the resolved asset URL, and an initial attribute map. The type and URL are required.

```php
public function __construct(string $type, string $url, array $attributes)
```

--------------------------------

### reset method signature

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/TagRenderer.md

Re-initializes the rendered-files maps for scripts and styles.

```php
public function reset(): void
```

--------------------------------

### Rendering script tags with TagRenderer

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/TagRenderer.md

Demonstrates basic usage of renderWebpackScriptTags and how to pass extra attributes to the rendered tags.

```php
use Symfony\WebpackEncoreBundle\Asset\TagRenderer;

// Autowire the public service:
// $container->get('public.webpack_encore.tag_renderer'); // or autowire TagRenderer::class

$html = $tagRenderer->renderWebpackScriptTags('entry1');
// <script src="/build/vendor~entry1~entry2.js"></script><script src="/build/entry1.js"></script>

$htmlWithOptions = $tagRenderer->renderWebpackScriptTags(
    'entry1',
    'my_package',     // packageName
    'frontend',       // entrypointName (build)
    ['defer' => true, 'data-turbo-track' => 'reload'], // extraAttributes
);
// <script src="..." defer data-turbo-track="reload"></script>
```

--------------------------------

### Error handling for preload option

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/WebpackEncoreBundle.md

Demonstrates the error handling when the 'preload' option is enabled without the required symfony/web-link package. The load() method throws a LogicException with the shown message.

```php
$container->loadFromExtension('webpack_encore', [
    'output_path' => __DIR__.'/public/build',
    'preload' => true, // requires symfony/web-link to be installed
]);
// If symfony/web-link is missing, load() throws:
// LogicException: To use the "preload" option, the WebLink component must be installed.
// Try running "composer require symfony/web-link".
```

--------------------------------

### Custom EntrypointLookup implementation with IntegrityDataProviderInterface

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointLookupInterfaces.md

Hypothetical custom implementation showing the required methods for EntrypointLookupInterface and the additional getIntegrityData method from IntegrityDataProviderInterface to provide integrity hashes on rendered tags. In practice, the bundle wires EntrypointLookup itself.

```php
// Custom lookup implementation: only EntrypointLookup provides integrity data.
// If you implement EntrypointLookupInterface yourself and also want integrity
// hashes on rendered tags, additionally implement IntegrityDataProviderInterface:
class MyLookup implements EntrypointLookupInterface, IntegrityDataProviderInterface
{
    public function getJavaScriptFiles(string $entryName): array { /* ... */ }
    public function getCssFiles(string $entryName): array { /* ... */ }
    public function reset(): void { /* ... */ }
    public function getIntegrityData(): array { return ['path/file.js' => 'sha384-...']; }
}
```

--------------------------------

### Constructor for EntryFilesTwigExtension

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntryFilesTwigExtension.md

Constructor accepting a PSR container interface for service locator access.

```php
public function __construct(ContainerInterface $container)
```

--------------------------------

### WebpackEncoreExtension constant ENTRYPOINTS_FILE_NAME

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/WebpackEncoreBundle.md

Private constant defining the entrypoints file name used by the extension.

```php
private const ENTRYPOINTS_FILE_NAME = 'entrypoints.json';
```

--------------------------------

### doWarmUp method signature

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointCacheWarmer.md

Protected method that performs the warm-up. It takes the cache directory, an ArrayAdapter, and an optional build directory, and returns a boolean.

```php
protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter, ?string $buildDir = null): bool
```

--------------------------------

### encore_entry_script_tags(entryName, [packageName=null, entrypointName='_default', attributes=[]])

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/types.md

Renders script tags for the given entry name. Optionally specify a package name, entrypoint name, and additional HTML attributes.

```APIDOC
## encore_entry_script_tags(entryName, [packageName=null, entrypointName='_default', attributes=[]])

### Description
Renders script tags for the given entry name. Optionally specify a package name, entrypoint name, and additional HTML attributes.

### Parameters
- **entryName** (string) - Required - The name of the entry point.
- **packageName** (?string) - Optional - The package name, defaults to null.
- **entrypointName** (string) - Optional - The entrypoint name, defaults to '_default'.
- **attributes** (array<string, mixed>) - Optional - Additional HTML attributes, defaults to an empty array.

### Return
string (safe HTML)
```

--------------------------------

### PreLoadAssetsEventListener constructor

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EventListeners.md

Constructor that requires a TagRenderer instance.

```php
public function __construct(TagRenderer $tagRenderer)
```

--------------------------------

### encore_entry_link_tags(entryName, [packageName=null, entrypointName='_default', attributes=[]])

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/types.md

Renders link tags for the given entry name. Optionally specify a package name, entrypoint name, and additional HTML attributes.

```APIDOC
## encore_entry_link_tags(entryName, [packageName=null, entrypointName='_default', attributes=[]])

### Description
Renders link tags for the given entry name. Optionally specify a package name, entrypoint name, and additional HTML attributes.

### Parameters
- **entryName** (string) - Required - The name of the entry point.
- **packageName** (?string) - Optional - The package name, defaults to null.
- **entrypointName** (string) - Optional - The entrypoint name, defaults to '_default'.
- **attributes** (array<string, mixed>) - Optional - Additional HTML attributes, defaults to an empty array.

### Return
string (safe HTML)
```

--------------------------------

### encore_entry_css_files(entryName, [entrypointName='_default'])

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/types.md

Returns an array of CSS file paths for the given entry name. Use this to manually render link tags.

```APIDOC
## encore_entry_css_files(entryName, [entrypointName='_default'])

### Description
Returns an array of CSS file paths for the given entry name. Use this to manually render link tags.

### Parameters
- **entryName** (string) - Required - The name of the entry point.
- **entrypointName** (string) - Optional - The entrypoint name, defaults to '_default'.

### Return
array<string>
```

--------------------------------

### Subscribing to kernel.response events

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EventListeners.md

Shows how to implement a custom EventSubscriberInterface to hook into the kernel.response event, noting the priority relative to the bundle's internal preload listener.

```php
// Example: subscribing to the same event from userland
// would-be custom subscriber (conceptual; event classes come from http-kernel):
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

class MySubscriber implements EventSubscriberInterface
{
    public static function getSubscribedEvents(): array
    {
        return ['kernel.response' => ['onKernelResponse', 60]]; // runs after preload (50)
    }
}
```

--------------------------------

### getJavaScriptFiles() method signature

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointLookup.md

Returns the list of JavaScript file paths for the given entry, deduplicated per instance lifetime. Throws EntrypointNotFoundException in strict mode when the entry does not exist, and \InvalidArgumentException for I/O or JSON errors.

```php
public function getJavaScriptFiles(string $entryName): array
```

--------------------------------

### Check service existence before retrieval

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/ServiceContainer.md

Shows how to safely request a service that may be removed, such as when preload is disabled. The comment explains that preload: false removes the preload assets event listener.

```php
// Error handling: requesting a service that was removed
// (preload: false removes webpack_encore.preload_assets_event_listener)
if ($container->has('webpack_encore.preload_assets_event_listener')) {
    $preloadListener = $container->get('webpack_encore.preload_assets_event_listener');
}
```

--------------------------------

### EntrypointLookupCollection constructor

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointLookupCollection.md

The constructor for the EntrypointLookupCollection, requiring a container of build entrypoints and an optional default build name.

```php
public function __construct(ContainerInterface $buildEntrypoints, ?string $defaultBuildName = null)
```

--------------------------------

### renderWebpackScriptTags()

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/TagRenderer.md

Renders script tags for a given entry. Supports optional package name, entrypoint name, and extra attributes. Throws EntrypointNotFoundException if the entry is missing.

```APIDOC
## renderWebpackScriptTags()

### Description
Renders script tags for a given entry. Supports optional package name, entrypoint name, and extra attributes. Throws EntrypointNotFoundException if the entry is missing.

### Method
renderWebpackScriptTags

### Parameters
- **entryName** (string) - Required - The entry name to render.
- **packageName** (string|null) - Optional - The package name to use for asset URLs.
- **entrypointName** (string|null) - Optional - The build name (entrypoint) to use.
- **extraAttributes** (array) - Optional - Additional HTML attributes to include on the script tags.

### Return
- **string** - The HTML string containing the script tags.

### Exceptions
- **EntrypointNotFoundException** - Thrown when the entry is not found in entrypoints.json.

### Example
```php
$html = $tagRenderer->renderWebpackScriptTags('entry1');
// <script src="/build/vendor~entry1~entry2.js"></script><script src="/build/entry1.js"></script>

$htmlWithOptions = $tagRenderer->renderWebpackScriptTags(
    'entry1',
    'my_package',     // packageName
    'frontend',       // entrypointName (build)
    ['defer' => true, 'data-turbo-track' => 'reload'], // extraAttributes
);
// <script src="..." defer data-turbo-track="reload"></script>
```
```

--------------------------------

### entryExists(string $entryName, string $entrypointName = '_default'): bool

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntryFilesTwigExtension.md

Checks if an entry exists in the entrypoints data. Throws a LogicException if the resolved lookup is not an instance of EntrypointLookup.

```APIDOC
## entryExists(string $entryName, string $entrypointName = '_default'): bool

### Description
Checks if an entry exists in the entrypoints data. Throws a LogicException if the resolved lookup is not an instance of EntrypointLookup.

### Method
GET

### Endpoint
N/A (PHP method)

### Parameters
#### Path Parameters
- **$entryName** (string) - Required - Entry name
- **$entrypointName** (string) - Optional - Build name (default: '_default')

### Return
- **bool** - true when the entry exists in the entrypoints data.

### Throws
- \LogicException - when the resolved lookup is not an instance of EntrypointLookup (message: 'Cannot use entryExists() unless the entrypoint lookup is an instance of "Symfony\WebpackEncoreBundle\Asset\EntrypointLookup"')
```

--------------------------------

### encore_entry_js_files(entryName, [entrypointName='_default'])

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/types.md

Returns an array of JavaScript file paths for the given entry name. Use this to manually render script tags.

```APIDOC
## encore_entry_js_files(entryName, [entrypointName='_default'])

### Description
Returns an array of JavaScript file paths for the given entry name. Use this to manually render script tags.

### Parameters
- **entryName** (string) - Required - The name of the entry point.
- **entrypointName** (string) - Optional - The entrypoint name, defaults to '_default'.

### Return
array<string>
```

--------------------------------

### entryExists() method signature

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EntrypointLookup.md

Returns true when the entry is present under 'entrypoints' in the decoded data. Never throws for a missing entry, but can still throw I/O/JSON errors from getEntriesData().

```php
public function entryExists(string $entryName): bool
```

--------------------------------

### WebpackEncoreExtension load() method signature

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/WebpackEncoreBundle.md

Public method signature for the extension's load() method. It takes raw configs and a ContainerBuilder, returns void, and has side effects only.

```php
public function load(array $configs, ContainerBuilder $container): void
```

--------------------------------

### Configure WebpackEncoreBundle

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/doc/index.rst

The configuration file for the bundle, typically located at config/packages/webpack_encore.yaml.

```yaml
# config/packages/webpack_encore.yaml
webpack_encore:
    # The path where Encore is building the assets - i.e. Encore.setOutputPath()
    # if you customize this, you will also need to change framework.assets.json_manifest_path (it usually lives in assets.yaml)
    output_path: '%kernel.project_dir%/public/build'
    # If multiple builds are defined (as shown below), you can disable the default build:
    # output_path: false

    # Set attributes that will be rendered on all script and link tags
    script_attributes:
        defer: true
        # referrerpolicy: origin
    # link_attributes:
    #     referrerpolicy: origin

    # if using Encore.enableIntegrityHashes() and need the crossorigin attribute (default: false, or use 'anonymous' or 'use-credentials')
    # crossorigin: 'anonymous'

    # preload all rendered script and link tags automatically via the http2 Link header
    # preload: true

    # Throw an exception if the entrypoints.json file is missing or an entry is missing from the data
    # strict_mode: false

    # if you have multiple builds:
    # builds:
        # frontend: '%kernel.project_dir%/public/frontend/build'
        # or if you use a CDN:
        # frontend: 'https://cdn.example.com/frontend/build'

        # pass the build name" as the 3rd argument to the Twig functions
        # {{ encore_entry_script_tags('entry1', null, 'frontend') }}

    # Cache the entrypoints.json (rebuild Symfony's cache when entrypoints.json changes)
    # Available in version 1.2
    # Put in config/packages/prod/webpack_encore.yaml
    # cache: true
```

--------------------------------

### renderWebpackLinkTags

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/TagRenderer.md

Renders link tags for a given entry point, generating one `<link>` tag per CSS file with merged attributes and event dispatch.

```APIDOC
## renderWebpackLinkTags(string $entryName, ?string $packageName = null, ?string $entrypointName = null, array $extraAttributes = []): string

### Description
Renders `<link>` tags for the given entry point. It generates one tag per CSS file associated with the entry, with attributes merged from defaults and extras, and dispatches a `RenderAssetTagEvent` for each tag.

### Method
renderWebpackLinkTags

### Endpoint
`src/Asset/TagRenderer.php:92`

### Parameters
#### Path Parameters
- **$entryName** (string) - Required - Entry name in `entrypoints.json`
- **$packageName** (?string) - Optional - Asset package used for URL resolution
- **$entrypointName** (?string) - Optional - Build name; `null` resolves to `'_default'`
- **$extraAttributes** (array) - Optional - Per-call attributes, merged last (highest precedence)

### Request Example
```php
$tagRenderer->renderWebpackLinkTags('app', null, null, ['media' => 'print']);
```

### Response
#### Success Response (200)
- **string** - Concatenated `<link ...>` tags, one per CSS file.

#### Response Example
```html
<link rel="stylesheet" href="/build/app.css" media="print">
```
```

--------------------------------

### Equivalent HTML output for entry tags

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/doc/index.rst

This shows the HTML output generated by encore_entry_script_tags() when entry1 requires multiple files.

```html+twig
<script src="{{ asset('build/vendor~entry1~entry2.js') }}"></script>
<script src="{{ asset('build/entry1.js') }}"></script>
```

--------------------------------

### onKernelResponse method signature

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EventListeners.md

Method that handles the kernel.response event. It adds Link headers for preloading assets and populates the _links request attribute.

```php
public function onKernelResponse(ResponseEvent $event): void
```

--------------------------------

### onKernelException method signature

Source: https://github.com/symfony/webpack-encore-bundle/blob/2.x/_autodocs/api-reference/EventListeners.md

Method signature for the kernel.exception event handler that resets all configured entrypoint lookups.

```php
public function onKernelException(): void
```
Tokens:
Raw