cypress-highlight v1.4.0

cypress-highlight

Highlights all elements on the page with good test selectors by injecting a CSS rule

Videos

• Add A Red Border Around Elements That Have data-cy Attribute
• Cypress-highlight Plugin Introduction

Install

$ npm install -D cypress-highlight
# or using Yarn
$ yarn add -D cypress-highlight

Use

import { highlight } from 'cypress-highlight'

it('loads an app', () => {
  cy.visit('/')
  highlight()
  // you can capture a screenshot to see the elements
  // with good test selectors
  cy.screenshot('highlights', { capture: 'runner' })
})

See spec.js

Multiple selectors

By default, this module highlight all elements with data-cy attribute. You can pass your own list of selectors to highlight. For example, to highlight all elements with data attribute test-id and all elements with class name testable, use

highlight('[data-test-id]', '.testable')

Options object

You can pass multiple options using an object

// highlight all elements that have "data-cy" attribute
highlight({
  selectors: '[data-cy]',
})
// highlight all elements that have "data-cy" attribute
// plus all elements with class "todo-li"
highlight({
  selectors: ['[data-cy]', '.todo-li'],
})

failIfFound

You can highlight and then fail the test if any matching elements are found

highlight({
  selectors: '[data-error]',
  failIfFound: true,
})

failIfNotFound

You can fail the test if no matching elements are found

highlight({
  selectors: 'li.todo',
  failIfNotFound: true,
})

highlightMissingTestIds

Highlights any buttons / input elements / anchor links without data-cy attribute. Fails by default if any are found.

import { highlightMissingTestIds } from 'cypress-highlight'
// somewhere during the test
highlightMissingTestIds()
// disable throwing an error on a found element
highlightMissingTestIds(false)

Read

Cypress best practices for selecting elements

Small print

Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2021

• @bahmutov
• glebbahmutov.com
• blog
• videos
• presentations
• cypress.tips

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2021 Gleb Bahmutov <gleb.bahmutov@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.