feat(lint): new rule useValidAriaRole

[vasucp1207]

Summary

Closes #526

Configuration
Recommended	✅
Fixable	✅
Fix Kind	🔓

Tasks

• Add options
• Check for custom components

Test Plan

• Snapshots

[ematipico]

Thank you! I am going to block for now while we focus only on bug fixes :)

[nissy-dev]

Thank you for your contributions! I added some comments.

[nissy-dev]

You should add eslint's tests as much as possible
ref: https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/main/__tests__/src/rules/aria-role-test.js

[nissy-dev]

You should add eslint's tests as much as possible
ref: https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/main/__tests__/src/rules/aria-role-test.js

[vasucp1207]

Now it also checks for attr val like "row range" by splitting the string. Also I think some roles are missing roles.rs like tabpanel, treegrid etc, there are 78 in total in wai-aria?

[ematipico]

This is the phrase you want in the documentation, not here. Here, you want to have something like "The role <ROLE_NAME> doesn't exist", or `"The role <ROLE_NAME> is abstract and can't be applied.*

[ematipico]

Suggested change

	"Check "<Hyperlink href="https://www.w3.org/TR/wai-aria/#namefromauthor">"wai-aria"</Hyperlink>" for valid roles or provide options accordingly."
	"Check "<Hyperlink href="https://www.w3.org/TR/wai-aria/#namefromauthor">"WAI-ARIA"</Hyperlink>" for valid roles or provide options accordingly."

[ematipico]

This should be recommended, I think. ARIA rules are very important.

[ematipico]

You created an option, but it seems we are not using it. In order to "wire" an option to Biome, you have to:

1. Add it to the list of rules that have options:
   

   biome/crates/biome_js_analyze/src/options.rs

   Lines 30 to 42 in e6c12c0

   	pub enum PossibleOptions {
   	/// Options for `noExcessiveComplexity` rule
   	Complexity(#[bpaf(external(complexity_options), hide)] ComplexityOptions),
   	/// Options for `useExhaustiveDependencies` and `useHookAtTopLevel` rule
   	Hooks(#[bpaf(external(hooks_options), hide)] HooksOptions),
   	/// Options for `useNamingConvention` rule
   	NamingConvention(#[bpaf(external(naming_convention_options), hide)] NamingConventionOptions),
   	/// Options for `noRestrictedGlobals` rule
   	RestrictedGlobals(#[bpaf(external(restricted_globals_options), hide)] RestrictedGlobalsOptions),
   	/// No options available
   	#[default]
   	NoOptions,
   	}

biome/crates/biome_js_analyze/src/options.rs

Line 54 in e6c12c0

match rule_key.rule_name() {

biome/crates/biome_js_analyze/src/options.rs

Line 155 in e6c12c0

"useExhaustiveDependencies" | "useHookAtTopLevel" => {

2. You must apply all the correct macros, here's an example:
   

   biome/crates/biome_js_analyze/src/semantic_analyzers/style/no_restricted_globals.rs

   Lines 62 to 70 in e6c12c0

   	#[derive(Default, Deserialize, Serialize, Eq, PartialEq, Debug, Clone, Bpaf)]
   	#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
   	#[serde(rename_all = "camelCase", deny_unknown_fields)]
   	pub struct RestrictedGlobalsOptions {
   	/// A list of names that should trigger the rule
   	#[serde(skip_serializing_if = "Option::is_none")]
   	#[bpaf(hide, argument::<String>("NUM"), many, optional)]
   	denied_globals: Option<Vec<String>>,
   	}

3. Apply FromStr, with no fancy implementation
   

   biome/crates/biome_js_analyze/src/semantic_analyzers/style/no_restricted_globals.rs

   Line 77 in e6c12c0

   impl FromStr for RestrictedGlobalsOptions {

4. And apply our internal deserialisation
   

   biome/crates/biome_js_analyze/src/semantic_analyzers/style/no_restricted_globals.rs

   Lines 86 to 109 in e6c12c0

   	impl VisitNode<JsonLanguage> for RestrictedGlobalsOptions {
   	fn visit_member_name(
   	&mut self,
   	node: &SyntaxNode<JsonLanguage>,
   	diagnostics: &mut Vec<DeserializationDiagnostic>,
   	) -> Option<()> {
   	has_only_known_keys(node, Self::KNOWN_KEYS, diagnostics)
   	}
   	fn visit_map(
   	&mut self,
   	key: &SyntaxNode<JsonLanguage>,
   	value: &SyntaxNode<JsonLanguage>,
   	diagnostics: &mut Vec<DeserializationDiagnostic>,
   	) -> Option<()> {
   	let (name, value) = self.get_key_and_value(key, value, diagnostics)?;
   	let name_text = name.text();
   	if name_text == "deniedGlobals" {
   	self.denied_globals = self.map_to_array_of_strings(&value, name_text, diagnostics);
   	}
   	Some(())
   	}
   	}

For testing, the guide should help you: https://github.com/biomejs/biome/blob/main/crates/biome_analyze/CONTRIBUTING.md#rule-configuration

Once you've done this, there are two missing things:

• add documentation comments for allowed_invalid_roles and ignore_non_dom and explain what they do
• update the documentation of this rule by adding the options and explaining them:
  

  biome/crates/biome_js_analyze/src/semantic_analyzers/style/no_restricted_globals.rs

  Lines 35 to 50 in e6c12c0

  	/// ## Options
  	///
  	/// Use the options to specify additional globals that you want to restrict in your
  	/// source code.
  	///
  	/// ```json
  	/// {
  	/// "//": "...",
  	/// "options": {
  	/// "deniedGlobals": ["$", "MooTools"]
  	/// }
  	/// }
  	/// ```
  	///
  	/// In the example above, the rule will emit a diagnostics if tried to use `$` or `MooTools` without
  	/// creating a local variable.

[nissy-dev]

Now it also checks for attr val like "row range" by splitting the string. Also I think some roles are missing roles.rs like tabpanel, treegrid etc, there are 78 in total in wai-aria?

I have created the PR (#629) about this.

[Conaclos]

Don't forget to rebase your work on main. I pushed some changes related to config parsing. In the process I removed visit_member_name. I introduced report_unknown_map_key that you can use directly in visit_map.

[ematipico]

I think we can merge, we should resolve the conflicts

[Conaclos]

Thanks!