mirror of
https://github.com/grafana/grafana.git
synced 2024-11-28 03:34:15 -06:00
959c89793f
* Create eslint plugin/rule for catching e2e selectors in aria-label * Add no-aria-label-e2e-selectors to betterer * chore: skip levitate for the `grafana-eslint-rules` package * Fix rule * Add readme * Add Apache 2 license * Typecheck using @typescript-eslint/utils * actually export the rule Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com>
14 lines
704 B
Markdown
14 lines
704 B
Markdown
# Grafana ESLint Rules
|
|
|
|
This package contains custom eslint rules for use within the Grafana codebase only. They're extremley specific to our codebase, and are of little use to anyone else. They're not published to NPM, and are consumed through the Yarn workspace.
|
|
|
|
## Rules
|
|
|
|
### `@grafana/no-aria-label-selectors`
|
|
|
|
Require aria-label JSX properties to not include selectors from the `@grafana/e2e-selectors` package.
|
|
|
|
Previously we hijacked the aria-label property to use as E2E selectors as an attempt to "improve accessibility" while making this easier for testing. However, this lead to many elements having poor, verbose, and unnecessary labels.
|
|
|
|
Now, we prefer using data-testid for E2E selectors.
|