@cypress/webpack-preprocessor
Cypress preprocessor for bundling JavaScript via webpack
Last updated a month ago by cypress-npm-publisher .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @cypress/webpack-preprocessor 
SYNC missed versions from official npm registry.

Cypress Webpack Preprocessor CircleCI semantic-release

Cypress preprocessor for bundling JavaScript via webpack

Installation

npm install --save-dev @cypress/webpack-preprocessor

This package relies on the following peer dependencies:

  • @babel/core
  • @babel/preset-env
  • babel-loader
  • webpack

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 @babel/core @babel/preset-env babel-loader webpack

Compatibility

This version is only compatible with webpack 4.x+ and Babel 7.x+.

  • If you need webpack 2 or 3 support, use @cypress/webpack-preprocessor 1.x
  • If you need Babel 6 support, use @cypress/webpack-preprocessor <= 2.x

This plugin (and all Cypress plugins) run in Cypress's own version of Node. If you require npm packages or your own code into the pluginsFile, they needs to be compatible with the version of Node that Cypress uses, currently 8.2.1.

Usage

In your project's plugins file:

const webpack = require('@cypress/webpack-preprocessor')

module.exports = (on) => {
  on('file:preprocessor', webpack())
}

Options

Pass in options as the second argument to webpack:

const webpack = require('@cypress/webpack-preprocessor')

module.exports = (on) => {
  const options = {
    // send in the options from your webpack.config.js, so it works the same
    // as your app's code
    webpackOptions: require('../../webpack.config'),
    watchOptions: {},
  }

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

webpackOptions

Object of webpack options. Just require in the options from your webpack.config.js to use the same options as your app.

Default:

{
  module: {
    rules: [
      {
        test: /\.js?$/,
        exclude: [/node_modules/],
        use: [{
          loader: 'babel-loader',
          options: {
            presets: ['babel-preset-env'],
          },
        }],
      },
    ],
  },
}

Source maps are always enabled unless explicitly disabled by specifying devtool: false.

watchOptions

Object of options for watching. See webpack's docs.

Default: {}

additionalEntries

An array of file path strings for additional entries to be included in the bundle.

By necessity, this preprocessor sets the entry point for webpack as the spec file or support file. The additionalEntries option allows you to specify more entry points in order to utilize webpack's multi-main entry. This allows runtime dependency resolution.

Default: []

Example:

const webpack = require('@cypress/webpack-preprocessor')

module.exports = (on) => {
  const options = {
    webpackOptions: require('../../webpack.config'),
    additionalEntries: ['./app/some-module.js'],
  }

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

Modifying default options

The default options are provided as webpack.defaultOptions so they can be more easily modified.

If, for example, you want to update the options for the babel-loader to add the stage-3 preset, you could do the following:

const webpack = require('@cypress/webpack-preprocessor')

module.exports = (on) => {
  const options = webpack.defaultOptions
  options.webpackOptions.module.rules[0].use[0].options.presets.push('babel-preset-stage-3')

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

Contributing

Use the version of Node that matches Cypress. Currently that's 8.2.1.

Run all tests once:

npm test

Run tests in watch mode:

npm run test-watch

License

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

Current Tags

  • 4.1.1                                ...           latest (a month ago)

18 Versions

  • 4.1.1                                ...           a month ago
  • 4.1.0                                ...           6 months ago
  • 4.0.4                                ...           6 months ago
  • 4.0.3                                ...           a year ago
  • 4.0.2                                ...           a year ago
  • 4.0.1                                ...           a year ago
  • 4.0.0                                ...           a year ago
  • 3.0.1                                ...           a year ago
  • 3.0.0                                ...           a year ago
  • 2.0.1                                ...           2 years ago
  • 2.0.0                                ...           2 years ago
  • 1.1.3                                ...           2 years ago
  • 1.1.2                                ...           2 years ago
  • 1.1.1                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.2                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
  • 1.0.0                                ...           2 years ago

Copyright 2014 - 2016 © taobao.org |