Registry / testing / cypress-devserver-esbuild

cypress-devserver-esbuild

library1.5.0jsnpmunverified

Minimal esbuild dev server for Cypress component tests. Current stable version 1.5.0 adds Cypress 14 support while maintaining backward compatibility to Cypress 12 and 13. Tests are packaged as ESM bundles via a tiny express server. Written in TypeScript with full type definitions. Requires esbuild ^0.17.0 as a peer dependency. Unlike other Cypress dev servers (webpack, vite), this provides a lightweight, minimal config option for esbuild users.

testing

npm install cypress-devserver-esbuild

package ↗

INSTALL

IMPORT

SIG · CYPRESS-DEVSERVER-

cypress-devserver-esbuild

testingjavascriptv1.5.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

createEsbuildDevServer

✓ import { createEsbuildDevServer } from 'cypress-devserver-esbuild'

✗ const createEsbuildDevServer = require('cypress-devserver-esbuild')

Package ships ESM and CommonJS; named export only.

DevServerOptions

✓ import type { DevServerOptions } from 'cypress-devserver-esbuild'

✗ import { DevServerOptions } from 'cypress-devserver-esbuild'

Type import only; not a runtime value.

EsbuildDevServerConfig

✓ import type { EsbuildDevServerConfig } from 'cypress-devserver-esbuild'

Exported type for the esbuild configuration parameter.

Minimal Cypress config using esbuild dev server with custom output directory and single bundle mode.

const { defineConfig } = require('cypress'); const { createEsbuildDevServer } = require('cypress-devserver-esbuild'); module.exports = defineConfig({ component: { devServer: createEsbuildDevServer({ outdir: './dist-test', define: { 'process.env.API_KEY': JSON.stringify(process.env.API_KEY ?? '') } }, { singleBundle: true, port: 1234 }) } });

Debug

Known issues

gotchaSetting entryPoints in esbuild config is overwritten by dev server; tests are resolved via globby patterns, not esbuild's native globbing.

fix

Do not specify entryPoints in esbuild config; use specPattern in Cypress config to control test file matching.

affects: *

gotchaIf using CSS modules with separate CSS output files, must set hasCssFiles: true in options; otherwise CSS may not load.

fix

Add { hasCssFiles: true } to the second parameter of createEsbuildDevServer.

affects: *

gotchaIf test count produces too many chunks, browser's MaxConnectionsPerHost can slow tests.

fix

Set splitting: false in esbuild config, or use singleBundle: true in dev server options.

affects: *

deprecatedDeprecated import path: require('./src/dev-server') in documentation example may break with package updates.

fix

Use require('cypress-devserver-esbuild') or import { createEsbuildDevServer } from 'cypress-devserver-esbuild'.

affects: >=1.0.0

gotchaPackage requires Node.js 16+; older versions may fail on install or runtime.

fix

Upgrade Node.js to version 16 or higher.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'cypress-devserver-esbuild'

Missing package installation or incorrect import path.

fix

Run 'npm install -D cypress-devserver-esbuild' and use correct import.

Module 'cypress-devserver-esbuild' has no exported member 'createEsbuildDevServer'

Used default import instead of named import.

fix

Use 'import { createEsbuildDevServer } from 'cypress-devserver-esbuild'' or const { createEsbuildDevServer } = require('cypress-devserver-esbuild').

Could not find a dev server implementation for this Cypress version

Cypress version does not meet minimum requirement (12+).

fix

Upgrade Cypress to 12.x or higher.

Error: esbuild is not installed. Add esbuild as a devDependency

Missing peer dependency esbuild.

fix

Run 'npm install -D esbuild@^0.17.0'.

Upgrade

Version history

1.5.0latest on npm

Audit

Dependencies

esbuildrequiredpeer dependency for bundling tests

Agent activity

6 hits · last 30 days

node

Resources

packagehttps://www.npmjs.com/package/cypress-devserver-esbuild ↗