unicorn/prefer-query-selector Pedantic

🛠️ An auto-fix is available for this rule for some violations.

What it does

Prefer .querySelector() over .getElementById(), .querySelectorAll() over .getElementsByClassName() and .getElementsByTagName().

Why is this bad?

• Using .querySelector() and .querySelectorAll() is more flexible and allows for more specific selectors.
• It's better to use the same method to query DOM elements. This helps keep consistency and it lends itself to future improvements (e.g. more specific selectors).

Examples

Examples of incorrect code for this rule:

document.getElementById("foo");
document.getElementsByClassName("foo bar");
document.getElementsByTagName("main");
document.getElementsByClassName(fn());

Examples of correct code for this rule:

document.querySelector("#foo");
document.querySelector(".bar");
document.querySelector("main #foo .bar");
document.querySelectorAll(".foo .bar");
document.querySelectorAll("li a");
document.querySelector("li").querySelectorAll("a");

How to use

To enable this rule in the CLI or using the config file, you can use:

CLI

oxlint --deny unicorn/prefer-query-selector

Config (.oxlintrc.json)

{
  "rules": {
    "unicorn/prefer-query-selector": "error"
  }
}

References

• Rule Source