cypress

mirror of https://github.com/cypress-io/cypress.git synced 2026-05-02 04:50:06 -05:00

Files

T

Jordan e8fc268953 feat: add support for angular 17 (#28152 )

* feat(webpack-dev-server): add support for angular 17

* update changelog

* fix broken spec pattern

* update to rc 2 for cli

* remove = from dependency minVersion lists

* update angular 17 rc version and update dep test

* add projectDirFolder to fixtures for angular-17

* resolve broken system tests

* update ct project dir angular version

2023-11-07 07:35:26 -05:00

src

feat: add support for angular 17 (#28152 )

2023-11-07 07:35:26 -05:00

test

refactor: Spellcheck (#27964 )

2023-10-11 10:06:10 -04:00

.eslintignore

feat: Create public Cypress.ensure API for use with custom queries (#24697 )

2022-11-29 09:34:34 -06:00

.gitignore

chore: optimize task execution (#27848 )

2023-10-04 12:25:00 -05:00

index.js

…

package.json

chore: list rimraf dev-dependency once in repo (#26257 )

2023-03-28 20:49:09 -05:00

README.md

…

tsconfig.json

fix: various minor migration bugs (#21195 )

2022-05-03 20:21:47 +10:00

README.md

@packages/scaffold-config

Logic related to scaffolding new projects using launchpad, including detecting component frameworks and bundlers, installing dependencies and creating cypress.config.js files.

We have integrations for popular code generators like Create React App, Next.js and Vue CLI, and ship a cypress.config.js that will work out of the box for those templates.

We will also attempt to scaffold a configuration file for projects using React and Vue projects using Vite and Webpack that are not necessarily created using a code generator.

Supported Frameworks and Libraries

Name	Version	Dev Server	Version	Library	Component Adaptor	Example Project
Create React App	5.x	Webpack	5.x	React 16, 17	`@cypress/react@latest`	[TODO]
Create React App	4.x	Webpack	4.x	React 16, 17	`@cypress/react@latest`	Link
React	-	Vite	2.x	React 16, 17	`@cypress/react@latest`	Link
Vue	-	Vite	2.x	Vue 3	`@cypress/vue@latest`	Link
Vue CLI	4.x	Webpack	4.x	Vue 2	`@cypress/vue2@latest`	Link
Vue CLI	4.x	Webpack	4.x	Vue 3	`@cypress/vue@latest`	Link
Vue CLI	5.x	Webpack	5.x	Vue 2	`@cypress/vue2@latest`	Covered by other Vue CLI test projects.
Vue CLI	5.x	Webpack	5.x	Vue 3	`@cypress/vue@latest`	Link
Nuxt.js	2.x	Webpack	4.x, 5.x	Vue 2	`@cypress/vue2@latest`	Link

TODO

These should be supported but currently are not configured.

Name	Version	Dev Server	Version	Library	Component Adaptor	Example Project
Next.js	11.x, 12.x	Webpack	4.x, 5.x	React 16, 17	`@cypress/react@latest`	Link

Adding More Projects

The process for adding a new library/framework/bundler is as follows:

Add your framework in src/frameworks.ts.
Any new dependencies are declared in src/constants.ts. Don't forget to add a description.
Ensure your project has the correct library and bundler detected with a test in test/unit/detect.spec.ts.
Add a new project with the correct cypress.config.js and package.json to system-tests/projects. It should be <name>-configured, which is a working example with some specs. Ensure it will run on CI by adding it to component_testing_spec.ts.
Add another project called <name>-unconfigured, which represents the project prior to having Cypress added. This will be used in step 5.
Add a test to scaffold-component-testing.cy.ts to ensure your project has the correct cypress.config.js generated. Use an existing test as a template.