Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@roots/bud-api

Package Overview
Dependencies
Maintainers
0
Versions
921
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@roots/bud-api

bud.js core module

  • 6.24.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
8.8K
decreased by-14.93%
Maintainers
0
Weekly downloads
 
Created
Source

bud.js

MIT License npm Follow Roots

@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.assets

Include static assets in your compilation even if they aren't referenced in scripts or stylesheets.

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.config

bud.config allows you to extend or modify the default Webpack configuration for your project.

bud.copyDir

bud.copyDir copies a directory to the @dist directory.

bud.copyFile

bud.copyFile copies a file to the @dist directory.

bud.define

bud.define replaces variables in your application code and html templates at compile time.

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.

If you only need to modify the URL of the proxy server you should consider using bud.setProxyUrl and bud.setPublicProxyUrl.

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.

If you only need to modify the URL of the dev server you should consider using bud.setUrl and bud.setPublicUrl

bud.setProxyUrl

bud.setProxyUrl is used to specify the URL of the proxy target.

bud.setPublicProxyUrl

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.setUrl

bud.setUrl is used to specify the URL for the dev server.

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.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.

Sponsors

bud.js 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.

Carrot WordPress.com Worksite Safety Itineris

Keywords

FAQs

Package last updated on 09 Dec 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc