cypress-rollup-preprocessor

cypress-rollup-preprocessor

Cypress preprocessor for bundling JavaScript via rollup

Installation

First install node.js. Then:

npm install cypress-rollup-preprocessor --save-dev

This package relies on the following peer dependencies:

• rollup

It is likely you already have these installed either directly or as a transient dependency, but if not, you will need to install them.

npm install --save-dev rollup

Compatibility

This version is only compatible with rollup 2.x+

Usage

In your project's plugins file:

const rollupPreprocessor = require("cypress-rollup-preprocessor");

module.exports = (on) => {
  on("file:preprocessor", rollupPreprocessor());
};

Examples

• Basic
• Using Typescript

Options

Pass in options as the argument to rollup:

const rollupPreprocessor = require('cypress-rollup-preprocessor')

// Using the options from rollup.config.js
const rollupConfig = require('../../rollup.config')

const { output: outputOptions, ...inputOptions } = rollupConfig

/**
 * @type {Cypress.PluginConfig}
 */
module.exports = (on) => {
  const options = {
    inputOptions,
    outputOptions,
  }

  on('file:preprocessor', rollupPreprocessor(options))
}

inputOptions

Object of rollup input options. You can just require in the options from your rollup.config.js to use the same options as your app. Reference: https://rollupjs.org/guide/en/#inputoptions-object

outputOptions

Object of rollup output options. Reference: https://rollupjs.org/guide/en/#outputoptions-object

Contributing

Please read the Contributing guidelines.

Running Tests

To run tests, first install nodeunit and any dependencies via npm:

npm ci

Run tests with:

npm test

Inspiration

Many approaches, patterns and standards were copied from:

• https://github.com/cypress-io/cypress-webpack-preprocessor
• https://github.com/cypress-io/cypress-watch-preprocessor

Alternatives

• https://github.com/bahmutov/cy-rollup

License

This project is licensed under the terms of the MIT license.

Changelog

1.1.0 (2022-06-17)

Features

• enhance error messages (1c41c1c)