README.md

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')
      })
    }
  }
})

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

Migration to v1

In version 1, we supports the Cypress 14 's justInTimeCompile, the specs structure has been updated. If you still use Cypress <= 13, please use the version 0.0.x.

License

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