Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define API for third party CT in Launchpad #25680

Closed
lmiller1990 opened this issue Feb 2, 2023 · 1 comment
Closed

Define API for third party CT in Launchpad #25680

lmiller1990 opened this issue Feb 2, 2023 · 1 comment
Assignees

Comments

@lmiller1990
Copy link
Contributor

lmiller1990 commented Feb 2, 2023

Based on the work done in the technical brief: #24991.

Given a third party module that matches the format in the tech brief, cypress-ct-*, we show this in Launchpad.

Note, there are some minor changes to the brief: https://github.com/cypress-io/engineering-documentation/pull/67

In this ticket, you should implement the "detection" part:

  1. check node_modules (we've got some patterns for this already)
  2. look for modules matching some pattern (right now it's cypress-ct-*
  3. Validate it looks good and aligns with the format outlined in the tech brief
  4. Add some code to perform this check, probably when Cypress starts up if they have no configured component testing yet
function getThirdPartyWizards () {
  // check node_modules
  // find 0 or more modules
  // validate them
  // return array_of_valid_modules (invalid are just silently ignored, up the the author to test their module works)
}

Assume you will have a function exported from cypress called defineComponentFramework. That is implemented in this PR.

These will be merged with our first party frameworks and all shown in the onboarding wizard.

If there's any ambiguity, reach out and ask 💯

@lmiller1990
Copy link
Contributor Author

Some updates to the brief to simplify this: https://github.com/cypress-io/engineering-documentation/pull/67

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants