Support Public API for Third Party Component Testing Integrations

[lmiller1990]

Cypress has a first class onboarding experience for some of the most popular frameworks (Angular, React...). Integrating Cypress with non-supported frameworks is more challenging.

Ideally, third party integrations should enjoy the same great experience. We will create a public API that allows third parties to "plug in" to our onboarding experience.

Examples of frameworks that could use this API:

• Solid.js SolidJS component test #24494
• Lit feat: add lit package for component tests #24250
• Stencil feature request: Component testing for StencilJS #24054
• CRA rewired Cypress config with monorepo and rewired cra #22521 (comment)
• Preact?
• Others!

[lmiller1990]

This is coming in Cypress 12.7 #25780

Docs for anyone excited/waiting: cypress-io/cypress-documentation#5069

If anyone wants to collab on a new integration, we can work together, please ping me 💯

I made one integration for Solid.js to test it out https://github.com/lmiller1990/cypress-ct-solid-js works great! You define two things:

• definition: https://github.com/lmiller1990/cypress-ct-solid-js/blob/main/definition.ts
• mount: https://github.com/lmiller1990/cypress-ct-solid-js/blob/main/index.tsx

And that's it - Cypress finds your package in node_modules and slots it in, alongside our officially supported frameworks, you get the scaffolding/onboarding etc for free. No doubt the API will continue to evolve, but a good start!

[lmiller1990]

We did it! https://docs.cypress.io/guides/component-testing/third-party-definitions.

A few implementations popped up, such as Solid.js, Lit and Qwik is coming soon 💯