cypress-rspack-dev-server

cypress-rspack-dev-server

Based off the amazing work of the cypress team at https://github.com/cypress-io/cypress/blob/develop/npm/webpack-dev-server/

Implements the APIs for Cypress Component-testing with Rust-based web bundler Rspack's dev server.

Installation

Install the library to your devDependencies

npm install -D cypress-rspack-dev-server

Usage

import { devServer } from 'cypress-rspack-dev-server'
import { defineConfig } from 'cypress'

export default defineConfig({
  component: {
    devServer(devServerConfig) {
      return devServer({
        ...devServerConfig,
        framework: 'react',
        rspackConfig: require('./rspack.config.js')
      })
    }
  }
})

In the Cypress-rspack-dev-server Version column, it lists the corresponding versions that are compatible with the Rspack versions.

For example:

For Rspack version 1.0.0-beta.4 or later, use Cypress-rspack-dev-server version 0.0.6.

Dev server parameters

Option	NOTES
framework	react, currently only react, will support other frameworks
cypressConfig	Cypress Plugin Configuration
specs	Array of Cypress Spec
devServerEvents	Nodejs EventEmitter
rspackConfig (Optional)	Rspack Configuration, can be require from rspack config file
onConfigNotFound (Optional)	The callback function when config not found

License

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