Rename rule

Author: khiga8

README.md

@@ -84,7 +84,7 @@ This config will be interpreted in the following way:
 
 | Name                                                                     | Description                                                                                                              | 💼 | 🔧 | ❌  |
 | :----------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------- | :- | :- | :- |
-| [a11y-aria-label-is-readable](docs/rules/a11y-aria-label-is-readable.md) | [aria-label] text should be formatted as you would visible text, in a human-readable format.                             | ⚛️ |    |    |
+| [a11y-aria-label-is-well-formatted](docs/rules/a11y-aria-label-is-well-formatted.md) | [aria-label] text should be formatted as you would visible text, in a human-readable format.                             | ⚛️ |    |    |
 | [a11y-no-generic-link-text](docs/rules/a11y-no-generic-link-text.md)     | disallow generic link text                                                                                               |    |    | ❌  |
 | [array-foreach](docs/rules/array-foreach.md)                             | enforce `for..of` loops over `Array.forEach`                                                                             | ✅  |    |    |
 | [async-currenttarget](docs/rules/async-currenttarget.md)                 | disallow `event.currentTarget` calls inside of async functions                                                           | 🔍 |    |    |

docs/rules/a11y-aria-label-is-readable.md

@@ -0,0 +1,37 @@
+# [aria-label] text should be formatted as you would visible text, in a human-readable format (`github/a11y-aria-label-is-well-formatted`)
+
+💼 This rule is enabled in the ⚛️ `react` config.
+
+<!-- end auto-generated rule header -->
+
+## Rule Details
+
+`[aria-label]` content should be formatted in the same way you would visible text.
+
+Please use sentence case, and avoid using hyphens like you would an ID.
+
+## Resources
+
+## Examples
+
+### **Incorrect** code for this rule 👎
+
+```html
+<a href="..." aria-label="learn more"></a>
+```
+
+```html
+<a href="..." aria-label="go-to-link"></a>
+```
+
+### **Correct** code for this rule 👍
+
+```html
+<a href="..." aria-label="Learn more"></a>
+```
+
+```html
+<a href="..." aria-label="Homepage"></a>
+```
+
+## Version

docs/rules/a11y-aria-label-is-well-formatted.md

@@ -9,7 +9,7 @@ module.exports = {
   extends: ['plugin:jsx-a11y/recommended'],
   rules: {
     'jsx-a11y/role-supports-aria-props': 'off', // Override with github/role-supports-aria-props until https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/issues/910 is resolved
-    'github/a11y-aria-label-is-readable': 'error',
+    'github/a11y-aria-label-is-well-formatted': 'error',
     'github/role-supports-aria-props': 'error',
     'jsx-a11y/no-aria-hidden-on-focusable': 'error',
     'jsx-a11y/anchor-ambiguous-text': [

lib/configs/react.js

@@ -1,7 +1,7 @@
 module.exports = {
   rules: {
     'a11y-no-generic-link-text': require('./rules/a11y-no-generic-link-text'),
-    'a11y-aria-label-is-readable': require('./rules/a11y-aria-label-is-readable'),
+    'a11y-aria-label-is-well-formatted': require('./rules/a11y-aria-label-is-well-formatted'),
     'array-foreach': require('./rules/array-foreach'),
     'async-currenttarget': require('./rules/async-currenttarget'),
     'async-preventdefault': require('./rules/async-preventdefault'),

lib/index.js

@@ -1,4 +1,4 @@
-const rule = require('../lib/rules/a11y-aria-label-is-readable')
+const rule = require('../lib/rules/a11y-aria-label-is-well-formatted')
 const RuleTester = require('eslint').RuleTester
 
 const ruleTester = new RuleTester({
@@ -14,14 +14,12 @@ const ruleTester = new RuleTester({
 const errorMessage =
   '[aria-label] text should be formatted the same as you would visible text. Use sentence case and make sure you are not using hyphens.'
 
-ruleTester.run('a11y-aria-label-is-readable', rule, {
+ruleTester.run('a11y-aria-label-is-well-formatted', rule, {
   valid: [
     {code: "<a aria-labelledby='someId' href='#'>Read more</a>;"},
     {code: "<a aria-label={someName} href='#'>Read more</a>;"},
     {code: "<a aria-label='This is a label'></a>;"},
-    {
-      code: '<Link as="button" href="#">Read more</Link>',
-    },
+    {code: '<Link aria-label="Valid" href="#">Read more</Link>'},
   ],
   invalid: [
     {code: "<a aria-label='close modal'></a>;", errors: [{message: errorMessage}]},