feat(rome_js_analyze): noRedundantRoles #4293

unvalley · 2023-03-10T18:06:28Z

Summary

Closes #3939

Test Plan

Added snapshot test cases refer to jsx-a11y/noRedundantRoles and some.

cargo test -p rome_js_analyze -- no_redundant_roles

Documentation

The PR requires documentation
~~I will create a new PR to update the documentation~~ This pr has doc

netlify · 2023-03-10T18:06:34Z

✅ Deploy Preview for docs-rometools canceled.

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`140e143`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-rometools/deploys/6425d3e1d0e2180008abe734

crates/rome_aria/src/roles.rs

unvalley · 2023-03-15T16:02:56Z

crates/rome_aria/src/roles.rs

+    /// Given a element and attributes, it returns the metadata of the element's implicit role.
+    ///
+    /// Check: https://www.w3.org/TR/html-aria/#docconformance
+    pub fn get_implicit_role(


To create this function, I referred to the page commented.
https://www.w3.org/TR/html-aria/#docconformance
And I added some role definition.

ematipico · 2023-03-20T13:38:29Z

crates/rome_aria/src/roles.rs

+            "b" | "bdi" | "bdo" | "body" | "data" | "div" | "hgroup" | "i" | "q" | "samp"
+            | "small" | "span" | "u" => &GenericRole as &dyn AriaRoleDefinition,
+            "header" | "footer" => {
+                // This plugin does not support checking a descendant of an element.


nit: I don't think "plugin" is the correct word in this context... did you mean "crate" by any chance?

ematipico · 2023-03-20T13:43:23Z

crates/rome_aria/src/roles.rs

+        &self,
+        element: &str,
+        // To generate `attributes`, you can use `rome_js_analyze::aria_services::AriaServices::extract_defined_attributes`
+        attributes: HashMap<String, Vec<String>>,


You could pass a reference

Suggested change

attributes: HashMap<String, Vec<String>>,

attributes: &HashMap<String, Vec<String>>,

Since we are not modifying the map

Thanks, I updated the argument.

ematipico · 2023-03-20T13:45:31Z

crates/rome_js_analyze/src/analyzers/nursery/no_redundant_roles.rs

+declare_rule! {
+    /// Enforce explicit `role` property is not the same as implicit/default role property on an element.
+    ///
+    /// EsLint Equivalent: [no-redundant-roles](https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/main/docs/rules/no-redundant-roles.md)


This is not exactly an eslint equivalent, because it comes from a plugin. It's not a "core" eslint rule. Maybe we should rephrase it or remove it

I described the equivalent is eslint-plugin-jsx-a11y at fcae9ed.

nits: And I'd like to update default declare_rule! comment EsLint to ESLint in another PR.

ematipico · 2023-03-20T13:47:17Z

crates/rome_js_analyze/src/analyzers/nursery/no_redundant_roles.rs

+        let node = ctx.query();
+        let aria_roles = ctx.aria_roles();
+
+        if let AnyJsxElement::JsxOpeningElement(_) = &node {


Should we include self closing elements too? I think

<img role="img" />

Should be invalid case and trigger this rule

ematipico · 2023-03-20T13:49:08Z

crates/rome_js_analyze/tests/specs/nursery/noRedundantRoles/invalid.jsx

@@ -0,0 +1,22 @@
+<>
+	<a href="#" role="link"></a>


Self closing tags should be included. Here's the list of tests we had previously: https://github.com/rome/tools/blob/archived-js/internal/compiler/lint/rules/a11y/noRedundantRoles.test.toml

I didn't notice the file! thanks, I'll fix the test case and logic.

This commit has handled self closing tags.
c0526ee

I commented out some test cases, because they (e.g. <td>,<option>, <th>) need to check the ancestors. To handle those, we need to update aria crate.

ematipico · 2023-03-20T13:53:24Z

crates/rome_js_analyze/src/aria_services.rs

@@ -38,6 +39,33 @@ impl AriaServices {
    pub fn iso_language_list(&self) -> &'static [&'static str] {
        languages()
    }
+
+    /// Extracts defined attributes as HashMap (key: attribute name, value: attribute values).
+    pub fn extract_defined_attributes(


nit: maybe extract_attributes is enough? I had to understand what "defined" meant, and the function documentation didn't mention anything.

The documentation should say that only JsxAttribute are mapped! That's an essential piece of information.

The documentation should also mention some transformation going on, so maybe mentioning some code example that shows the final result can help developers.

I agree with all.

renamed to extract_attributes

added some detail to documentation

added test for extract_attributes to show how to use (it's kinda long for rustdoc)

ematipico · 2023-03-20T13:56:57Z

crates/rome_js_analyze/src/aria_services.rs

+                let name = name.to_string().to_lowercase();
+                // handle name only attribute e.g. `<img aria-hidden alt="photo" />`
+                let Some(initializer) = attr.initializer() else {
+                    defined_attributes.entry(name).or_insert(vec!["".to_string()]);


Attributes without a value should have "true" as value.

ematipico · 2023-03-20T13:59:03Z

crates/rome_js_analyze/src/aria_services.rs

+                };
+                let initializer = initializer.value().ok()?;
+                let text = initializer.inner_text_value().ok()??;
+                let text = text.to_lowercase();


Any particular reason why we transform the string? If that's intended, we should make sure to have some test that validates this code path (all tests have lower case attribute values)

Sorry there is no need to transform the string. I removed it.

ematipico · 2023-03-20T14:13:36Z

crates/rome_js_analyze/src/analyzers/nursery/no_redundant_roles.rs

+    let text = text.to_lowercase();
+    let role = text.split(' ').collect::<Vec<&str>>();
+    let role = role.first()?;


Could you explain this part of the code? There's no comment or documentation that explain why we are taking the first part of a split string.

In my view, if a role attribute has multiple values, the first valid role will be used as role. Others are fallbacks.

Platform accessibility APIs traditionally have had a finite set of predefined roles that are expected by assistive technologies on that platform and only one or two roles may be exposed. In contrast, WAI-ARIA allows multiple roles to be specified as an ordered set of space-separated valid role tokens. The additional roles are fallback roles similar to the concept of specifying multiple fonts in case the first choice font type is not supported. https://www.w3.org/TR/2014/REC-wai-aria-implementation-20140320/#mapping_role

I updated the logic to find first valid role with find_map and added a comment.

Wow, that's a fantastic piece of information! That's great!

I wouldn't mind to add this in a code comment, so we don't lose it!

#4293 (comment)

unvalley · 2023-03-23T16:28:19Z

crates/rome_js_analyze/src/aria_analyzers/nursery/no_redundant_roles.rs

+    // If a role attribute has multiple values, the first valid value (specified role) will be used.
+    // Check: https://www.w3.org/TR/2014/REC-wai-aria-implementation-20140320/#mapping_role


yes, I added about that here!

unvalley · 2023-03-27T15:53:06Z

sorry for making the changes after receiving approval, but I've implemented a suggestion fix.

noRedundantRoles: Enforce explicit `role` property is not the same as implicit/default role property on an element. chore: fix equivalent to eslint-plugin-jsx-a11y chore: fix comment plugin to crate

…nction

fix: reduce waste mutation in aria_services fix: handle JsxSelfClosingElement fix: handle input type=text test: update snapshot test: fix test_get_implicit_role test: for extract_attributes refactor: extract_attributes test: update snapshot chore: codegen and remove rule chore: fix for check-ready chore: add comment chore: remove note test: fix waste note chore: update website doc

ematipico · 2023-03-30T17:45:00Z

@unvalley That's great! Could you please update the CHANGELOG.md? https://github.com/rome/tools/blob/main/CONTRIBUTING.md#writing-a-changelog-line

We recently updated the contribution guidelines.

I think something like

- [noRedundantRoles](https://docs.rome.tools/linter/rules/noRedundantRoles)

Should be fine (please double check the link)

unvalley · 2023-03-30T18:39:36Z

@ematipico Thanks, I updated the CHANGELOG.md!

github-actions bot added A-Diagnostic Area: errors and diagnostics A-Linter Area: linter A-Project Area: project configuration and loading labels Mar 10, 2023

unvalley changed the title ~~feat(rome_js_analyze): noRedundantRoles~~ WIP: feat(rome_js_analyze): noRedundantRoles Mar 10, 2023

unvalley commented Mar 11, 2023

View reviewed changes

crates/rome_aria/src/roles.rs Outdated Show resolved Hide resolved

unvalley changed the title ~~WIP: feat(rome_js_analyze): noRedundantRoles~~ feat(rome_js_analyze): noRedundantRoles Mar 14, 2023

unvalley marked this pull request as ready for review March 15, 2023 15:53

unvalley commented Mar 15, 2023

View reviewed changes

unvalley requested a review from ematipico March 15, 2023 16:08

unvalley mentioned this pull request Mar 16, 2023

noAriaUnsupportedElements #3937

Closed

ematipico suggested changes Mar 20, 2023

View reviewed changes

unvalley requested a review from ematipico March 23, 2023 13:29

unvalley commented Mar 23, 2023

View reviewed changes

ematipico approved these changes Mar 27, 2023

View reviewed changes

unvalley added 7 commits March 31, 2023 00:30

feat(rome_js_analyze): noRedundantRoles

aa3fd98

noRedundantRoles: Enforce explicit `role` property is not the same as implicit/default role property on an element. chore: fix equivalent to eslint-plugin-jsx-a11y chore: fix comment plugin to crate

refactor: rename to extract_attributes

35ec3a7

fix: assign true to attributes without value in extract_attributes fu…

9532ddb

…nction

feat: implemented suggest fix

3f0ec86

chore: update website doc

06db609

chore: fix conflict

d35c480

chore: update CHANGELOG.md

140e143

ematipico merged commit d9141a9 into rome:main Mar 30, 2023

unvalley deleted the no-redundant-roles branch March 31, 2023 04:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(rome_js_analyze): noRedundantRoles #4293

feat(rome_js_analyze): noRedundantRoles #4293

unvalley commented Mar 10, 2023 •

edited

Loading

netlify bot commented Mar 10, 2023 •

edited

Loading

unvalley Mar 15, 2023 •

edited

Loading

ematipico Mar 20, 2023

ematipico Mar 20, 2023

unvalley Mar 23, 2023

ematipico Mar 20, 2023

unvalley Mar 21, 2023 •

edited

Loading

ematipico Mar 20, 2023

ematipico Mar 20, 2023

unvalley Mar 21, 2023

unvalley Mar 23, 2023 •

edited

Loading

ematipico Mar 20, 2023 •

edited

Loading

unvalley Mar 23, 2023 •

edited

Loading

ematipico Mar 20, 2023

ematipico Mar 20, 2023

unvalley Mar 23, 2023

ematipico Mar 20, 2023

unvalley Mar 23, 2023

ematipico Mar 23, 2023

unvalley Mar 23, 2023

unvalley Mar 23, 2023

unvalley commented Mar 27, 2023

ematipico commented Mar 30, 2023

unvalley commented Mar 30, 2023 •

edited

Loading

	attributes: HashMap<String, Vec<String>>,
	attributes: &HashMap<String, Vec<String>>,

		// If a role attribute has multiple values, the first valid value (specified role) will be used.
		// Check: https://www.w3.org/TR/2014/REC-wai-aria-implementation-20140320/#mapping_role

feat(rome_js_analyze): noRedundantRoles #4293

feat(rome_js_analyze): noRedundantRoles #4293

Conversation

unvalley commented Mar 10, 2023 • edited Loading

Summary

Test Plan

Documentation

netlify bot commented Mar 10, 2023 • edited Loading

✅ Deploy Preview for docs-rometools canceled.

unvalley Mar 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unvalley Mar 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unvalley Mar 23, 2023 • edited Loading

Choose a reason for hiding this comment

ematipico Mar 20, 2023 • edited Loading

Choose a reason for hiding this comment

unvalley Mar 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unvalley commented Mar 27, 2023

ematipico commented Mar 30, 2023

unvalley commented Mar 30, 2023 • edited Loading

unvalley commented Mar 10, 2023 •

edited

Loading

netlify bot commented Mar 10, 2023 •

edited

Loading

unvalley Mar 15, 2023 •

edited

Loading

unvalley Mar 21, 2023 •

edited

Loading

unvalley Mar 23, 2023 •

edited

Loading

ematipico Mar 20, 2023 •

edited

Loading

unvalley Mar 23, 2023 •

edited

Loading

unvalley commented Mar 30, 2023 •

edited

Loading