eslint-plugin-cypress/lib/rules/require-data-selectors.js

An ESLint plugin for projects using Cypress

'use strict'

module.exports = {
  meta: {
    type: 'suggestion',
    docs: {
      description: 'require `data-*` attribute selectors',
      category: 'Possible Errors',
      recommended: false,
      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/require-data-selectors.md',
    },
    schema: [],
    messages: {
      unexpected: 'use data-* attribute selectors instead of classes or tag names',
    },
  },

  create(context) {
    return {
      CallExpression(node) {
        if (isCallingCyGet(node) && !isDataArgument(node)) {
          context.report({ node, messageId: 'unexpected' })
        }
      },
    }
  },
}

function isCallingCyGet(node) {
  return node.callee.type === 'MemberExpression'
    && node.callee.object.type === 'Identifier'
    && node.callee.object.name === 'cy'
    && node.callee.property.type === 'Identifier'
    && node.callee.property.name === 'get'
}

function isDataArgument(node) {
  return node.arguments.length > 0
    && (
      (node.arguments[0].type === 'Literal' && isAliasOrDataSelector(String(node.arguments[0].value)))
      || (node.arguments[0].type === 'TemplateLiteral' && isAliasOrDataSelector(String(node.arguments[0].quasis[0].value.cooked)))
    )
}

function isAliasOrDataSelector(selector) {
  return ['[data-', '@'].some(function (validValue) {
    return selector.startsWith(validValue)
  })
}