@roots/bud

Powerful Block Scaffolding for WordPress
Built with ❤️

Official Website | Documentation | Change Log

Supporting

Bud is an open source project and completely free to use.

However, the amount of effort needed to maintain and develop new features and products within the Roots ecosystem is not sustainable without proper financial backing. If you have the capability, please consider donating using the links below:

Overview

Bud is an extendable, zero configuration scaffolding CLI for WordPress editor blocks, also known as Gutenberg.

Requirements

Requirement	Version
PHP	>=7.2
Node	>=12

Usage

Bud is currently pre-release. But, you can try it out now:

npx @roots/bud@1.0.0-rc.7 init [project-dir]

This will initialize your project and install @roots/bud as a local dev dependency.

After initializing, you might try additional generators to kick-start your dev process.

Select from a list of available generators:

yarn bud generate

Run a particular generator by name:

yarn bud generate block

If you are using Bud in order to build a plugin for the WordPress block editor, you can get started with a recommended preset rather than running several generators manually:

yarn bud preset wp-plugin

This is equivalent to:

yarn bud generate wp-plugin
yarn bud generate block
yarn bud generate wp-editor-component-image
yarn bud generate wp-editor-extension

You can write your own custom generators and presets or install/share them by writing a plugin for Bud.

Documentation forthcoming. For now, you can run yarn bud list to see what is available out-of-the-box.

All commands:

Command	Description
bud	Bud CLI
bud generate	Run a generator.
bud init	Create a new project
bud list	List available budfiles
bud preset	Run a preset.

Dependencies

• @roots/bud-generators
• arr-rotate
• chalk
• enquirer
• esm
• execa
• find-plugins
• fs-extra
• globby
• handlebars
• handlebars-helpers
• ink
• ink-link
• ink-spinner
• ink-text-input
• ink-use-stdout-dimensions
• lodash
• pastel
• prettier
• prop-types
• react
• resolve-pkg
• rxjs

Development dependencies

• babel-eslint
• eslint
• eslint-plugin-react
• eslint-plugin-react-hooks
• husky
• markdownlint-cli
• npm-run-all

Contributing

Contributions are welcome from everyone.

We have contributing guidelines to help you get started.

Bud sponsors

Help support our open-source development efforts by becoming a patron.

Community

Keep track of development and community news.

• Participate on the Roots Discourse
• Follow @rootswp on Twitter
• Read and subscribe to the Roots Blog
• Subscribe to the Roots Newsletter
• Listen to the Roots Radio podcast