Feature: Add global config option for including shadow DOM in commands

[chrisbreiding]

Current behavior:

Currently, to enable shadow dom support, it's necessary to pass includeShadowDom into a command that supports it every time it's used.

cy.get('.in-shadow-dom', { includeShadowDom: true })
cy.get('.shadow-root').find('.in-shadow-dom', { includeShadowDom: true })

Desired behavior:

Enable configuring shadow dom inclusion globally, per-suite, per-test, or programmatically. Still need to decide on a name for it.

cypress.json

Turns on inclusion behavior for all tests

{
  "includeShadowDom": true
}

Per Suite

Turns on inclusion behavior for all tests and commands within the suite

describe('shadow dom tests', { includeShadowDom: true }, () => {
  it(...)
  it(...)
})

Per Test

Turns on inclusion behavior for all commands within the test

it('shadow dom tests', { includeShadowDom: true }, () => {
  cy.get(...)
  cy.get(...).find(...)
})

Programmatically

Turns on inclusion behavior conditionally based on where it's used (before, beforeEach, etc)

before(() => {
  Cypress.config('includeShadowDom', true)
})

[cypress-bot]

The code for this is done in cypress-io/cypress#8479, but has yet to be released.
We'll update this issue and reference the changelog when it's released.

[cypress-bot]

Released in 5.2.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v5.2.0, please open a new issue.