heimrichhannot/contao-encore-bundle

This bundle brings deep integration for symfony encore into contao. On the one hand, your can prepare your bundles to define own webpack entries, which added with just one command to your webpack entries. On the other hand, this bundle allows you to add encore entries only on the pages you need the

2.0.0 2024-02-19 10:29 UTC

Requires

• php: ^8.1
• composer-runtime-api: ^2.0
• ext-json: *
• contao/core-bundle: ^4.13 || ^5.0
• heimrichhannot/contao-encore-contracts: ^1.0
• heimrichhannot/contao-multi-column-editor-bundle: ^2.0
• heimrichhannot/contao-utils-bundle: ^2.231.0 || ^3.0
• symfony/cache: ^5.4 || ^6.0
• symfony/config: ^5.4 || ^6.0
• symfony/console: ^5.4 || ^6.0
• symfony/dependency-injection: ^5.4 || ^6.0
• symfony/filesystem: ^5.4 || ^6.0
• symfony/http-foundation: ^5.4 || ^6.0
• symfony/http-kernel: ^5.4 || ^6.0
• symfony/translation: ^5.4 || ^6.0
• symfony/translation-contracts: ^1.1.6 || ^2.0 || ^3.0
• symfony/webpack-encore-bundle: ^1.0 || ^2.0
• twig/twig: ^1.38.3 || ^2.7 || ^3.0

Requires (Dev)

• contao/manager-plugin: ^2.0
• contao/test-case: ^4.0 || ^5.0
• friendsofphp/php-cs-fixer: ^2.2
• heimrichhannot/contao-test-utilities-bundle: ^0.1.4
• php-coveralls/php-coveralls: ^2.0
• phpstan/phpstan: ^1.8
• phpstan/phpstan-symfony: ^1.2
• phpunit/phpunit: ^8.0 || ^9.0
• symfony/phpunit-bridge: ^3.2 || ^4.0 || ^5.0 || ^6.0

LGPL-3.0-or-later

• Heimrich & Hannot GmbH

README

Use the power and simplicity of symfony webpack encore in contao. This bundle let you decide on layout and page level, which encore entries should be loaded. If you want more, you can prepare your bundles define their own encore entries, so never need to manually add or remove encore entries again.

Features

• use symfony encore (symfony/webpack-encore and symfony/webpack-encore-bundle) to enhance your contao assets workflow
• conditionally load your assets only if necessary (entrypoints can be activated in the backend in layout and page setting or added from your bundle code (e.g. in a frontend module))
• prepare your bundles to add encore entries when install them and strip assets from the contao global asset arrays

Setup

Prerequisites

• Read the Encore Documentation in order to install Encore and understand the core concepts of Webpack and Symfony Encore.

Prepare your project and bundle

Setup your project for encore bundle:

➡️ Project setup

➡️ Bundle setup

Run Encore

1. Run encore prepare command

   php vendor/bin/contao-console huh:encore:prepare
   

2. If (yarn) dependencies have changed, run yan install

   yarn install
   

3. Run encore to generate the assets

   yarn encore dev
   

4. Activate encore entries in the contao backend (if not added from code)

Usage

Activate encore entries

1. In the contao backend, go to page layout configuration
2. Check "Activate Webpack Encore" and fill the mandatory fields
3. If you have a main project bundle entry containing the main stylesheets, add it as active entry, add also all other entries you want to have activated on every page.
4. For page specific features, you can activate additional entries in page setting (site structure).
   • Be aware, that child pages will inherit settings from their parants
   • Pay attention that you check entries as active (if you want them to be loaded)!
   • If you want an already added entry to be not loaded on an specific page, select it as entry and don't check "active".

Prepare command

php vendor/bin/contao-console huh:encore:prepare

The prepare command must be executed after every change to the encore entries configuration, e.g. after a composer update or changes to that configurations in your own code.

The command collect encore entries from all bundle and creates a file called encore.bundles.js in your project root. This file contains entries for all contao encore compatible bundles that are added by calling encoreBundles.addEntries(); in your webpack.config.js.

It also collects the dependencies from the package.json files of bundles have EncoreExtensions registered and adds them to the project dependencies.

Description:
  Does the necessary preparation for contao encore bundle. Needs to be called after changes to bundle encore entries.

Usage:
  huh:encore:prepare [options]
  encore:prepare

Options:
      --skip-entries[=SKIP-ENTRIES]  Add a comma separated list of entries to skip their generation. [default: false]

Run encore

Run encore to generate/compile your assets.

yarn encore dev 
yarn encore dev --watch 
yarn encore prod

Documentation

Project setup - Prepare your contao project for use with encore and encore bundle

Bundle setup - Add encore bundle support to your bundle

Setup Javascript - Help about setting up your encore entries

Developer Documentation

Configuration Reference