feat: next example

Signed-off-by: Jakub Freisler <[email protected]>

Author: FRSgit

CONTRIBUTING.md

@@ -50,7 +50,6 @@ After cloning the repository, run:
 
 ```bash
 pnpm i # installs the project dependencies
-cd examples/webpack && pnpm i # install dependencies for example project (useful for testing)
 ```
 
 ### Committing Changes

examples/next/.gitignore

@@ -0,0 +1,43 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# we do not want to commit local screenshot files
+# as they might be different on different OSes
+**/__image_snapshots_local__
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+# cypress
+/cypress/screenshots
+/cypress/videos

examples/next/README.md

@@ -0,0 +1,41 @@
+# Next.js + Cypress + @frsource/cypress-plugin-visual-regression-diff
+
+This example shows how to configure @frsource/cypress-plugin-visual-regression-diff to work with Cypress & Next.js.
+
+## Project setup
+
+```bash
+pnpm install
+```
+
+### Run end-to-end tests
+
+> Important - remember to run `pnpm && pnpm build` command in this repo's root directory before starting e2e tests.
+
+```bash
+pnpm e2e
+```
+
+### Run component tests
+
+> Important - remember to run `pnpm && pnpm build` command in this repo's root directory before starting e2e tests.
+
+```bash
+pnpm component
+```
+
+### Compiles and hot-reloads for development
+
+```bash
+pnpm dev
+```
+
+### Compiles and minifies for production
+
+```bash
+pnpm build
+```
+
+## Credits
+
+Created using [Next.js Cypress template](https://nextjs.org/docs/pages/building-your-application/optimizing/testing#cypress).

examples/next/components/about-component.cy.tsx

@@ -0,0 +1,17 @@
+import AboutComponent from './about-component'
+/* eslint-disable */
+// Disable ESLint to prevent failing linting inside the Next.js repo.
+// If you're using ESLint on your project, we recommend installing the ESLint Cypress plugin instead:
+// https://github.com/cypress-io/eslint-plugin-cypress
+
+describe('<AboutComponent />', () => {
+  it('should render and display expected content', () => {
+    cy.mount(<AboutComponent />).then(() => {
+      cy.matchImage()
+      cy.get('h1').matchImage()
+    })
+  })
+})
+
+// Prevent TypeScript from reading file as legacy script
+export {}

examples/next/components/about-component.tsx

@@ -0,0 +1,14 @@
+import Link from 'next/link'
+import React from 'react'
+import styles from '../styles/Home.module.css'
+
+export default function AboutComponent() {
+  return (
+    <>
+      <h1>About Page</h1>
+      <p className={styles.description}>
+        <Link href="/">&larr; Go Back</Link>
+      </p>
+    </>
+  )
+}

examples/next/cypress.config.ts

@@ -0,0 +1,20 @@
+import { defineConfig } from "cypress";
+import { initPlugin } from "@frsource/cypress-plugin-visual-regression-diff/plugins";
+
+export default defineConfig({
+  e2e: {
+    setupNodeEvents(on, config) {
+      initPlugin(on, config);
+    },
+    baseUrl: "http://localhost:3000",
+  },
+  component: {
+    setupNodeEvents(on, config) {
+      initPlugin(on, config);
+    },
+    devServer: {
+      framework: "next",
+      bundler: "webpack",
+    },
+  },
+});

examples/next/cypress/e2e/app.cy.ts

@@ -0,0 +1,21 @@
+/* eslint-disable */
+// Disable ESLint to prevent failing linting inside the Next.js repo.
+// If you're using ESLint on your project, we recommend installing the ESLint Cypress plugin instead:
+// https://github.com/cypress-io/eslint-plugin-cypress
+
+describe("Navigation", () => {
+  it("should navigate to the about page", () => {
+    cy.visit("http://localhost:3000/");
+
+    cy.get('a[href*="about"]').click();
+
+    cy.url().should("include", "/about");
+
+    cy.matchImage().then(({ imgNewPath }) => {
+      // match against image from custom path
+      cy.matchImage({ matchAgainstPath: imgNewPath });
+    });
+  });
+});
+
+export {};

examples/next/cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "[email protected]",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

examples/next/cypress/support/commands.ts

@@ -0,0 +1,42 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }
+
+import "@frsource/cypress-plugin-visual-regression-diff/dist/support";
+
+// Prevent TypeScript from reading file as legacy script
+export {};

examples/next/cypress/support/component-index.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <title>Components App</title>
+    <!-- Used by Next.js to inject CSS. -->
+    <div id="__next_css__DO_NOT_USE__"></div>
+  </head>
+  <body>
+    <div data-cy-root></div>
+  </body>
+</html>

examples/next/cypress/support/component.ts

@@ -0,0 +1,40 @@
+/* eslint-disable @typescript-eslint/no-namespace */
+// ***********************************************************
+// This example support/component.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')
+
+import { mount } from 'cypress/react18'
+
+// Augment the Cypress namespace to include type definitions for
+// your custom command.
+// Alternatively, can be defined in cypress/support/component.d.ts
+// with a <reference path="./component" /> at the top of your spec.
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      mount: typeof mount
+    }
+  }
+}
+
+Cypress.Commands.add('mount', mount)
+
+// Example use:
+// cy.mount(<MyComponent />)

examples/next/cypress/support/e2e.ts

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

examples/next/cypress/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["es5", "dom"],
+    "types": ["cypress", "node"]
+  },
+  "include": ["**/*.ts"]
+}

examples/next/package.json

@@ -0,0 +1,26 @@
+{
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "test:e2e": "start-server-and-test dev http://localhost:3000 \"cypress open --e2e --env \"pluginVisualRegressionImagesPath={spec_path}/__image_snapshots_local__\"\"",
+    "test:e2e:ci": "start-server-and-test dev http://localhost:3000 \"cypress run --e2e\"",
+    "test:ci": "cypress open --component --env \"pluginVisualRegressionImagesPath={spec_path}/__image_snapshots_local__\"",
+    "test:ct:ci": "cypress run --component"
+  },
+  "dependencies": {
+    "next": "latest",
+    "react": "18.2.0",
+    "react-dom": "18.2.0"
+  },
+  "devDependencies": {
+    "@frsource/cypress-plugin-visual-regression-diff": "workspace:*",
+    "@types/node": "18.0.6",
+    "@types/react": "18.0.15",
+    "@types/react-dom": "18.0.6",
+    "cypress": "12.3.0",
+    "start-server-and-test": "1.15.2",
+    "typescript": "4.7.4"
+  }
+}

examples/next/pages/_app.tsx

@@ -0,0 +1,8 @@
+import type { AppProps } from 'next/app'
+import '../styles/globals.css'
+
+function MyApp({ Component, pageProps }: AppProps) {
+  return <Component {...pageProps} />
+}
+
+export default MyApp

examples/next/pages/about.tsx

@@ -0,0 +1,12 @@
+import AboutComponent from '../components/about-component'
+import styles from '../styles/Home.module.css'
+
+export default function About() {
+  return (
+    <div className={styles.container}>
+      <main className={styles.main}>
+        <AboutComponent />
+      </main>
+    </div>
+  )
+}