{"id":25153,"library":"cypress-devserver-esbuild","title":"cypress-devserver-esbuild","description":"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.","status":"active","version":"1.5.0","language":"javascript","source_language":"en","source_url":null,"tags":["javascript","cypress","esbuild","typescript"],"install":[{"cmd":"npm install cypress-devserver-esbuild","lang":"bash","label":"npm"},{"cmd":"yarn add cypress-devserver-esbuild","lang":"bash","label":"yarn"},{"cmd":"pnpm add cypress-devserver-esbuild","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"peer dependency for bundling tests","package":"esbuild","optional":false}],"imports":[{"note":"Package ships ESM and CommonJS; named export only.","wrong":"const createEsbuildDevServer = require('cypress-devserver-esbuild')","symbol":"createEsbuildDevServer","correct":"import { createEsbuildDevServer } from 'cypress-devserver-esbuild'"},{"note":"Type import only; not a runtime value.","wrong":"import { DevServerOptions } from 'cypress-devserver-esbuild'","symbol":"DevServerOptions","correct":"import type { DevServerOptions } from 'cypress-devserver-esbuild'"},{"note":"Exported type for the esbuild configuration parameter.","wrong":"","symbol":"EsbuildDevServerConfig","correct":"import type { EsbuildDevServerConfig } from 'cypress-devserver-esbuild'"}],"quickstart":{"code":"const { defineConfig } = require('cypress');\nconst { createEsbuildDevServer } = require('cypress-devserver-esbuild');\n\nmodule.exports = defineConfig({\n  component: {\n    devServer: createEsbuildDevServer({\n      outdir: './dist-test',\n      define: { 'process.env.API_KEY': JSON.stringify(process.env.API_KEY ?? '') }\n    }, {\n      singleBundle: true,\n      port: 1234\n    })\n  }\n});","lang":"javascript","description":"Minimal Cypress config using esbuild dev server with custom output directory and single bundle mode."},"warnings":[{"fix":"Do not specify entryPoints in esbuild config; use specPattern in Cypress config to control test file matching.","message":"Setting entryPoints in esbuild config is overwritten by dev server; tests are resolved via globby patterns, not esbuild's native globbing.","severity":"gotcha","affected_versions":"*"},{"fix":"Add { hasCssFiles: true } to the second parameter of createEsbuildDevServer.","message":"If using CSS modules with separate CSS output files, must set hasCssFiles: true in options; otherwise CSS may not load.","severity":"gotcha","affected_versions":"*"},{"fix":"Set splitting: false in esbuild config, or use singleBundle: true in dev server options.","message":"If test count produces too many chunks, browser's MaxConnectionsPerHost can slow tests.","severity":"gotcha","affected_versions":"*"},{"fix":"Use require('cypress-devserver-esbuild') or import { createEsbuildDevServer } from 'cypress-devserver-esbuild'.","message":"Deprecated import path: require('./src/dev-server') in documentation example may break with package updates.","severity":"deprecated","affected_versions":">=1.0.0"},{"fix":"Upgrade Node.js to version 16 or higher.","message":"Package requires Node.js 16+; older versions may fail on install or runtime.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run 'npm install -D cypress-devserver-esbuild' and use correct import.","cause":"Missing package installation or incorrect import path.","error":"Cannot find module 'cypress-devserver-esbuild'"},{"fix":"Use 'import { createEsbuildDevServer } from 'cypress-devserver-esbuild'' or const { createEsbuildDevServer } = require('cypress-devserver-esbuild').","cause":"Used default import instead of named import.","error":"Module 'cypress-devserver-esbuild' has no exported member 'createEsbuildDevServer'"},{"fix":"Upgrade Cypress to 12.x or higher.","cause":"Cypress version does not meet minimum requirement (12+).","error":"Could not find a dev server implementation for this Cypress version"},{"fix":"Run 'npm install -D esbuild@^0.17.0'.","cause":"Missing peer dependency esbuild.","error":"Error: esbuild is not installed. Add esbuild as a devDependency"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}