1.0.0 • Published 10 months ago

piral-cli-rollup v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

Piral Logo

Piral CLI Rollup · GitHub License npm version tested with jest Gitter Chat

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

Installation

Use your favorite npm client for the installation:

npm i piral-cli-rollup --save-dev

Note: If you don't install any bundler for use in piral-cli then piral-cli-rollup will be automatically installed for you.

Using

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

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

What's Inside

Right now it includes:

  • @rollup/plugin-commonjs
  • @rollup/plugin-node-resolve
  • @rollup/plugin-replace
  • @rollup/plugin-url
  • @rollup/plugin-typescript
  • rollup-plugin-codegen
  • rollup-plugin-postcss

Additionally, most known referenced assets are handled as files.

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

Customizing

If you want to customize the given config (e.g., to add more plugins) then create a file rollup.config.js in your root directory.

In the most trivial version the file looks as follows:

module.exports = function(config) {
  return config;
};

This would just receive the original build config and return them, i.e., essentially not doing anything. If you want to add some plugin you could do:

const fooPlugin = require('rollup-plugin-foo');

module.exports = function(config) {
  config.plugins.push(fooPlugin());
  return options;
};

There are no overrides applied afterwards. Therefore, what you modify will remain in the config.

License

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