woocommerce/DEVELOPMENT.md

Development

This document aims to provide as much context as possible to aid in the development of plugins, packages, and tools in the monorepo.

Getting Started

Please refer to the Getting Started section of the README.md for a general-purpose guide on getting started. The rest of this document will assume that you've installed all of the prequisites and setup described there.

Turborepo Commands

Our repository uses Turborepo for build and test commands. This tool ensures that all dependencies of a plugin, package, or tool are prepared before running a command. This is done transparently when running these commands. When using pnpm run {command} without any options, it will execute that command against every project in the repository. You can view a list of the commands Turborepo supports in our turbo.json file.

Plugin, Package, and Tool Filtering

If you are interested in running a turbo command against a single plugin, package, or tool, you can do so with the --filter flag. This flag supports the "name" option in package.json files, paths, and globs.

If you would like to read more about the syntax, please check out the Turborepo filtering documentation.

Examples

Here are some examples of the ways you can use Turborepo / pnpm commands:

# Lint and build all plugins, packages, and tools. Note the use of `-r` for lint,
# turbo does not run the lint at this time.
pnpm run -r lint && pnpm run build 

# Build WooCommerce Core and all of its dependencies
pnpm run build --filter='woocommerce'

# Lint the @woocommerce/components package - note the different argument order, turbo scripts
# are not running lints at this point in time.
pnpm run -r --filter='@woocommerce/components' lint 

# Test all of the @woocommerce scoped packages
pnpm run test --filter='@woocommerce/*'

# Build all of the JavaScript packages
pnpm run build --filter='./packages/js/*'

# Build everything except WooCommerce Core
pnpm run build --filter='!woocommerce' 

# Build everything that has changed since the last commit
pnpm run build --filter='[HEAD^1]'

Cache busting Turbo

In the event that you need to force turbo not to cache a command you can set the env variable TURBO_FORCE=true.

e.g.

# Force an uncached build of WooCommerce Core and all of its dependencies
TURBO_FORCE=true pnpm run build --filter='woocommerce'

Other Commands

Outside of the commands in our turbo.json file, each plugin, package, and tool may have unique scripts in their package.json files. In these cases, you can execute those commands using pnpm {script} and the same --filter syntax as Turborepo.

Examples

Here are some examples of the commands you will make use of.

# Add a changelog entry for WooCommerce Core
pnpm changelog add --filter=woocommerce

# Create the woocommerce.zip file
pnpm build:zip --filter=woocommerce

Plugin Development Environments

The plugins in our repository make use of the @wordpress/env package. This supplies convenient commands for creating, destroying, cleaning, and testing WordPress environments.

# Make sure you are in the working directory of the plugin you are interested in setting up the environment for
cd plugins/woocommerce
# Start will create the environment if necessary or start an existing one
pnpm -- wp-env start
# Stop will, well, stop the environment
pnpm -- wp-env stop
# Destroy will remove all of the environment's files.
pnpm -- wp-env destroy

Each of the plugins in our repository support using this tool to spin up a development environment. Note that rather than having a single top-level environment, each plugin has its own. This is done in order to prevent conflicts between them.

Please check out the official documentation if you would like to learn more about this tool.