Sweet Pea

Sweet Pea is the build tool for Open Social themes and modules. Using a single build tool provides consistent output and capabilities for all themes and modules.

Installation

Install Sweet Pea as a development dependency in your current project or as a global dependency on your system.

# Local development installation 
yarn add -D sweet-pea
# Global installation
yarn global add sweet-pea

TODO: Publish Sweet Pea on NPM

Usage

In the below examples we use npx to run commands from the Sweet Pea package without a full path. Alternatively you can add the commands to the scripts object of your package.json file without npx prefix and execute the commands using yarn.

TODO: Add list of supported commands.

TODO: Add example scripts snippet for common build and dev tasks.

TODO: Describe contributor workflow and implement Jest snapshot testing for js/css output.

TODO: Add README for the build-tools/cli/core packages.

TODO: Add the conventional-changelog for changelog generation