From 16e355bb06df6f48a7e81427830200708ea610c5 Mon Sep 17 00:00:00 2001
From: LB <mail@lb.ee>
Date: Wed, 23 Oct 2024 13:27:41 +1000
Subject: [PATCH] [feature] Add `labelComponents` glob checks in
 `label-has-associated-control`

Add ability for `labelComponents` within the `label-has-associated-control` to use the same glob checking mechanism as `controlComponents`.

- Ensure existing tests pass and update unit tests for new behaviour
- Add extra tests for documented `???Foo` syntax for component glob matching
- Update documentation to have appropriate examples for label/control glob usage

Closes #972
---
 __tests__/src/rules/label-has-associated-control-test.js | 5 +++++
 docs/rules/label-has-associated-control.md               | 4 ++--
 src/rules/label-has-associated-control.js                | 9 +++++----
 3 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/__tests__/src/rules/label-has-associated-control-test.js b/__tests__/src/rules/label-has-associated-control-test.js
index 6db06739..d3e6a464 100644
--- a/__tests__/src/rules/label-has-associated-control-test.js
+++ b/__tests__/src/rules/label-has-associated-control-test.js
@@ -61,6 +61,8 @@ const htmlForValid = [
   { code: '<CustomLabel htmlFor="js_id" aria-label="A label" />', options: [{ labelComponents: ['CustomLabel'] }] },
   { code: '<CustomLabel htmlFor="js_id" label="A label" />', options: [{ labelAttributes: ['label'], labelComponents: ['CustomLabel'] }] },
   { code: '<CustomLabel htmlFor="js_id" aria-label="A label" />', settings: componentsSettings },
+  { code: '<MUILabel htmlFor="js_id" aria-label="A label" />', options: [{ labelComponents: ['*Label'] }] },
+  { code: '<LabelCustom htmlFor="js_id" label="A label" />', options: [{ labelAttributes: ['label'], labelComponents: ['Label*'] }] },
   // Custom label attributes.
   { code: '<label htmlFor="js_id" label="A label" />', options: [{ labelAttributes: ['label'] }] },
   // Glob support for controlComponents option.
@@ -93,6 +95,7 @@ const nestingValid = [
   // Glob support for controlComponents option.
   { code: '<label><span>A label<CustomInput /></span></label>', options: [{ controlComponents: ['Custom*'] }] },
   { code: '<label><span>A label<CustomInput /></span></label>', options: [{ controlComponents: ['*Input'] }] },
+  { code: '<label><span>A label<TextInput /></span></label>', options: [{ controlComponents: ['????Input'] }] },
   // Rule does not error if presence of accessible label cannot be determined
   { code: '<label><CustomText /><input /></label>' },
 ];
@@ -105,6 +108,7 @@ const bothValid = [
   // Custom label component.
   { code: '<CustomLabel htmlFor="js_id" aria-label="A label"><input /></CustomLabel>', options: [{ labelComponents: ['CustomLabel'] }] },
   { code: '<CustomLabel htmlFor="js_id" label="A label"><input /></CustomLabel>', options: [{ labelAttributes: ['label'], labelComponents: ['CustomLabel'] }] },
+  { code: '<CustomLabel htmlFor="js_id" label="A label"><input /></CustomLabel>', options: [{ labelAttributes: ['label'], labelComponents: ['*Label'] }] },
   { code: '<CustomLabel htmlFor="js_id" aria-label="A label"><input /></CustomLabel>', settings: componentsSettings },
   { code: '<CustomLabel htmlFor="js_id" aria-label="A label"><CustomInput /></CustomLabel>', settings: componentsSettings },
   // Custom label attributes.
@@ -158,6 +162,7 @@ const neverValid = [
   { code: '<div><label>A label</label><input /></div>', errors: [expectedError] },
   // Custom label component.
   { code: '<CustomLabel aria-label="A label" />', options: [{ labelComponents: ['CustomLabel'] }], errors: [expectedError] },
+  { code: '<MUILabel aria-label="A label" />', options: [{ labelComponents: ['???Label'] }], errors: [expectedError] },
   { code: '<CustomLabel label="A label" />', options: [{ labelAttributes: ['label'], labelComponents: ['CustomLabel'] }], errors: [expectedError] },
   { code: '<CustomLabel aria-label="A label" />', settings: componentsSettings, errors: [expectedError] },
   // Custom label attributes.
diff --git a/docs/rules/label-has-associated-control.md b/docs/rules/label-has-associated-control.md
index 9017f3e0..eacab54d 100644
--- a/docs/rules/label-has-associated-control.md
+++ b/docs/rules/label-has-associated-control.md
@@ -103,11 +103,11 @@ This rule takes one optional object argument of type object:
 }
 ```
 
-`labelComponents` is a list of custom React Component names that should be checked for an associated control.
+`labelComponents` is a list of custom React Component names that should be checked for an associated control.[Glob format](https://linuxhint.com/bash_globbing_tutorial/) is also supported for specifying names (e.g., `Label*` matches `LabelComponent` but not `CustomLabel`, `????Label` matches `LinkLabel` but not `CustomLabel`).
 
 `labelAttributes` is a list of attributes to check on the label component and its children for a label. Use this if you have a custom component that uses a string passed on a prop to render an HTML `label`, for example.
 
-`controlComponents` is a list of custom React Components names that will output an input element. [Glob format](https://linuxhint.com/bash_globbing_tutorial/) is also supported for specifying names (e.g., `Label*` matches `LabelComponent` but not `CustomLabel`, `????Label` matches `LinkLabel` but not `CustomLabel`).
+`controlComponents` is a list of custom React Components names that will output an input element. [Glob format](https://linuxhint.com/bash_globbing_tutorial/) is also supported for specifying names (e.g., `Input*` matches `InputCustom` but not `CustomInput`, `????Input` matches `TextInput` but not `CustomInput`).
 
 `assert` asserts that the label has htmlFor, a nested label, both or either. Available options: `'htmlFor', 'nesting', 'both', 'either'`.
 
diff --git a/src/rules/label-has-associated-control.js b/src/rules/label-has-associated-control.js
index 8920e64e..8b3487db 100644
--- a/src/rules/label-has-associated-control.js
+++ b/src/rules/label-has-associated-control.js
@@ -11,6 +11,7 @@
 
 import { hasProp, getProp, getPropValue } from 'jsx-ast-utils';
 import type { JSXElement } from 'ast-types-flow';
+import minimatch from 'minimatch';
 import { generateObjSchema, arraySchema } from '../util/schemas';
 import type { ESLintConfig, ESLintContext, ESLintVisitorSelectorConfig } from '../../flow/eslint';
 import getElementType from '../util/getElementType';
@@ -66,13 +67,13 @@ export default ({
     const options = context.options[0] || {};
     const labelComponents = options.labelComponents || [];
     const assertType = options.assert || 'either';
-    const componentNames = ['label'].concat(labelComponents);
+    const labelComponentNames = ['label'].concat(labelComponents);
     const elementType = getElementType(context);
 
     const rule = (node: JSXElement) => {
-      if (componentNames.indexOf(elementType(node.openingElement)) === -1) {
-        return;
-      }
+      const isLabelComponent = labelComponentNames.some((name) => minimatch(elementType(node.openingElement), name));
+      if (!isLabelComponent) return;
+
       const controlComponents = [
         'input',
         'meter',