[WebpackEncoreBundle] Update recipe for Webpack Encore 5 #1341
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for the PR 😍 How to test these changes in your application
Diff between recipe versionsIn order to help with the review stage, I'm in charge of computing the diff between the various versions of patched recipes. symfony/webpack-encore-bundle1.0 vs 1.6diff --git a/symfony/webpack-encore-bundle/1.6/config/packages/test/webpack_encore.yaml b/symfony/webpack-encore-bundle/1.6/config/packages/test/webpack_encore.yaml
new file mode 100644
index 0000000..02a7651
--- /dev/null
+++ b/symfony/webpack-encore-bundle/1.6/config/packages/test/webpack_encore.yaml
@@ -0,0 +1,2 @@
+#webpack_encore:
+# strict_mode: false
diff --git a/symfony/webpack-encore-bundle/1.0/config/packages/webpack_encore.yaml b/symfony/webpack-encore-bundle/1.6/config/packages/webpack_encore.yaml
index ce02f6b..a1335c5 100644
--- a/symfony/webpack-encore-bundle/1.0/config/packages/webpack_encore.yaml
+++ b/symfony/webpack-encore-bundle/1.6/config/packages/webpack_encore.yaml
@@ -1,14 +1,25 @@
webpack_encore:
- # The path where Encore is building the assets.
- # This should match Encore.setOutputPath() in webpack.config.js.
+ # The path where Encore is building the assets - i.e. Encore.setOutputPath()
output_path: '%kernel.project_dir%/public/build'
# If multiple builds are defined (as shown below), you can disable the default build:
# output_path: false
- # if using Encore.enableIntegrityHashes() specify the crossorigin attribute value (default: false, or use 'anonymous' or 'use-credentials')
+ # If using Encore.enableIntegrityHashes() and need the crossorigin attribute (default: false, or use 'anonymous' or 'use-credentials')
# crossorigin: 'anonymous'
- # Cache the entrypoints.json (rebuild Symfony's cache when entrypoints.json changes).
- # To enable caching for the production environment, creating a webpack_encore.yaml in the config/packages/prod directory with this value set to true
- # Available in version 1.2
- #cache: false
+ # Preload all rendered script and link tags automatically via the HTTP/2 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:
+ # pass "frontend" as the 3rg arg to the Twig functions
+ # {{ encore_entry_script_tags('entry1', null, 'frontend') }}
+
+ # frontend: '%kernel.project_dir%/public/frontend/build'
+
+ # Cache the entrypoints.json (rebuild Symfony's cache when entrypoints.json changes)
+ # Put in config/packages/prod/webpack_encore.yaml
+ # cache: true1.6 vs 1.9diff --git a/symfony/webpack-encore-bundle/1.6/assets/controllers/hello_controller.js b/symfony/webpack-encore-bundle/1.9/assets/controllers/hello_controller.js
index 8c79f65..e847027 100644
--- a/symfony/webpack-encore-bundle/1.6/assets/controllers/hello_controller.js
+++ b/symfony/webpack-encore-bundle/1.9/assets/controllers/hello_controller.js
@@ -1,4 +1,4 @@
-import { Controller } from 'stimulus';
+import { Controller } from '@hotwired/stimulus';
/*
* This is an example Stimulus controller!
diff --git a/symfony/webpack-encore-bundle/1.6/config/packages/assets.yaml b/symfony/webpack-encore-bundle/1.6/config/packages/assets.yaml
deleted file mode 100644
index 051d36d..0000000
--- a/symfony/webpack-encore-bundle/1.6/config/packages/assets.yaml
+++ /dev/null
@@ -1,3 +0,0 @@
-framework:
- assets:
- json_manifest_path: '%kernel.project_dir%/public/build/manifest.json'
diff --git a/symfony/webpack-encore-bundle/1.6/config/packages/prod/webpack_encore.yaml b/symfony/webpack-encore-bundle/1.6/config/packages/prod/webpack_encore.yaml
deleted file mode 100644
index d0b3ba8..0000000
--- a/symfony/webpack-encore-bundle/1.6/config/packages/prod/webpack_encore.yaml
+++ /dev/null
@@ -1,4 +0,0 @@
-#webpack_encore:
- # Cache the entrypoints.json (rebuild Symfony's cache when entrypoints.json changes)
- # Available in version 1.2
- #cache: true
diff --git a/symfony/webpack-encore-bundle/1.6/config/packages/test/webpack_encore.yaml b/symfony/webpack-encore-bundle/1.6/config/packages/test/webpack_encore.yaml
deleted file mode 100644
index 02a7651..0000000
--- a/symfony/webpack-encore-bundle/1.6/config/packages/test/webpack_encore.yaml
+++ /dev/null
@@ -1,2 +0,0 @@
-#webpack_encore:
-# strict_mode: false
diff --git a/symfony/webpack-encore-bundle/1.6/config/packages/webpack_encore.yaml b/symfony/webpack-encore-bundle/1.9/config/packages/webpack_encore.yaml
index a1335c5..46834f0 100644
--- a/symfony/webpack-encore-bundle/1.6/config/packages/webpack_encore.yaml
+++ b/symfony/webpack-encore-bundle/1.9/config/packages/webpack_encore.yaml
@@ -4,6 +4,16 @@ webpack_encore:
# 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
+ # Uncomment (also under link_attributes) if using Turbo Drive
+ # https://turbo.hotwired.dev/handbook/drive#reloading-when-assets-change
+ # 'data-turbo-track': reload
+ # link_attributes:
+ # Uncomment if using Turbo Drive
+ # 'data-turbo-track': reload
+
# If using Encore.enableIntegrityHashes() and need the crossorigin attribute (default: false, or use 'anonymous' or 'use-credentials')
# crossorigin: 'anonymous'
@@ -23,3 +33,17 @@ webpack_encore:
# Cache the entrypoints.json (rebuild Symfony's cache when entrypoints.json changes)
# Put in config/packages/prod/webpack_encore.yaml
# cache: true
+
+framework:
+ assets:
+ json_manifest_path: '%kernel.project_dir%/public/build/manifest.json'
+
+#when@prod:
+# webpack_encore:
+# # Cache the entrypoints.json (rebuild Symfony's cache when entrypoints.json changes)
+# # Available in version 1.2
+# cache: true
+
+#when@test:
+# webpack_encore:
+# strict_mode: false
diff --git a/symfony/webpack-encore-bundle/1.6/package.json b/symfony/webpack-encore-bundle/1.9/package.json
index ba0e4f4..813010a 100644
--- a/symfony/webpack-encore-bundle/1.6/package.json
+++ b/symfony/webpack-encore-bundle/1.9/package.json
@@ -1,10 +1,10 @@
{
"devDependencies": {
- "@symfony/stimulus-bridge": "^2.0.0",
- "@symfony/webpack-encore": "^1.0.0",
+ "@hotwired/stimulus": "^3.0.0",
+ "@symfony/stimulus-bridge": "^3.0.0",
+ "@symfony/webpack-encore": "^1.7.0",
"core-js": "^3.0.0",
"regenerator-runtime": "^0.13.2",
- "stimulus": "^2.0.0",
"webpack-notifier": "^1.6.0"
},
"license": "UNLICENSED",
diff --git a/symfony/webpack-encore-bundle/1.9/post-install.txt b/symfony/webpack-encore-bundle/1.9/post-install.txt
new file mode 100644
index 0000000..6169d37
--- /dev/null
+++ b/symfony/webpack-encore-bundle/1.9/post-install.txt
@@ -0,0 +1,5 @@
+ * Install Yarn and run yarn install
+
+ * Uncomment the Twig helpers in templates/base.html.twig (they may be already)
+
+ * Start the development server: yarn encore dev-server1.9 vs 1.10diff --git a/symfony/webpack-encore-bundle/1.9/config/packages/webpack_encore.yaml b/symfony/webpack-encore-bundle/1.10/config/packages/webpack_encore.yaml
index 46834f0..4c009ee 100644
--- a/symfony/webpack-encore-bundle/1.9/config/packages/webpack_encore.yaml
+++ b/symfony/webpack-encore-bundle/1.10/config/packages/webpack_encore.yaml
@@ -25,14 +25,10 @@ webpack_encore:
# If you have multiple builds:
# builds:
- # pass "frontend" as the 3rg arg to the Twig functions
- # {{ encore_entry_script_tags('entry1', null, 'frontend') }}
-
# frontend: '%kernel.project_dir%/public/frontend/build'
- # Cache the entrypoints.json (rebuild Symfony's cache when entrypoints.json changes)
- # Put in config/packages/prod/webpack_encore.yaml
- # cache: true
+ # pass the build name as the 3rd argument to the Twig functions
+ # {{ encore_entry_script_tags('entry1', null, 'frontend') }}
framework:
assets:
diff --git a/symfony/webpack-encore-bundle/1.9/manifest.json b/symfony/webpack-encore-bundle/1.10/manifest.json
index 84ab396..39b0363 100644
--- a/symfony/webpack-encore-bundle/1.9/manifest.json
+++ b/symfony/webpack-encore-bundle/1.10/manifest.json
@@ -8,11 +8,14 @@
"package.json": "package.json",
"webpack.config.js": "webpack.config.js"
},
- "aliases": ["ux", "encore", "webpack", "webpack-encore"],
+ "aliases": ["encore", "webpack", "webpack-encore"],
"gitignore": [
"/node_modules/",
"/%PUBLIC_DIR%/build/",
"npm-debug.log",
"yarn-error.log"
- ]
+ ],
+ "conflict": {
+ "symfony/framework-bundle": "<5.4"
+ }
}
diff --git a/symfony/webpack-encore-bundle/1.9/package.json b/symfony/webpack-encore-bundle/1.10/package.json
index 813010a..d83a414 100644
--- a/symfony/webpack-encore-bundle/1.9/package.json
+++ b/symfony/webpack-encore-bundle/1.10/package.json
@@ -1,11 +1,15 @@
{
"devDependencies": {
+ "@babel/core": "^7.17.0",
+ "@babel/preset-env": "^7.16.0",
"@hotwired/stimulus": "^3.0.0",
- "@symfony/stimulus-bridge": "^3.0.0",
- "@symfony/webpack-encore": "^1.7.0",
- "core-js": "^3.0.0",
- "regenerator-runtime": "^0.13.2",
- "webpack-notifier": "^1.6.0"
+ "@symfony/stimulus-bridge": "^3.2.0",
+ "@symfony/webpack-encore": "^4.0.0",
+ "core-js": "^3.23.0",
+ "regenerator-runtime": "^0.13.9",
+ "webpack": "^5.74.0",
+ "webpack-cli": "^4.10.0",
+ "webpack-notifier": "^1.15.0"
},
"license": "UNLICENSED",
"private": true,
diff --git a/symfony/webpack-encore-bundle/1.9/post-install.txt b/symfony/webpack-encore-bundle/1.10/post-install.txt
index 6169d37..e53f05d 100644
--- a/symfony/webpack-encore-bundle/1.9/post-install.txt
+++ b/symfony/webpack-encore-bundle/1.10/post-install.txt
@@ -1,5 +1,3 @@
* Install Yarn and run yarn install
- * Uncomment the Twig helpers in templates/base.html.twig (they may be already)
-
* Start the development server: yarn encore dev-server
diff --git a/symfony/webpack-encore-bundle/1.9/webpack.config.js b/symfony/webpack-encore-bundle/1.10/webpack.config.js
index 056b04a..408012f 100644
--- a/symfony/webpack-encore-bundle/1.9/webpack.config.js
+++ b/symfony/webpack-encore-bundle/1.10/webpack.config.js
@@ -11,7 +11,7 @@ Encore
.setOutputPath('public/build/')
// public path used by the web server to access the output path
.setPublicPath('/build')
- // only needed for CDN's or sub-directory deploy
+ // only needed for CDN's or subdirectory deploy
//.setManifestKeyPrefix('build/')
/*
@@ -45,14 +45,15 @@ Encore
// enables hashed filenames (e.g. app.abc123.css)
.enableVersioning(Encore.isProduction())
- .configureBabel((config) => {
- config.plugins.push('@babel/plugin-proposal-class-properties');
- })
+ // configure Babel
+ // .configureBabel((config) => {
+ // config.plugins.push('@babel/a-babel-plugin');
+ // })
- // enables @babel/preset-env polyfills
+ // enables and configure @babel/preset-env polyfills
.configureBabelPresetEnv((config) => {
config.useBuiltIns = 'usage';
- config.corejs = 3;
+ config.corejs = '3.23';
})
// enables Sass/SCSS support1.10 vs 2.0diff --git a/symfony/webpack-encore-bundle/1.10/assets/app.js b/symfony/webpack-encore-bundle/2.0/assets/app.js
index bb0a6aa..8506504 100644
--- a/symfony/webpack-encore-bundle/1.10/assets/app.js
+++ b/symfony/webpack-encore-bundle/2.0/assets/app.js
@@ -7,6 +7,3 @@
// any CSS you import will output into a single css file (app.css in this case)
import './styles/app.css';
-
-// start the Stimulus application
-import './bootstrap';
diff --git a/symfony/webpack-encore-bundle/1.10/assets/bootstrap.js b/symfony/webpack-encore-bundle/1.10/assets/bootstrap.js
deleted file mode 100644
index 4ab2df6..0000000
--- a/symfony/webpack-encore-bundle/1.10/assets/bootstrap.js
+++ /dev/null
@@ -1,11 +0,0 @@
-import { startStimulusApp } from '@symfony/stimulus-bridge';
-
-// Registers Stimulus controllers from controllers.json and in the controllers/ directory
-export const app = startStimulusApp(require.context(
- '@symfony/stimulus-bridge/lazy-controller-loader!./controllers',
- true,
- /\.[jt]sx?$/
-));
-
-// register any custom, 3rd party controllers here
-// app.register('some_controller_name', SomeImportedController);
diff --git a/symfony/webpack-encore-bundle/1.10/assets/controllers/hello_controller.js b/symfony/webpack-encore-bundle/1.10/assets/controllers/hello_controller.js
deleted file mode 100644
index e847027..0000000
--- a/symfony/webpack-encore-bundle/1.10/assets/controllers/hello_controller.js
+++ /dev/null
@@ -1,16 +0,0 @@
-import { Controller } from '@hotwired/stimulus';
-
-/*
- * This is an example Stimulus controller!
- *
- * Any element with a data-controller="hello" attribute will cause
- * this controller to be executed. The name "hello" comes from the filename:
- * hello_controller.js -> "hello"
- *
- * Delete this file or adapt it for your use!
- */
-export default class extends Controller {
- connect() {
- this.element.textContent = 'Hello Stimulus! Edit me in assets/controllers/hello_controller.js';
- }
-}
diff --git a/symfony/webpack-encore-bundle/1.10/assets/controllers.json b/symfony/webpack-encore-bundle/1.10/assets/controllers.json
deleted file mode 100644
index a1c6e90..0000000
--- a/symfony/webpack-encore-bundle/1.10/assets/controllers.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "controllers": [],
- "entrypoints": []
-}
diff --git a/symfony/webpack-encore-bundle/1.10/manifest.json b/symfony/webpack-encore-bundle/2.0/manifest.json
index 39b0363..6c2c542 100644
--- a/symfony/webpack-encore-bundle/1.10/manifest.json
+++ b/symfony/webpack-encore-bundle/2.0/manifest.json
@@ -8,7 +8,7 @@
"package.json": "package.json",
"webpack.config.js": "webpack.config.js"
},
- "aliases": ["encore", "webpack", "webpack-encore"],
+ "aliases": ["ux", "encore", "webpack", "webpack-encore"],
"gitignore": [
"/node_modules/",
"/%PUBLIC_DIR%/build/",
@@ -16,6 +16,23 @@
"yarn-error.log"
],
"conflict": {
- "symfony/framework-bundle": "<5.4"
- }
+ "symfony/framework-bundle": "<5.4",
+ "symfony/flex": "<1.20.0 || >=2.0.0,<2.3.0"
+ },
+ "add-lines": [
+ {
+ "file": "templates/base.html.twig",
+ "content": " {{ encore_entry_script_tags('app') }}",
+ "position": "after_target",
+ "target": "{% block javascripts %}",
+ "warn_if_missing": true
+ },
+ {
+ "file": "templates/base.html.twig",
+ "content": " {{ encore_entry_link_tags('app') }}",
+ "position": "after_target",
+ "target": "{% block stylesheets %}",
+ "warn_if_missing": true
+ }
+ ]
}
diff --git a/symfony/webpack-encore-bundle/1.10/package.json b/symfony/webpack-encore-bundle/2.0/package.json
index d83a414..1d9ddc3 100644
--- a/symfony/webpack-encore-bundle/1.10/package.json
+++ b/symfony/webpack-encore-bundle/2.0/package.json
@@ -2,13 +2,11 @@
"devDependencies": {
"@babel/core": "^7.17.0",
"@babel/preset-env": "^7.16.0",
- "@hotwired/stimulus": "^3.0.0",
- "@symfony/stimulus-bridge": "^3.2.0",
- "@symfony/webpack-encore": "^4.0.0",
- "core-js": "^3.23.0",
+ "@symfony/webpack-encore": "^5.0.0",
+ "core-js": "^3.38.0",
"regenerator-runtime": "^0.13.9",
"webpack": "^5.74.0",
- "webpack-cli": "^4.10.0",
+ "webpack-cli": "^5.1.0",
"webpack-notifier": "^1.15.0"
},
"license": "UNLICENSED",
diff --git a/symfony/webpack-encore-bundle/1.10/post-install.txt b/symfony/webpack-encore-bundle/2.0/post-install.txt
index e53f05d..490195b 100644
--- a/symfony/webpack-encore-bundle/1.10/post-install.txt
+++ b/symfony/webpack-encore-bundle/2.0/post-install.txt
@@ -1,3 +1,5 @@
- * Install Yarn and run yarn install
+ * Install NPM and run npm install
- * Start the development server: yarn encore dev-server
+ * Compile your assets: npm run dev
+
+ * Or start the development server: npm run dev-server
diff --git a/symfony/webpack-encore-bundle/1.10/webpack.config.js b/symfony/webpack-encore-bundle/2.0/webpack.config.js
index 408012f..97de62c 100644
--- a/symfony/webpack-encore-bundle/1.10/webpack.config.js
+++ b/symfony/webpack-encore-bundle/2.0/webpack.config.js
@@ -22,9 +22,6 @@ Encore
*/
.addEntry('app', './assets/app.js')
- // enables the Symfony UX Stimulus bridge (used in assets/bootstrap.js)
- .enableStimulusBridge('./assets/controllers.json')
-
// When enabled, Webpack "splits" your files into smaller pieces for greater optimization.
.splitEntryChunks()
@@ -53,7 +50,7 @@ Encore
// enables and configure @babel/preset-env polyfills
.configureBabelPresetEnv((config) => {
config.useBuiltIns = 'usage';
- config.corejs = '3.23';
+ config.corejs = '3.38';
})
// enables Sass/SCSS support |
stof
reviewed
Sep 26, 2024
| @@ -2,4 +2,4 @@ | |||
|
|
|||
| * Compile your assets: <fg=green>npm run dev</> | |||
|
|
|||
| * Or start the development server: <fg=green>npm run watch</> | |||
| * Or start the development server: <fg=green>npm run dev-server</> | |||
There was a problem hiding this comment.
I would vote for keeping watch as the default suggestion as it works out of the box while dev-server requires installing an additional dependency.
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm about to release Webpack Encore 5 soon, so we must update the recipe.