piral-cli-bun
v1.0.0
Published
Provides debug and build capabilities for pilets and Piral instances using Bun.
Downloads
16
Maintainers
Readme
Piral CLI bun ·
This plugin enables using bun as the bundler for Piral instances and pilets.
Installation
bun add piral-cli-bun --dev
Note: The plugin has to be installed to tell the piral-cli
to use bun as the default bundler.
Using
There is nothing to do. Standard commands such as piral build
or pilet debug
will now work with bun as the bundler.
This plugin comes with batteries included. You don't need to install or specify your bun version - it will use what you have installed.
What's Inside
Right now it includes:
esbuild-sass-plugin
esbuild-codegen-plugin
Additionally, most known referenced assets are handled as files.
Customizing
If you want to customize the given config (e.g., to add more plugins) then create a file bun.config.js in your root directory.
In the most trivial version the file looks as follows:
module.exports = function(options) {
return options;
};
This would just receive the original build options and return them, i.e., essentially not doing anything. If you want to add some plugin you could do:
const { somePlugin } = require('bun-some-plugin');
module.exports = function(options) {
options.plugins.push(somePlugin());
return options;
};
There are no overrides applied afterwards. Therefore, what you modify will remain in the options.
License
Piral is released using the MIT license. For more information see the license file.