feat: delete screenshot option

cypress/e2e/matchImageSnapshot.cy.ts

@@ -41,6 +41,24 @@ it('allows .snap extension to be changed', () => {
  )
 })
 
+it('allows screenshot to not be deleted', () => {
+ cy.get('body').matchImageSnapshot('no-delete', {
+ isDeleteScreenshot: false,
+ })
+
+ cy.readFile(
+ './cypress/screenshots/matchImageSnapshot.cy.ts/no-delete.png',
+ ).should('exist')
+})
+
+it('allows screenshot to not be deleted default', () => {
+ cy.get('body').matchImageSnapshot('no-delete-default')
+
+ cy.readFile(
+ './cypress/screenshots/matchImageSnapshot.cy.ts/no-delete-default.png',
+ ).should('not.exist')
+})
+
 // next two tests use blackout to change
 // the snapshot image. Also validates options
 it('name and options', () => {

src/command.ts

@@ -24,6 +24,7 @@ const defaultOptions: SnapshotOptions = {
  failureThresholdType: 'pixel',
  snapFilenameExtension: '.snap',
  diffFilenameExtension: '.diff',
+ isDeleteScreenshot: true,
 }
 
 /**

src/plugin.ts

@@ -54,7 +54,10 @@ const runImageDiffAfterScreenshot = async (
  }
 
  const receivedImageBuffer = await fs.readFile(screenshotPath)
- await fs.rm(screenshotPath)
+
+ if (options.isDeleteScreenshot) {
+ await fs.rm(screenshotPath)
+ }
 
  const {
  currentTestTitle,

src/types.ts

@@ -26,6 +26,7 @@ export type SnapshotOptions = {
  e2eSpecDir: string
  snapFilenameExtension: string
  diffFilenameExtension: string
+ isDeleteScreenshot?: boolean
 } & CypressScreenshotOptions &
  MatchImageSnapshotOptions
 
@@ -40,6 +41,7 @@ export type CypressImageSnapshotOptions = Partial<
  e2eSpecDir?: string
  snapFilenameExtension?: string
  diffFilenameExtension?: string
+ isDeleteScreenshot?: boolean
 }
 
 export type Subject =