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.2 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:
yarn generate plugin
yarn generate block
But, you can also write your own custom generators, or install/share them by writing a bud-plugin
.
Documentation forthcoming. For now, you can run yarn generate:list
to see what is available out-of-the-box.
All commands:
Command | Description |
---|
bud | Bud information |
bud init | Create a new project |
bud generate | Generate code from a budfile |
bud list | List available budfiles |
Dependencies
- enquirer
- esm
- execa
- fs-extra
- handlebars
- handlebars-helpers
- ink
- ink-link
- ink-spinner
- ink-table
- ink-use-stdout-dimensions
- next-pino
- node-fetch
- pastel
- pino
- pino-pretty
- prettier
- prop-types
- react
- rxjs
Development dependencies
- babel-eslint
- eslint
- eslint-plugin-jsx-a11y
- eslint-plugin-react
- eslint-plugin-react-hooks
- globby
- husky
- ink-divider
- markdownlint-cli
- npm-run-all
- tree-node-cli
Roadmap
HMR
bud component
bud extension
Contributing
Contributions are welcome from everyone.
We have contributing guidelines to help you get started.
Help support our open-source development efforts by becoming a patron.
![Carrot](https://cdn.roots.io/app/uploads/carrot.svg)
Keep track of development and community news.