Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(prefer-locator): Add rule to suggest not using page methods #315

Merged

Conversation

carlbray
Copy link
Contributor

This rule detects where page.fill(loc, value) has been used and suggests the user uses a locator based fill as per the documentation for page.fill

https://github.com/microsoft/playwright/blob/d1926e2f9b91e31d73acfb87e564634f55b0dbb2/docs/src/api/class-page.md?plain=1#L2027

@mskelton
Copy link
Member

This rule should be more generic for all page actions that are like it. For example click is the same exact way

@carlbray
Copy link
Contributor Author

This rule should be more generic for all page actions that are like it. For example click is the same exact way

Looks like their a quite a few Page methods tagged with NOTE Use locator-based now that you mention it

  • click
  • dblclick
  • dispatchEvent
  • focus
  • getAttribute
  • hover
  • innerHTML
  • innerText
  • inputValue
  • isChecked
  • isDisabled
  • isEditable
  • isEnabled
  • isHidden
  • isVisible
  • press
  • selectOption
  • setChecked
  • setInputFiles
  • tap
  • textContent
  • uncheck

I'll extend it to those

@carlbray carlbray changed the title Add prefer-page-locator-fill feat(prefer-locator): Add rule to suggest not using page methods Sep 14, 2024
README.md Outdated Show resolved Hide resolved
docs/rules/prefer-locator.md Show resolved Hide resolved
docs/rules/prefer-locator.md Outdated Show resolved Hide resolved
docs/rules/prefer-locator.md Outdated Show resolved Hide resolved
src/rules/prefer-locator.test.ts Outdated Show resolved Hide resolved
src/rules/prefer-locator.ts Outdated Show resolved Hide resolved
src/rules/prefer-locator.ts Outdated Show resolved Hide resolved
src/rules/prefer-locator.ts Outdated Show resolved Hide resolved
src/rules/prefer-locator.ts Show resolved Hide resolved
src/rules/prefer-locator.ts Outdated Show resolved Hide resolved
@mskelton mskelton merged commit 731a4e1 into playwright-community:main Sep 19, 2024
3 checks passed
@carlbray carlbray deleted the feature/prefer-page-locator-fill branch September 20, 2024 00:34
Copy link

🎉 This PR is included in version 1.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@unlikelyzero
Copy link

This also closes #197

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants