[Feature]: Allow image index to be excluded

[gigaSproule]

Is your feature request related to a problem? Please describe.

When using GitHub, the PR diff logic seems to fall over when # is used in the file name. By being able to specify the image title, it should be possible to exclude the index, or having a way to use a different character instead of #, therefore getting around this limitation.

Describe the solution you'd like

It would be good if there was a global property to disable the image #index if a title is provided, or have a global property to alter the character used (so it could be set to - to create test name -0.png instead of test name #0.png.

Describe alternatives you've considered

No response

Additional context

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[gigaSproule]

As a work around, I've created a custom command to wrap around the matchImage command.

Cypress.Commands.add(
  "matchSnapshot",
  {
    prevSubject: "optional"
  },
  (subject, options?: Cypress.MatchImageOptions) => {
    (subject ? cy.wrap(subject) : cy).matchImage({
      ...options,
      matchAgainstPath: `${Cypress.spec.absolute.replace(Cypress.spec.baseName ?? "", "")}/__image_snapshots__/${options?.title ?? Cypress.currentTest.titlePath.join(" ")}.png`
    });
  }
);

[FRSgit]

Hey! I believe your issue will be fixed once this change will be fixed. And this will happen as a part of ongoing v4 release work. Please wait a moment for it to happen 🙏