Files
cypress/guides/studio-development.md
Ryan Manuel ffcc6387ef chore: add ability to load types from the studio bundle (#31153)
* chore: set up sharing of react via module federation in studio

* chore: add ability to load types from the studio bundle

* fix build

* fix build

* fix build

* PR comments

* Update guides/studio-development.md

Co-authored-by: Matt Schile <mschile@cypress.io>

* fix test

---------

Co-authored-by: Matt Schile <mschile@cypress.io>
2025-02-28 16:30:45 -06:00

907 B

Studio Development

In production, the code used to facilitate Studio functionality will be retrieved from the Cloud. However, in order to develop locally, developers will:

  • Clone the cypress-services repo (this requires that you be a member of the Cypress organization)
    • Run yarn
    • Run yarn watch in app/studio
  • Set CYPRESS_LOCAL_STUDIO_PATH to the path to the cypress-services/app/studio/dist/development directory
  • Clone the cypress repo
    • Run yarn
    • Run yarn cypress:open

Types

The studio bundle provides the types for the app and server interfaces that are used within the Cypress code. To incorporate the types into the code base, run:

yarn gulp downloadStudioTypes

or to reference a local cypress_services repo:

CYPRESS_LOCAL_STUDIO_PATH=<path-to-cypress-services/app/studio/dist/development-directory> yarn gulp downloadStudioTypes