piral-cli-rspack v0.15.0-beta.5313

Piral CLI rspack ·

This plugin enables using rspack as the bundler for Piral instances and pilets.

Installation

Use your favorite npm client for the installation:

npm i piral-cli-rspack --save-dev

Using

There is nothing to do. Standard commands such as piral build or pilet debug will now work with rspack as the bundler.

This plugin comes with batteries included. You don't need to install or specify your rspack version.

What's Inside

Right now it includes:

• sass-loader,
• parcel-codegen-loader,
• @rspack/plugin-html,and
• @rspack/core

As such it should be prepared to include assets (images, videos, ...), stylesheets (CSS and SASS), and work with TypeScript.

Customizing

You can still leverage your own rspack.config.js. Either just export what you want to have overwritten, e.g.,

module.exports = {
  devtool: 'inline-source-map',
};

or specify a function that is called with the already created configuration.

An example would be:

module.exports = function(config) {
  config.plugins.push(myAwesomePlugin);
  config.entry.side = ['@babel/polyfill'];
  return config;
};

Otherwise, you can also use the extend-config helper module to get the job done without having to know the internals:

const extendConfig = require('piral-cli-rspack/extend-config');

module.exports = extendConfig({
  rules: [], // adds additional rules
  removeRules: [], // removes the rules mentioned by their loader name
  plugins: [], // adds additional plugins
  removePlugins: [], // removes the plugins mentioned by their class reference
  sassLoaderOptions: {}, // sets the options for the SASS loader
});

If you want to name your rspack configuration different than rspack.config.js you can use the --config CLI option.

Example:

npx piral build --config my-rspack.js

License

Piral is released using the MIT license. For more information see the license file.