-
-
Notifications
You must be signed in to change notification settings - Fork 503
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(linter):
tabindex-no-positive
for eslint-plugin-jsx-a11y (#1677)
partof: #1141 I've implemented `tabindex-no-positive` rule for jsx_a11y originals: - doc: https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/main/docs/rules/tabindex-no-positive.md - code: https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/main/src/rules/tabindex-no-positive.js - test: https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/main/__tests__/src/rules/tabindex-no-positive-test.js
- Loading branch information
Showing
3 changed files
with
161 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
118 changes: 118 additions & 0 deletions
118
crates/oxc_linter/src/rules/jsx_a11y/tab_index_no_positive.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
use oxc_ast::{ | ||
ast::{Expression, JSXAttributeItem, JSXAttributeValue, JSXExpression, JSXExpressionContainer}, | ||
AstKind, | ||
}; | ||
use oxc_diagnostics::{ | ||
miette::{self, Diagnostic}, | ||
thiserror::Error, | ||
}; | ||
use oxc_macros::declare_oxc_lint; | ||
use oxc_span::Span; | ||
|
||
use crate::{context::LintContext, rule::Rule, utils::has_jsx_prop_lowercase, AstNode}; | ||
|
||
#[derive(Debug, Error, Diagnostic)] | ||
#[error( | ||
"eslint-plugin-jsx-a11y(tab-index-no-positive): Avoid positive integer values for tabIndex." | ||
)] | ||
#[diagnostic(severity(warning), help("Change the tabIndex prop to a non-negative value"))] | ||
struct TabIndexNoPositiveDiagnostic(#[label] pub Span); | ||
|
||
#[derive(Debug, Default, Clone)] | ||
pub struct TabIndexNoPositive; | ||
|
||
declare_oxc_lint!( | ||
/// ### What it does | ||
/// Enforces that positive values for the tabIndex attribute are not used in JSX. | ||
/// | ||
/// ### Why is this bad? | ||
/// Using tabIndex values greater than 0 can make navigation and interaction difficult for keyboard and assistive technology users, disrupting the logical order of content. | ||
/// | ||
/// ### Example | ||
/// ```javascript | ||
/// // Bad | ||
/// <span tabIndex="1">foo</span> | ||
/// | ||
/// // Good | ||
/// <span tabIndex="0">foo</span> | ||
/// <span tabIndex="-1">bar</span> | ||
/// ``` | ||
TabIndexNoPositive, | ||
correctness | ||
); | ||
|
||
impl Rule for TabIndexNoPositive { | ||
fn run<'a>(&self, node: &AstNode<'a>, ctx: &LintContext<'a>) { | ||
let AstKind::JSXOpeningElement(jsx_el) = node.kind() else { return }; | ||
if let Some(tab_index_prop) = has_jsx_prop_lowercase(jsx_el, "tabIndex") { | ||
check_and_diagnose(tab_index_prop, ctx); | ||
} | ||
} | ||
} | ||
|
||
fn check_and_diagnose(attr: &JSXAttributeItem, ctx: &LintContext<'_>) { | ||
match attr { | ||
JSXAttributeItem::Attribute(attr) => attr.value.as_ref().map_or((), |value| { | ||
if let Ok(parsed_value) = parse_jsx_value(value) { | ||
if parsed_value > 0.0 { | ||
ctx.diagnostic(TabIndexNoPositiveDiagnostic(attr.span)); | ||
} | ||
} | ||
}), | ||
JSXAttributeItem::SpreadAttribute(_) => {} | ||
} | ||
} | ||
|
||
fn parse_jsx_value(value: &JSXAttributeValue) -> Result<f64, ()> { | ||
match value { | ||
JSXAttributeValue::StringLiteral(str) => str.value.parse().or(Err(())), | ||
JSXAttributeValue::ExpressionContainer(JSXExpressionContainer { | ||
expression: JSXExpression::Expression(expression), | ||
.. | ||
}) => match expression { | ||
Expression::StringLiteral(str) => str.value.parse().or(Err(())), | ||
Expression::TemplateLiteral(tmpl) => { | ||
tmpl.quasis.get(0).unwrap().value.raw.parse().or(Err(())) | ||
} | ||
Expression::NumberLiteral(num) => Ok(num.value), | ||
_ => Err(()), | ||
}, | ||
_ => Err(()), | ||
} | ||
} | ||
|
||
#[test] | ||
fn test() { | ||
use crate::tester::Tester; | ||
|
||
let pass = vec![ | ||
(r"<div />;", None), | ||
(r"<div {...props} />", None), | ||
(r#"<div id="main" />"#, None), | ||
(r"<div tabIndex={undefined} />", None), | ||
(r"<div tabIndex={`${undefined}`} />", None), | ||
(r"<div tabIndex={`${undefined}${undefined}`} />", None), | ||
(r"<div tabIndex={0} />", None), | ||
(r"<div tabIndex={-1} />", None), | ||
(r"<div tabIndex={null} />", None), | ||
(r"<div tabIndex={bar()} />", None), | ||
(r"<div tabIndex={bar} />", None), | ||
(r#"<div tabIndex={"foobar"} />"#, None), | ||
(r#"<div tabIndex="0" />"#, None), | ||
(r#"<div tabIndex="-1" />"#, None), | ||
(r#"<div tabIndex="-5" />"#, None), | ||
(r#"<div tabIndex="-5.5" />"#, None), | ||
(r"<div tabIndex={-5.5} />", None), | ||
(r"<div tabIndex={-5} />", None), | ||
]; | ||
|
||
let fail = vec![ | ||
(r#"<div tabIndex="1" />"#, None), | ||
(r"<div tabIndex={1} />", None), | ||
(r#"<div tabIndex={"1"} />"#, None), | ||
(r"<div tabIndex={`1`} />", None), | ||
(r"<div tabIndex={1.589} />", None), | ||
]; | ||
|
||
Tester::new(TabIndexNoPositive::NAME, pass, fail).test_and_snapshot(); | ||
} |
40 changes: 40 additions & 0 deletions
40
crates/oxc_linter/src/snapshots/tab_index_no_positive.snap
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
source: crates/oxc_linter/src/tester.rs | ||
expression: tab_index_no_positive | ||
--- | ||
⚠ eslint-plugin-jsx-a11y(tab-index-no-positive): Avoid positive integer values for tabIndex. | ||
╭─[tab_index_no_positive.tsx:1:1] | ||
1 │ <div tabIndex="1" /> | ||
· ──────────── | ||
╰──── | ||
help: Change the tabIndex prop to a non-negative value | ||
|
||
⚠ eslint-plugin-jsx-a11y(tab-index-no-positive): Avoid positive integer values for tabIndex. | ||
╭─[tab_index_no_positive.tsx:1:1] | ||
1 │ <div tabIndex={1} /> | ||
· ──────────── | ||
╰──── | ||
help: Change the tabIndex prop to a non-negative value | ||
|
||
⚠ eslint-plugin-jsx-a11y(tab-index-no-positive): Avoid positive integer values for tabIndex. | ||
╭─[tab_index_no_positive.tsx:1:1] | ||
1 │ <div tabIndex={"1"} /> | ||
· ────────────── | ||
╰──── | ||
help: Change the tabIndex prop to a non-negative value | ||
|
||
⚠ eslint-plugin-jsx-a11y(tab-index-no-positive): Avoid positive integer values for tabIndex. | ||
╭─[tab_index_no_positive.tsx:1:1] | ||
1 │ <div tabIndex={`1`} /> | ||
· ────────────── | ||
╰──── | ||
help: Change the tabIndex prop to a non-negative value | ||
|
||
⚠ eslint-plugin-jsx-a11y(tab-index-no-positive): Avoid positive integer values for tabIndex. | ||
╭─[tab_index_no_positive.tsx:1:1] | ||
1 │ <div tabIndex={1.589} /> | ||
· ──────────────── | ||
╰──── | ||
help: Change the tabIndex prop to a non-negative value | ||
|
||
|