bud.js

Configurable, extensible build tools for modern single and multi-page web applications

Goals

bud.js wants to be:

• Reliable, yielding consistent and predictable behaviors regardless of specified options.
• Fast, leveraging parallel processing, smart caching and an asyncronous events based API to keep build times minimal.
• Extensible, with a fully featured plugin system to support an ecosystem of packaged modules.
• Simple, to get started and straight forward to maintain.

Features

• Zero config by default. Check out this codesandbox template with react, postcss modules and no config.
• Modular by design. Use only what you need.
• Multi-compiler support.
• Heckin’ fast.
• Lux developer tooling and semi-automated dependency management.
• Support for configuration files authored with TypeScript, JSON, YML, CJS and ESM.
• Support for CDNs like skypack and unpkg.
• Customizable and extensible.

Requirements

• Node 16+
• yarn 1.22 or higher
• npm 8.3 or higher
• Windows users must run bud.js under the Windows Subsystem for Linux.

Getting started

Quickly scaffold a new project with create-bud-app:

npx create-bud-app

If you want to add bud.js to an existing project or want to further customize the scaffolded app check out the Getting Started guide.

There are many example implementations available.

Modules

Presets

Presets are a collection of extensions which are commonly used together. There are currently three presets: our general preset, a WordPress specific preset, and the preset used in the roots/sage theme.

Package name	Usage	Stable Release	Preview Release
@roots/bud-preset-recommend	Docs
@roots/bud-preset-wordpress	Docs
@roots/sage	Docs

Extensions

Language support & module preprocessors

These extensions provide support for languages and syntaxes which are not understood by the browser and require compilation.

Name	README	Stable Release	Preview Release
@roots/bud-babel	Docs
@roots/bud-esbuild	Docs
@roots/bud-mdx	README
@roots/bud-postcss	Docs
@roots/bud-sass	Docs
@roots/bud-swc	Docs
@roots/bud-typescript	Docs

Optimization

These extensions optimize compiled code and static assets to help ensure a high quality user experience in your app. They are typically only run in production mode.

Name	README	Stable Release	Preview Release
@roots/bud-compress	README
@roots/bud-criticalcss	Docs
@roots/bud-imagemin	Docs
@roots/bud-purgecss	Docs

Features and framework support

These extensions provide support for popular application frameworks like React & Vue. Make sure to install a compatible compiler or preprocessor.

Name	README	Stable Release	Preview Release
@roots/bud-emotion	Docs
@roots/bud-react	Docs
@roots/bud-solid	Docs
@roots/bud-tailwindcss	Docs
@roots/bud-vue	Docs

Code quality

These extensions ensure source code conforms to a specified style. Linting configuration is expected to be provided by the user, but a base eslint config is available: @roots/eslint-config.

Name	README	Stable Release	Preview Release
@roots/bud-eslint	Docs
@roots/bud-prettier	README
@roots/bud-stylelint	Docs

WordPress specific

All of these extensions are included in @roots/bud-preset-wordpress.

Name	README	Stable Release	Preview Release
@roots/bud-tailwindcss-theme-json	README
@roots/bud-wordpress-dependencies	README
@roots/bud-wordpress-externals	README
@roots/bud-wordpress-theme-json	README

Community extensions

The following extensions are maintained by the community. Please refrain from making issues in this repo regarding these extensions.

Name	README	Stable Release
bud-embedded	README
bud-localtunnel	README
bud-wp-editor-query	README

Have you produced a bud.js extension and want to share it here? Please, create an issue sharing information about your project.

For more information on authoring your own extension consult the documentation and the source code of the extensions in this repository.

Core modules

@roots/bud is actually made up of a number of packages. You only need to install @roots/bud to use bud.js.

Package name	Usage	Stable Release	Preview Release
@roots/bud	Docs
@roots/bud-api	README
@roots/bud-build	README
@roots/bud-cache	README
@roots/bud-client	README
@roots/bud-compiler	README
@roots/bud-dashboard	README
@roots/bud-entrypoints	README
@roots/bud-extensions	README
@roots/bud-framework	README
@roots/bud-hooks	README
@roots/bud-minify	README
@roots/bud-server	README
@roots/bud-support	README

Support modules

These packages are not specific to bud.js but are used by the framework. They could be used in other projects outside of the context of bud.js.

Name	README	Stable Release	Preview Release
@roots/blade-loader	README
@roots/browserslist-config	README
@roots/container	README
@roots/critical-css-webpack-plugin	README
@roots/dependencies	README
@roots/entrypoints-webpack-plugin	README
@roots/eslint-config	README
@roots/filesystem	README
@roots/wordpress-dependencies-webpack-plugin	README
@roots/wordpress-externals-webpack-plugin	README
@roots/wordpress-hmr	README
@roots/wordpress-theme-json-webpack-plugin	README
@roots/wordpress-transforms	README

Contributing

Contributions are welcome from everyone.

We have contribution guidelines to help you get started.

License

bud.js is licensed under MIT.

Community

Keep track of development and community news.

• Join us on Roots Slack by becoming a GitHub sponsor
• Participate on the Roots Discourse
• Follow @rootswp on Twitter
• Read and subscribe to the Roots Blog
• Subscribe to the Roots Newsletter

Sponsors

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

However, the amount of effort needed to maintain and develop new features and projects within the Roots ecosystem is not sustainable without proper financial backing. If you have the capability, please consider sponsoring Roots.