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(linter): tabindex-no-positive for eslint-plugin-jsx-a11y #1677

Merged
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion crates/oxc_linter/src/rules.rs
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,7 @@ mod jsx_a11y {
pub mod img_redundant_alt;
pub mod no_autofocus;
pub mod scope;
pub mod tab_index_no_positive;
}

mod oxc {
Expand Down Expand Up @@ -439,7 +440,8 @@ oxc_macros::declare_all_lint_rules! {
jsx_a11y::html_has_lang,
jsx_a11y::iframe_has_title,
jsx_a11y::img_redundant_alt,
jsx_a11y::scope,
jsx_a11y::no_autofocus,
jsx_a11y::scope,
jsx_a11y::tab_index_no_positive,
oxc::no_accumulating_spread
}
121 changes: 121 additions & 0 deletions crates/oxc_linter/src/rules/jsx_a11y/tab_index_no_positive.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
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<'a>(attr: &JSXAttributeItem, ctx: &LintContext<'a>) {
match attr {
JSXAttributeItem::Attribute(attr) => match &attr.value {
Some(value) => {
if let Ok(parsed_value) = parse_jsx_value(value) {
if parsed_value > 0.0 {
ctx.diagnostic(TabIndexNoPositiveDiagnostic(attr.span));
}
}
}
_ => {}
},
_ => {}
}
}

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 crates/oxc_linter/src/snapshots/tab_index_no_positive.snap
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


Loading