@roots/bud-api

bud.js core module

Installation

Install @roots/bud-api to your project.

Yarn:

yarn add @roots/bud-api --dev

npm:

npm install @roots/bud-api --save-dev

API

For full documentation refer to bud.js.org/docs.

bud.compilePaths

bud.compilePaths is used to specify directories which should be treated as source directories.

If you have errors which say something along the lines of You may need an appropriate loader to handle this file type, currently no loaders are configured to process this file., this is probably the function you want to use to fix that!

By default, bud.js treats code outside of the @src directory (likely modules downloaded via npm or yarn) as code that has already been bundled by some other means. This is a huge performance boost for your project! If that code was already compiled by the package author it would be a waste of time and energy to compile it again.

However, some authors may publish uncompiled source code with the expectation that you will transpile it as part of your build process. This function simplifies the process of configuring bud.js to handle these cases.

bud.entry

bud.entry is used to specify and group assets to include in the compilation.

If no entrypoint is provided bud.js will attempt to compile src/index.js to dist/main.js.

bud.html

bud.html is used to configure your application's HTML wrapper.

bud.provide

bud.provide makes a variable or module available throughout the entire application.

bud.proxy

bud.proxy is a method that configures a proxy server for your development environment. This is useful when you need to proxy requests to a backend server, such as a WordPress site.

bud.serve

bud.serve is used to configure the development server.

You don't need to call this function unless you want to change the default server configuration.

bud.setPublicUrl

bud.setPublicUrl is used to specify the site-accessible URL for the dev server (if it differs from the internal URL).

For example: a dockerized app that needs to be accessible from the host at http://example.test but serves over http://0.0.0.0:8080.

bud.setPublicUrl

bud.setPublicProxyUrl is used to specify the site-accessible URL for the proxy server (if it differs from the internal URL).

For example: a dockerized app that has a service which needs to be accessible from the host at http://example.test but serves over http://0.0.0.0.

bud.watch

bud.watch is used to specify files which will trigger a full browser reload when changed.

Contributing

Contributions are welcome from everyone.

We have contribution guidelines to help you get started.

License

@roots/bud-api 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.