fix: Update default snapshot save path #29

cypress/e2e/matchImageSnapshot.cy.ts

@@ -28,4 +28,13 @@ it('matches with just options', () => {
 it('verify errors are stored', () => {
   cy.get('body').matchImageSnapshot('error1')
   cy.get('body').matchImageSnapshot('error2')
+  cy.get('@matchImageSnapshot').should((obj) => {
+    expect(Object.keys(obj).length).to.eq(2)
+  })
+})
+
+it('Support extra folders', () => {
+  cy.get('body').matchImageSnapshot('extraFolder', {
+    extraFolders: 'test-folder',
+  })
 })

src/command.ts

@@ -22,6 +22,8 @@ export const defaultOptions: SnapshotOptions = {
   isUpdateSnapshots,
   isSnapshotDebug,
   specFileName: Cypress.spec.name,
+  specRelativeFolder: Cypress.spec.relative,
+  extraFolders: '',
   currentTestTitle: '',
   failureThreshold: 0,
   failureThresholdType: 'pixel',

src/plugin.ts

@@ -53,6 +53,8 @@ const checkSnapshotExistence = ({
 }) => {
   const {
     specFileName,
+    specRelativeFolder,
+    extraFolders,
     screenshotsFolder,
     isUpdateSnapshots,
     customSnapshotsDir,
@@ -61,7 +63,15 @@ const checkSnapshotExistence = ({
 
   const snapshotsDir = customSnapshotsDir
     ? path.join(process.cwd(), customSnapshotsDir, specFileName)
-    : path.join(screenshotsFolder, '..', 'snapshots', specFileName)
+    : path.join(
+        screenshotsFolder,
+        '..',
+        'snapshots',
+        specRelativeFolder,
+        '..',
+        extraFolders,
+        specFileName,
+      )
 
   const snapshotDotPath = path.join(
     snapshotsDir,
@@ -89,6 +99,8 @@ const runImageDiffAfterScreenshot = async (
 
   const {
     specFileName,
+    specRelativeFolder,
+    extraFolders,
     currentTestTitle,
     screenshotsFolder,
     isUpdateSnapshots,
@@ -98,7 +110,15 @@ const runImageDiffAfterScreenshot = async (
 
   const snapshotsDir = customSnapshotsDir
     ? path.join(process.cwd(), customSnapshotsDir, specFileName)
-    : path.join(screenshotsFolder, '..', 'snapshots', specFileName)
+    : path.join(
+        screenshotsFolder,
+        '..',
+        'snapshots',
+        specRelativeFolder,
+        '..',
+        extraFolders,
+        specFileName,
+      )
 
   const snapshotDotPath = path.join(
     snapshotsDir,

src/types.ts

@@ -23,6 +23,7 @@ export type SnapshotOptions = {
   isSnapshotDebug: boolean
   specFileName: string
   currentTestTitle: string
+  specRelativeFolder: string
 } & CypressScreenshotOptions &
   MatchImageSnapshotOptions &
   ExtraSnapshotOptions
@@ -95,7 +96,12 @@ type ExtraSnapshotOptions = {
   timeout: number
   /**
    * Sets a delay between recursive snapshots
-   * @default 1000.
+   * @default 1000
    */
   delayBetweenTries: number
+  /**
+   * Adds additional folders to the snapshot save path
+   * @default ''
+   */
+  extraFolders: string
 }