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.

Sign up for GitHub

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

chore: remove nuxt2 documentation #5976

Merged
merged 1 commit into from
Nov 3, 2024
Merged

chore: remove nuxt2 documentation #5976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/app/component-testing/get-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ following development servers and frameworks:
| [React with Vite](/app/component-testing/react/overview#React-with-Vite) | React 16-18 | Vite 4-5 |
| [React with Webpack](/app/component-testing/react/overview#React-with-Webpack) | React 16-18 | Webpack 4-5 |
| [Vue CLI 4-5](/app/component-testing/vue/overview#Vue-CLI) | Vue 2-3 | Webpack 4-5 |
| [Nuxt 2](/app/component-testing/vue/overview#Nuxt) <Badge type="info">Alpha</Badge> | Vue 2-3 | Webpack 4-5 |
| [Vue with Vite](/app/component-testing/vue/overview#Vue-with-Vite) | Vue 2-3 | Vite 4-5 |
| [Vue with Webpack](/app/component-testing/vue/overview#Vue-with-Webpack) | Vue 2-3 | Webpack 4-5 |
| [Angular](/app/component-testing/angular/overview#Framework-Configuration) | Angular 13-18 | Webpack 5 |
Expand Down
2 changes: 1 addition & 1 deletion docs/app/component-testing/styling-components.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ covered in the last section.
import './main.css'
```

4. Within a configuration file like `next.config.js` or `nuxt.config.js`.
4. Within a configuration file like `next.config.js`.

You're usually providing public paths to these stylesheets. You can import the
same paths within your `cypress/support/component-index.html` file.
Expand Down
36 changes: 2 additions & 34 deletions docs/app/component-testing/vue/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ sidebar_label: Overview

- How to set up component tests in Vue
- How to configure Cypress for Vue projects
- How to use Cypress with Vue CLI, Nuxt, Vite, and custom Webpack config
- How to use Cypress with Vue CLI, Vite, and custom Webpack config

:::

Expand All @@ -19,7 +19,6 @@ sidebar_label: Overview
Cypress Component Testing supports Vue 2+ with the following frameworks:

- [Vue CLI](#Vue-CLI)
- [Nuxt](#Nuxt) <Badge type="info">Alpha</Badge>
- [Vue with Vite](#Vue-with-Vite)
- [Vue with Webpack](#Vue-with-Webpack)

Expand Down Expand Up @@ -60,7 +59,7 @@ For usage and examples, visit the
## Framework Configuration

Cypress Component Testing works out of the box with
[Vue CLI](https://cli.vuejs.org/), [Nuxt](https://nuxtjs.org/),
[Vue CLI](https://cli.vuejs.org/),
[Vite](https://vitejs.dev/), and a custom [Webpack](https://webpack.js.org/)
config. Cypress will automatically detect one of these frameworks during setup
and configure them properly. The examples below are for reference purposes.
Expand Down Expand Up @@ -102,37 +101,6 @@ for more information.
- [Vue 3 CLI 5 with TypeScript](https://github.com/cypress-io/cypress-component-testing-apps/tree/main/vue3-cli5-ts)
- [Vue 2 CLI 4 with JavaScript](https://github.com/cypress-io/cypress-component-testing-apps/tree/main/vue2-cli4-js)

### Nuxt

Cypress Component Testing works with Nuxt 2. Nuxt 3 is not yet supported.

:::caution

Nuxt is currently in alpha support for component testing.

:::

#### Nuxt Configuration

:::cypress-config-example

```ts
{
component: {
devServer: {
framework: 'nuxt',
bundler: 'webpack',
},
},
}
```

:::

#### Nuxt Sample Apps

- [Vue 2 Nuxt 2 with JavaScript](https://github.com/cypress-io/cypress-component-testing-apps/tree/main/vue2-nuxt2-js)

### Vue with Vite

Cypress Component Testing works with Vue apps that use Vite 2+ as the bundler.
Expand Down
2 changes: 1 addition & 1 deletion docs/app/references/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ object:
| ------------------------------ | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `devServer` | `null` | Required option used to configure the component testing dev server. [Please read the notes for examples on using this.](#devServer) |
| `indexHtmlFile` | `cypress/support/component-index.html` | This is where Cypress renders your components and allows you to add in global assets, such as styles, fonts, and external scripts. |
| `justInTimeCompile` | `true` | Compile resources directly related to your spec for webpack, compiling them 'just-in-time' before spec execution. |
| `justInTimeCompile` | `true` | Compile resources directly related to your spec for webpack, compiling them 'just-in-time' before spec execution. |
| `setupNodeEvents` | `null` | Function in which node events can be registered and config can be modified. Takes the place of the (removed) plugins file. [Please read the notes for examples on using this.](#setupNodeEvents) |
| `supportFile` | `cypress/support/component.js` | Path to file to load before spec files load. This file is compiled and bundled. (Pass `false` to disable) |
| `specPattern` | <code>\*\*/\*.cy.\{js,jsx,ts,tsx\}</code> | A glob pattern String or Array of glob pattern Strings of the spec files to load. <br /><br />Note that any files found matching the `e2e.specPattern` value will be automatically **excluded.** |
Expand Down