{"library":"netlify-plugin-cypress","title":"Cypress Netlify Build Plugin","description":"The `netlify-plugin-cypress` package integrates Cypress end-to-end testing directly into the Netlify build pipeline. It allows developers to run Cypress tests against their deployed site (default), or earlier in the build process (preBuild, postBuild) to prevent broken deployments. The current stable version is 2.2.1, with recent updates in February 2023. This plugin differentiates itself by automating the setup and execution of Cypress within the Netlify environment, including automatically installing a Chromium browser via Puppeteer, and providing options to control when tests run relative to the deployment lifecycle. It is primarily configured via `netlify.toml`, offering a declarative way to incorporate E2E testing into continuous deployment workflows.","language":"javascript","status":"active","last_verified":"Sun Apr 19","install":{"commands":["npm install netlify-plugin-cypress"],"cli":null},"imports":["[[plugins]]\n  package = \"netlify-plugin-cypress\"","[[plugins]]\n  package = \"netlify-plugin-cypress\"\n  [plugins.inputs]\n    configFile = \"cypress.config.ts\"","[[plugins]]\n  package = \"netlify-plugin-cypress\"\n  [plugins.inputs]\n    start = \"npm run dev\""],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"npm install --save-dev cypress netlify-plugin-cypress\n# or\nyarn add -D cypress netlify-plugin-cypress\n\n# netlify.toml\n[[plugins]]\n  # This configuration runs Cypress tests against the deployed URL\n  # after a successful build and deployment (onSuccess event).\n  # For blocking deploys, consider configuring 'preBuild' or 'postBuild' hooks.\n  package = \"netlify-plugin-cypress\"","lang":"toml","description":"This quickstart demonstrates installing the plugin and Cypress as dev dependencies, then configuring the plugin in `netlify.toml` to run tests after a successful deployment.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}