jneyra/mvc-webpack-encore

There is no license information available for the latest version (v1.0.1) of this package.

Twig Extension compatible with Symfony Webpack Encore (Symfony2), Stable

v1.0.1 2021-10-18 21:44 UTC

Requires

• php: >=5.5
• symfony/dependency-injection: ~2.4
• twig/extensions: ~1.0

Unknown License

• Jonathan Jorge Neyra Nieves

README

We can add a new frontend development folder based on new standards and patterns, these JS code snippets can be transpiled and compiled via Webpack.

Symfony Webpack Encore

This Package pretends to be able to give compatibility to add new JS code, This code can have multiple purposes, but the main one is to be a section where to put the frontend code.

Symfony Webpack Encore wasn't available until version 3.3, if you have older versions you can try to install this package.

How to Install (Backend)

Inside the folder project, you need to run the following command to install the package via Composer CLI

$ composer require jneyra/mvc-webpack-encore:dev-master

Then Install the package and add it to your vendor's folder with:

$ composer install

These commands shouldn't display an error if there are no incompatibilities with the project.

Finally, add the following configuration in parameters.yml and services.yml inside the project.

parameters:
    web_dir: '%kernel.root_dir%/../web' # You need to define the location of your public folder
    webpack_twig_tag: 'webpack_asset' # You need to add a new asset tag to use in your 'twig' that imports the JS code

Note: These definitions may change depending on how your project is structured.

services:
    Jneyra\MvcWebpackEncore\Contracts\WebpackEncoreManifestLocatorInterface:
        alias: Jneyra\MvcWebpackEncore\Asset\WebpackEncoreManifestLocator
        public: true

    Jneyra\MvcWebpackEncore\Contracts\AssetHashInterface:
        alias: Jneyra\MvcWebpackEncore\Asset\AssetHash
        public: true

    Jneyra\MvcWebpackEncore\Asset\WebpackEncoreManifestLocator:
        class: Jneyra\MvcWebpackEncore\Asset\WebpackEncoreManifestLocator
        public: true
        arguments:
            - '%web_dir%'

    Jneyra\MvcWebpackEncore\Asset\AssetHash:
        class: Jneyra\MvcWebpackEncore\Asset\AssetHash
        public: true
        arguments:
            - '@Jneyra\MvcWebpackEncore\Asset\WebpackEncoreManifestLocator'
            - '%webpack_twig_tag%'

    Jneyra\MvcWebpackEncore\Twig\Extension\WebpackEncoreAsset:
        public: false
        class: Jneyra\MvcWebpackEncore\Twig\Extension\WebpackEncoreAsset
        arguments:
            - '@service_container'
        tags:
            - { name: twig.extension }

Note: In future updates you will no longer have to define all these services.

How to Install (Frontend)

You must create a folder inside the project where all the source code will go before transpiling with webpack

You must have NodeJS installed and manage the Encore Package:

https://symfony.com/doc/current/frontend/encore/installation.html#installing-encore-in-non-symfony-applications

Finally, Configure your Webpack File with your configs in your project

https://symfony.com/doc/current/frontend/encore/installation.html#creating-the-webpack-config-js-file

Transpile Webpack Modes

You need to install Webpack and compile your files, the compiled files will be saved in the public folder

$ npm i

Webpack Install, this command runs once to install all necessary modules

$ npm run dev

Developer mode, this command runs once and after the compilation output the bach is finished

$ npm run watch

Watch mode, after the compilation output the bach will continue "listening" for the files changes

$ npm run prod

Production mode*, compiles applying clean minification on the code ready to production deploy