From 580a01b5509d2a6f290cef946a5484702e3bc92e Mon Sep 17 00:00:00 2001 From: Pamela Ribeiro <55361215+pamprn09@users.noreply.github.com> Date: Wed, 31 May 2023 14:22:01 -0300 Subject: [PATCH 1/2] Update getting-started.md --- docs/guides/getting-started.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/guides/getting-started.md b/docs/guides/getting-started.md index 506d6c5..88dcb83 100644 --- a/docs/guides/getting-started.md +++ b/docs/guides/getting-started.md @@ -16,10 +16,19 @@ npm install --save-dev @humanmade/webpack-helpers While this package depends in turn on a number of loaders and plugins, it deliberately does _not_ include `webpack` itself. To install this library along with all its relevant peer dependencies, therefore, you may run the following command: +** *Check notice before proceeding:** ```bash npm install --save-dev @humanmade/webpack-helpers webpack@4 webpack-cli@3 webpack-dev-server sass ``` +***❗ *Notice*** +This verson is outdated and might leave you with outdated versions of this library and associated Webpack tooling. +There's a [pending release](https://github.com/humanmade/webpack-helpers/pull/205) that will fix this problem. But for now you should install humanmade/webpack-helpers@beta, webpack @5, webpack-cli@4, and webpack-dev-server@4. To do so runu the following command: +```bash +npm install --save-dev @humanmade/webpack-helpers@beta webpack@5 webpack-cli@4 webpack-dev-server@4 +``` + + Note that we specify Webpack version 4. Support for Webpack 5 is anticipated in the v1.0 release of these helpers, but at present using Webpack 4 provides the most predictable and stable experience across our projects. ## Configuring Webpack From ab0b9a1a12c33c4104f4663b8ca5613beba092b4 Mon Sep 17 00:00:00 2001 From: Pamela Ribeiro <55361215+pamprn09@users.noreply.github.com> Date: Wed, 31 May 2023 15:15:03 -0300 Subject: [PATCH 2/2] Moved line above notice --- docs/guides/getting-started.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/guides/getting-started.md b/docs/guides/getting-started.md index 88dcb83..d184e87 100644 --- a/docs/guides/getting-started.md +++ b/docs/guides/getting-started.md @@ -21,16 +21,15 @@ While this package depends in turn on a number of loaders and plugins, it delibe npm install --save-dev @humanmade/webpack-helpers webpack@4 webpack-cli@3 webpack-dev-server sass ``` +Note that we specify Webpack version 4. Support for Webpack 5 is anticipated in the v1.0 release of these helpers, but at present using Webpack 4 provides the most predictable and stable experience across our projects. + ***❗ *Notice*** This verson is outdated and might leave you with outdated versions of this library and associated Webpack tooling. -There's a [pending release](https://github.com/humanmade/webpack-helpers/pull/205) that will fix this problem. But for now you should install humanmade/webpack-helpers@beta, webpack @5, webpack-cli@4, and webpack-dev-server@4. To do so runu the following command: +There's a [pending release](https://github.com/humanmade/webpack-helpers/pull/205) that will fix this problem. But for now you should install humanmade/webpack-helpers@beta, webpack @5, webpack-cli@4, and webpack-dev-server@4. To do so run the following command: ```bash npm install --save-dev @humanmade/webpack-helpers@beta webpack@5 webpack-cli@4 webpack-dev-server@4 ``` - -Note that we specify Webpack version 4. Support for Webpack 5 is anticipated in the v1.0 release of these helpers, but at present using Webpack 4 provides the most predictable and stable experience across our projects. - ## Configuring Webpack By convention we generally put our Webpack configuration in a `.config/` folder in the project root. If you're working on a specific theme or plugin the project root may be the theme or plugin folder root, but on an Altis or WordPress VIP project the project root is likely to be the `wp-content` root or a folder outside your web root entirely. By putting your Webpack configuration at this higher level, one Webpack build command or dev server instance may be used to bundle the assets for multiple relates themes and plugins.