woocommerce/plugins/woocommerce-blocks
Alexandre Lara 3ecd34e01a Upgrade webpack to version 5 (https://github.com/woocommerce/woocommerce-blocks/pull/8013)
* Upgrade terser-webpack-plugin to version 4.2.3

* Upgrade webpack-bundle-analyzer to 4.7.0

* Upgrade to Webpack version 5

* Upgrade @wordpress/dependency-extraction-webpack-plugin to 4.6.0

* Upgrade dependency copy-webpack-plugin to version 11.0.0

* Upgrade dependency terser-webpack-plugin to version 5.3.6

* Replace webpack-rtl-plugin with the new @automattic/webpack-rtl-plugin

* Replace module.issuer with the new ModuleGraph API

There is a warning appearing in the console when running the application. This is due to the fact that the module.issuer has been deprecated on Webpack 5 and replaced with the new ModuleGraph API. This commit replaces the deprecated API with the new one.

* Upgrade babel and babel plugins to latest version

* Replace jsonpFunction with the new uniqueName property

Add a unique name of the webpack build to avoid multiple webpack runtimes to conflict when using globals. It defaults to output.library name or the package name from package.json in the context, if both aren't found, it is set to an ''.

* Replace cacheDirectory inline configuration with options.cacheDirectory

* Upgrade @wordpress/e2e-tests dependency to version 5.6.0

* Remove babel-plugin-transform-react-jsx dependency

Remove babel-plugin-transform-react-jsx dependency because it is already included in @wordpress/babel-preset-default

* Remove unnecessary Babel dependencies

Remove some unnecessary babel dependencies that are already included in the @babel/preset-env package.

* Upgrade puppeteer dependency to version 16.2.0

* Remove caret from package.json dependencies

* Fix Storybook build error

This commit fixes the Storybook build error that was being caused because of Storybook by default uses Webpack 4, but since we are currently upgrading our webpack to version 5, we need to install some required dependencies and also explicitly tell Storybook to use Webpack 5.

* Fix package-lock.json after merging with trunk

* Add own webpack-rtl-plugin implementation to the project

Before upgrading Webpack to version 5, we were using the original `webpack-rtl-plugin` released by Romain Berger; unfortunately, this plugin is not compatible with Webpack 5, so we replaced it with `@automattic/webpack-rtl-plugin`. The problem is that `@automattic/webpack-rtl-plugin` by default generates files with the '.rtl.css' suffix and does not provide a way to change that.

This commit adds our own implementation of the `webpack-rtl-plugin` (adapted from `@automattic/webpack-rtl-plugin`) that is compatible with Webpack 5 and allows us to change the suffix of the generated files to follow the recommended way defined by Wordpress (https://codex.wordpress.org/Right-to-Left_Language_Support)

* Change conditional clause to be multiline

* Fix package-lock.json after merge with trunk

* Fix package-lock.json after merge with trunk

* Rename files to fix ESLint errors

This commit renames files that have the .js extension but contain JSX code. This is causing ESLint to throw errors because by default our Eslint configuration expects only files with the .jsx extension to contain JSX code.

* Fix package-lock.json file

* Add is-plain-obj module to the transformIgnorePatterns of jest config

* Update package-lock.json

* Fix package-lock.json

* Upgrade @wordpress/i18n dependency to version 4.31.0

* Update package-lock.json

* Update composer lock file

* Fix Webpack config for Webpack 5

* Add the package-lock.json

* Remove unsupported config from webpack

* Fix error with Webpack build

* Add wait for network idle to the tests

* Attempt to fix e2e test

* Restore promise.all

* Upgrade puppeteer to v17.1.3

* Upgrade expect-puppeteer

* Update expect-puppeteer

* Downgrade expect-puppeteer

* Revert "Upgrade puppeteer to v17.1.3"

This reverts commit 61ed52a56f131961f3970b6fb22cdd8b540bada3.

* Upgrade Puppeteer to version 17.1.3

* Fix executionContext.frame is not a function error

* Fix e2e tests

* Remove isExperimentalBuild from Product Gallery inner blocks

* Upgrade Webpack and Webpack-cli to latest version

* Upgrade postcss and mini-css plugins

* Fix error with mini-cart block

* Fix styling error with filter blocks

* Fix issue when running unit tests

* Fix storybook script not loading

* Fix a11y issue in Storybook

* Fix error when multiple isExperimentalBuild was being used

* Prevent error when layout is not present in the attributes object

* Update `chunkIds` to `named` in Webpack

* Add cache groups to the Webpack configs
2023-09-20 17:31:52 -03:00
..
.github Revert "Fix: use correct bump strategy for Assign Milestone workflow (https://github.com/woocommerce/woocommerce-blocks/pull/10805) (https://github.com/woocommerce/woocommerce-blocks/pull/10962) 2023-09-15 13:20:16 +07:00
.husky Update Husky config to v8 (https://github.com/woocommerce/woocommerce-blocks/pull/9150) 2023-04-21 10:07:55 +02:00
.sources Update previews and editor styles for cart and checkout blocks (https://github.com/woocommerce/woocommerce-blocks/pull/2160) 2020-04-08 16:03:39 +01:00
.vscode Fix ESLint errors (https://github.com/woocommerce/woocommerce-blocks/pull/7556) 2022-11-02 17:46:14 +01:00
.wordpress-org Update WooCommerce Blocks brand assets (https://github.com/woocommerce/woocommerce-blocks/pull/10622) 2023-08-16 14:15:20 +01:00
assets Upgrade webpack to version 5 (https://github.com/woocommerce/woocommerce-blocks/pull/8013) 2023-09-20 17:31:52 -03:00
bin Upgrade webpack to version 5 (https://github.com/woocommerce/woocommerce-blocks/pull/8013) 2023-09-20 17:31:52 -03:00
docs Upgrade webpack to version 5 (https://github.com/woocommerce/woocommerce-blocks/pull/8013) 2023-09-20 17:31:52 -03:00
images Refactor Cart and Checkout Page Templates (https://github.com/woocommerce/woocommerce-blocks/pull/10773) 2023-09-19 10:58:18 +01:00
packages Update `postcode-validator` to 3.8.15 to validate "new" Taiwanese postcodes (https://github.com/woocommerce/woocommerce-blocks/pull/10924) 2023-09-15 07:05:01 -07:00
patches Revert "Remove Combobox patch (https://github.com/woocommerce/woocommerce-blocks/pull/6465)" (https://github.com/woocommerce/woocommerce-blocks/pull/6531) 2022-06-07 14:09:50 +02:00
patterns [Store Customization] Update patterns to use the AI selected verticals for images (https://github.com/woocommerce/woocommerce-blocks/pull/10796) 2023-09-19 09:05:44 +02:00
src Feature Branch: Blockified Order Confirmation (https://github.com/woocommerce/woocommerce-blocks/pull/10056) 2023-09-20 13:56:00 +01:00
storybook Upgrade webpack to version 5 (https://github.com/woocommerce/woocommerce-blocks/pull/8013) 2023-09-20 17:31:52 -03:00
templates Refactor Cart and Checkout Page Templates (https://github.com/woocommerce/woocommerce-blocks/pull/10773) 2023-09-19 10:58:18 +01:00
tests Upgrade webpack to version 5 (https://github.com/woocommerce/woocommerce-blocks/pull/8013) 2023-09-20 17:31:52 -03:00
.distignore Rename commands and directories for Playwright and JEST e2e tests (https://github.com/woocommerce/woocommerce-blocks/pull/10493) 2023-08-08 17:58:12 +01:00
.editorconfig Update MD editor config (https://github.com/woocommerce/woocommerce-blocks/pull/7968) 2022-12-19 12:06:48 +00:00
.env Update relevant files due to L2->L0 policy change for minimum required versions. (https://github.com/woocommerce/woocommerce-blocks/pull/4484) 2021-07-29 10:52:34 -04:00
.eslintignore Rename commands and directories for Playwright and JEST e2e tests (https://github.com/woocommerce/woocommerce-blocks/pull/10493) 2023-08-08 17:58:12 +01:00
.eslintrc.js Refactor errors util to TypeScript, minor typing fixes (https://github.com/woocommerce/woocommerce-blocks/pull/10754) 2023-08-30 18:56:28 +12:00
.gitattributes Revert "Remove .gitattributes file (https://github.com/woocommerce/woocommerce-blocks/pull/5242)" (https://github.com/woocommerce/woocommerce-blocks/pull/6049) 2022-03-14 12:42:34 +00:00
.gitignore Rename commands and directories for Playwright and JEST e2e tests (https://github.com/woocommerce/woocommerce-blocks/pull/10493) 2023-08-08 17:58:12 +01:00
.markdownlint.json Upgrade wp-prettier to 2.6.2 and reformat the codebase (https://github.com/woocommerce/woocommerce-blocks/pull/6566) 2022-06-15 11:56:52 +02:00
.markdownlintignore Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) 2022-06-09 17:52:19 +02:00
.nvmrc Bump Node version to 16.15.0 (https://github.com/woocommerce/woocommerce-blocks/pull/8885) 2023-03-28 13:49:20 -03:00
.prettierignore Create 2e2 tests for Cross-Sells block (https://github.com/woocommerce/woocommerce-blocks/pull/6983) 2022-09-21 13:29:16 +07:00
.prettierrc.js Update @wordpress/scripts and eslint and stylint configurations (https://github.com/woocommerce/woocommerce-blocks/pull/3749) 2021-01-27 11:49:33 -05:00
.stylelintrc.json Enable declaration-block-no-duplicate-properties stylelint rule (https://github.com/woocommerce/woocommerce-blocks/pull/10163) 2023-07-11 13:03:05 +00:00
.wp-env.json Fix: Adjust Playwright E2E tests for WP 6.3 (https://github.com/woocommerce/woocommerce-blocks/pull/10516) 2023-08-11 06:28:38 +07:00
LICENSE Create LICENSE (https://github.com/woocommerce/woocommerce-blocks/pull/4235) 2021-05-20 15:07:12 +01:00
README.md Update README.md 2023-07-27 12:29:39 +03:00
babel.config.js Migrate Storybook to 6.4.0 and enable auto-detection of controls (https://github.com/woocommerce/woocommerce-blocks/pull/5249) (https://github.com/woocommerce/woocommerce-blocks/pull/5264) 2021-12-01 12:28:27 +01:00
checkstyle.xml Migrate Block Title component to TypeScript (https://github.com/woocommerce/woocommerce-blocks/pull/9712) 2023-06-13 16:30:57 +05:30
composer.json Release: 11.1.1 (https://github.com/woocommerce/woocommerce-blocks/pull/11000) 2023-09-20 12:17:32 +02:00
composer.lock Updated composer.lock (https://github.com/woocommerce/woocommerce-blocks/pull/10936) 2023-09-14 14:51:23 +01:00
docker-compose.yml Add PHP 8.1/8.2 to unit testing matrix (https://github.com/woocommerce/woocommerce-blocks/pull/8757) 2023-04-21 12:07:37 +01:00
global.d.ts Add camelcase rule to eslint config (https://github.com/woocommerce/woocommerce-blocks/pull/4382) 2021-07-09 17:53:45 +01:00
package-lock.json Upgrade webpack to version 5 (https://github.com/woocommerce/woocommerce-blocks/pull/8013) 2023-09-20 17:31:52 -03:00
package.json Upgrade webpack to version 5 (https://github.com/woocommerce/woocommerce-blocks/pull/8013) 2023-09-20 17:31:52 -03:00
phpcs.xml Comment: Indicate min WP version for WooCommerce Core, not Blocks. 2023-09-12 16:43:29 +01:00
phpunit.xml.dist Add PHP 8.1/8.2 to unit testing matrix (https://github.com/woocommerce/woocommerce-blocks/pull/8757) 2023-04-21 12:07:37 +01:00
postcss.config.js
readme.txt Release: 11.1.1 (https://github.com/woocommerce/woocommerce-blocks/pull/11000) 2023-09-20 12:17:32 +02:00
tsconfig.base.json Interactivity API and Product Button (https://github.com/woocommerce/woocommerce-blocks/pull/10006) 2023-08-10 14:02:33 +00:00
tsconfig.json Add Product Image Gallery (https://github.com/woocommerce/woocommerce-blocks/pull/8235) 2023-02-14 14:21:48 +01:00
webpack.config.js Fix: load blocks style separately for classic themes (https://github.com/woocommerce/woocommerce-blocks/pull/10758) 2023-09-08 11:15:48 +07:00
woocommerce-gutenberg-products-block.php Release: 11.1.1 (https://github.com/woocommerce/woocommerce-blocks/pull/11000) 2023-09-20 12:17:32 +02:00
wp-cli.yml Improve the E2E testing process with Playwright (https://github.com/woocommerce/woocommerce-blocks/pull/9148) 2023-05-05 11:03:36 +00:00

README.md

WooCommerce Blocks

Latest Tag View JavaScript and CSS Linting PHP Coding Standards Unit Tests E2E Tests

This is the feature plugin for WooCommerce + Gutenberg. This plugin serves as a space to iterate and explore new Blocks and updates to existing blocks for WooCommerce, and how WooCommerce might work with the block editor.

Use this plugin if you want access to the bleeding edge of available blocks for WooCommerce. However, stable blocks are bundled into WooCommerce, and can be added from the "WooCommerce" section in the block inserter.

Table of Contents

Documentation

To find out more about the blocks and how to use them, check out the documentation on WooCommerce.com.

If you want to see what we're working on for future versions, or want to help out, read on.

Code Documentation

  • Blocks - Documentation for specific Blocks.
  • Editor Components - Shared components used in WooCommerce blocks for the editor (Gutenberg) UI.
  • WooCommerce Blocks Handbook - Documentation for designers and developers on how to extend or contribute to blocks, and how internal developers should handle new releases.
  • WooCommerce Blocks Storybook - Contains a list and demo of components used in the plugin.

Installing the plugin version

We release a new version of WooCommerce Blocks onto WordPress.org every few weeks, which can be used as an easier way to preview the features.

Note: The plugin follows a policy of supporting the "L0" strategy for version support. What this means is that the plugin will require the most recent version of WordPress, and the most recent version of WooCommerce core at the time of a release. You can read more about this policy here.

  1. Make sure you have the latest available versions of WordPress and WooCommerce on your site.
  2. The plugin version is available on WordPress.org. Download the plugin version here.
  3. Activate the plugin.

Installing the development version

  1. Make sure you have the latest versions of WordPress and WooCommerce on your site.
  2. Get a copy of this plugin using the green "Clone or download" button on the right.
  3. Make sure you're using Node.js v16.15. If you use a Node version management tool such as nvm or n, you can do so by running nvm use or n auto, respectively.
  4. npm install to install the dependencies.
  5. composer install to install core dependencies.
  6. To compile the code, run any of the following commands
    1. npm run build (production build).
    2. npm run dev (development build).
    3. npm start (development build + watching for changes).
  7. Activate the plugin.

The source code is in the assets/ folder and the compiled code is built into build/.

Getting started with block development

Run through the "Writing Your First Block Type" tutorial for a quick course in block-building.

For deeper dive, try looking at the core blocks code, or see what components are available.

To begin contributing to the WooCommerce Blocks plugin, see our getting started guide and developer handbook.

Other useful docs to explore:

Long-term vision

WooCommerce Blocks are the easiest, most flexible way to build your store user interface and showcase your products.