feat: add title option to matchImage command (FRSOURCE#81)

added option to override title
added example
update README.md

Author: dhulme

README.md

@@ -160,6 +160,9 @@ cy.matchImage({
   // helps with screenshots being scaled 2x on high-density screens like Mac Retina
   // default: true
   forceDeviceScaleFactor: false,
+  // title used for naming the image file
+  // default: Cypress.currentTest.titlePath (your test title)
+  title: `${Cypress.currentTest.titlePath.join(' ')} (${Cypress.browser.displayName})`
 })
 ```
 

src/commands.ts

@@ -10,6 +10,7 @@ declare global {
       updateImages?: boolean;
       imagesDir?: string;
       maxDiffThreshold?: number;
+      title?: string;
     };
 
     interface Chainable<Subject> {
@@ -30,7 +31,7 @@ Cypress.Commands.add(
   { prevSubject: "optional" },
   (subject, options = {}) => {
     const $el = subject as JQuery<HTMLElement> | undefined;
-    let title = Cypress.currentTest.titlePath.join(" ");
+    let title = options.title || Cypress.currentTest.titlePath.join(" ");
     if (typeof nameCacheCounter[title] === "undefined")
       nameCacheCounter[title] = -1;
     title += ` #${++nameCacheCounter[title]}`;