Cypress preprocessor for bundling JavaScript via browserify
npm install browserify-preprocessor-babel7Cypress preprocessor for bundling JavaScript via browserify.
This is the default preprocessor that comes packaged with Cypress. You'd typically need to install this if you want to modify the default options we've configured.
Modifying the default options allows you to add support for things like:
- TypeScript
- Babel Plugins
- ES Presets
Requires Node version 6.5.0 or above.
``sh`
npm install --save-dev @cypress/browserify-preprocessor
In your project's plugins file:
`javascript
const browserify = require('@cypress/browserify-preprocessor')
module.exports = (on) => {
on('file:preprocessor', browserify())
}
`
Pass in options as the second argument to browserify:
`javascript
module.exports = (on) => {
const options = {
// options here
}
on('file:preprocessor', browserify(options))
}
`
Object of options passed to browserify.
`javascript`
// example
browserify({
browserifyOptions: {
extensions: ['.js', '.ts'],
plugin: [
['tsify']
]
}
})
If you pass one of the top-level options in (extensions, transform, etc), it will override the default. In the above example, browserify will process .js and .ts files, but not .jsx, .coffee, or .cjsx. If you wish to add to or modify existing options, read about modifying the default options.
watchify is automatically configured as a plugin (as needed), so it's not necessary to manually specify it.
Default:
`javascript`
{
extensions: ['.js', '.jsx', '.coffee', '.cjsx'],
transform: [
[
'cjsxify',
{}
],
[
'babelify',
{
ast: false,
babelrc: false,
plugins: ['babel-plugin-add-module-exports'],
presets: ['babel-preset-env', 'babel-preset-react']
},
]
],
plugin: [],
cache: {},
packageCache: {}
}
Note: cache and packageCache are always set to {} and cannot be overridden. Otherwise, file watching would not function correctly.
Object of options passed to watchify
`javascript`
// example
browserify({
watchifyOptions: {
delay: 500
}
})
Default:
`javascript`
{
ignoreWatch: [
'/.git/',
'/.nyc_output/',
'/.sass-cache/',
'/bower_components/',
'/coverage/',
'/node_modules/'
],
}
A function that is called with the browserify bundle. This allows you to specify external files and plugins. See the browserify docs for methods available.
`javascript`
// example
browserify({
onBundle (bundle) {
bundle.external('react')
bundle.plugin('some-plugin')
}
})
Default: undefined
The default options are provided as browserify.defaultOptions so they can be more easily modified.
If, for example, you want to update the options for the babelify transform to turn on babelrc loading, you could do the following:
`javascript
const browserify = require('@cypress/browserify-preprocessor')
module.exports = (on) => {
const options = browserify.defaultOptions
options.browserifyOptions.transform[1][1].babelrc = true
on('file:preprocessor', browserify(options))
}
`
Run all tests once:
`shell`
npm test
Run tests in watch mode:
`shell``
npm run test-watch
This project is licensed under the terms of the MIT license.