chore: prepare directory structure for more examples

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

Author: FRSgit

.eslintrc.js

@@ -18,7 +18,7 @@ module.exports = {
       parser: "@typescript-eslint/parser",
       parserOptions: {
         sourceType: "module",
-        project: ["./packages/cypress-plugin-visual-regression-diff/tsconfig.json", "./example/tsconfig.json"],
+        project: ["./packages/cypress-plugin-visual-regression-diff/tsconfig.json", "./examples/webpack/tsconfig.json"],
         tsconfigRootDir: __dirname,
         warnOnUnsupportedTypeScriptVersion: false,
         EXPERIMENTAL_useSourceOfProjectReferenceRedirect: true,

.github/workflows/ci.yml

@@ -46,8 +46,8 @@ jobs:
         with:
           node-version: "18.x"
           cache: 'pnpm'
-      - run: pnpm install && cd ./example && pnpm cypress install
-      - run: pnpm build --filter cypress-plugin-visual-regression-diff
+      - run: pnpm install && cd ./examples/webpack && pnpm cypress install
+      - run: pnpm --filter cypress-plugin-visual-regression-diff -r build
       - name: Test e2e
         run: pnpm test:e2e:ci
       - name: Test component-testing

CONTRIBUTING.md

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

README.md

@@ -153,7 +153,7 @@ cy.matchImage();
 
 ## Example
 
-Still got troubles with installation? Have a look at [example directory of this repo](./example) to see how this plugin can be used in e2e or component-testing Cypress environment within your project.
+Still got troubles with installation? Have a look at [examples directory of this repo](./examples) to see how this plugin can be used in e2e or component-testing Cypress environment within your project.
 
 ## Automatic clean up of unused images
 

example/.browserslistrc renamed to examples/webpack/.browserslistrc

@@ -13,15 +13,15 @@
     "release": "pnpm publish",
     "release:ci": "pnpm release --yes",
     "release:test": "pnpm release --no-git-tag-version --no-push --skip-npm",
-    "test": "cd example && pnpm test:ct:ci && pnpm test:e2e:ci && pnpm test:integration:ci",
+    "test": "cd examples/webpack && pnpm test:ct:ci && pnpm test:e2e:ci && pnpm test:integration:ci",
     "test:integration": "pnpm -r test:integration",
     "test:integration:watch": "pnpm -r test:integration:watch",
     "test:integration:coverage": "pnpm -r test:integration:coverage",
     "test:integration:ci": "pnpm -r test:integration:ci",
-    "test:ct": "cd example && pnpm test:ct",
-    "test:ct:ci": "cd example && pnpm test:ct:ci",
-    "test:e2e": "cd example && pnpm test:e2e",
-    "test:e2e:ci": "cd example && pnpm test:e2e:ci"
+    "test:ct": "cd examples/webpack && pnpm test:ct",
+    "test:ct:ci": "cd examples/webpack && pnpm test:ct:ci",
+    "test:e2e": "cd examples/webpack && pnpm test:e2e",
+    "test:e2e:ci": "cd examples/webpack && pnpm test:e2e:ci"
   },
   "engines": {
     "node": ">=10"

example/.gitignore renamed to examples/webpack/.gitignore

@@ -55,15 +55,15 @@
     "release": "semantic-release",
     "release:ci": "pnpm release --yes",
     "release:test": "pnpm release --no-git-tag-version --no-push --skip-npm",
-    "test": "cd example && pnpm test:ct:ci && pnpm test:e2e:ci && pnpm test:integration:ci",
+    "test": "cd examples/webpack && pnpm test:ct:ci && pnpm test:e2e:ci && pnpm test:integration:ci",
     "test:integration": "vitest run",
     "test:integration:watch": "vitest",
     "test:integration:coverage": "vitest run --coverage",
     "test:integration:ci": "CI=true vitest run --coverage",
-    "test:ct": "cd example && pnpm test:ct",
-    "test:ct:ci": "cd example && pnpm test:ct:ci",
-    "test:e2e": "cd example && pnpm test:e2e",
-    "test:e2e:ci": "cd example && pnpm test:e2e:ci"
+    "test:ct": "cd examples/webpack && pnpm test:ct",
+    "test:ct:ci": "cd examples/webpack && pnpm test:ct:ci",
+    "test:e2e": "cd examples/webpack && pnpm test:e2e",
+    "test:e2e:ci": "cd examples/webpack && pnpm test:e2e:ci"
   },
   "engines": {
     "node": ">=10"