feat(a11y): remove custom rules from a11y config (#65)

P0labrD · Hugauka · web-flow · commit 8fdb40b18c7e · 2023-10-11T15:18:25.000+02:00
* BREAKING CHANGE: remove custom rules from config a11y

* docs: update a11y documentation for removed rules

* fix(example-app): no custom rules in eslint config

---------

Co-authored-by: Hugo K &lt;hugo.khlaut@student-cs.fr&gt;
diff --git a/example-app/.eslintrc b/example-app/.eslintrc
@@ -6,8 +6,5 @@
       "files": ["*.test.tsx"],
       "extends": "plugin:@bam.tech/tests"
     }
-  ],
-  "rules": {
-    "@bam.tech/require-named-effect": "error"
-  }
+  ]
 }
diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md
@@ -82,19 +82,17 @@ This plugin exports some custom rules that you can optionally use in your projec
 
 <!-- begin auto-generated rules list -->
 
-💼 Configurations enabled in.\
-♿ Set in the `a11y` configuration.\
 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
 💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
 
-| Name                                                                                                                                                                                            | Description                                                     | 💼  | 🔧  | 💡  |
-| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------- | :-- | :-- | :-- |
-| [accessibility-props-require-accessible](https://github.com/bamlab/react-native-project-config/blob/main/packages/eslint-plugin/docs/rules/accessibility-props-require-accessible.md)           | Requires accessible prop when accessibility props are defined   | ♿  | 🔧  |     |
-| [do-not-use-role-on-image](https://github.com/bamlab/react-native-project-config/blob/main/packages/eslint-plugin/docs/rules/do-not-use-role-on-image.md)                                       | Disallow role prop on Image component                           | ♿  | 🔧  |     |
-| [image-requires-accessible-prop](https://github.com/bamlab/react-native-project-config/blob/main/packages/eslint-plugin/docs/rules/image-requires-accessible-prop.md)                           | Require accessible prop on image components                     | ♿  | 🔧  | 💡  |
-| [require-named-effect](https://github.com/bamlab/react-native-project-config/blob/main/packages/eslint-plugin/docs/rules/require-named-effect.md)                                               | Enforces the use of named functions inside a useEffect          |     |     |     |
-| [requires-accessibility-label](https://github.com/bamlab/react-native-project-config/blob/main/packages/eslint-plugin/docs/rules/requires-accessibility-label.md)                               | Enforces label when component accessible                        | ♿  |     | 💡  |
-| [requires-accessibility-role-when-accessible](https://github.com/bamlab/react-native-project-config/blob/main/packages/eslint-plugin/docs/rules/requires-accessibility-role-when-accessible.md) | Enforces accessibilityRole or role when component is accessible | ♿  |     | 💡  |
+| Name                                                                                                                                                                                            | Description                                                     | 🔧  | 💡  |
+| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------- | :-- | :-- |
+| [accessibility-props-require-accessible](https://github.com/bamlab/react-native-project-config/blob/main/packages/eslint-plugin/docs/rules/accessibility-props-require-accessible.md)           | Requires accessible prop when accessibility props are defined   | 🔧  |     |
+| [do-not-use-role-on-image](https://github.com/bamlab/react-native-project-config/blob/main/packages/eslint-plugin/docs/rules/do-not-use-role-on-image.md)                                       | Disallow role prop on Image component                           | 🔧  |     |
+| [image-requires-accessible-prop](https://github.com/bamlab/react-native-project-config/blob/main/packages/eslint-plugin/docs/rules/image-requires-accessible-prop.md)                           | Require accessible prop on image components                     | 🔧  | 💡  |
+| [require-named-effect](https://github.com/bamlab/react-native-project-config/blob/main/packages/eslint-plugin/docs/rules/require-named-effect.md)                                               | Enforces the use of named functions inside a useEffect          |     |     |
+| [requires-accessibility-label](https://github.com/bamlab/react-native-project-config/blob/main/packages/eslint-plugin/docs/rules/requires-accessibility-label.md)                               | Enforces label when component accessible                        |     | 💡  |
+| [requires-accessibility-role-when-accessible](https://github.com/bamlab/react-native-project-config/blob/main/packages/eslint-plugin/docs/rules/requires-accessibility-role-when-accessible.md) | Enforces accessibilityRole or role when component is accessible |     | 💡  |
 
 <!-- end auto-generated rules list -->
 
diff --git a/packages/eslint-plugin/docs/rules/accessibility-props-require-accessible.md b/packages/eslint-plugin/docs/rules/accessibility-props-require-accessible.md
@@ -1,7 +1,5 @@
 # Requires accessible prop when accessibility props are defined (`@bam.tech/accessibility-props-require-accessible`)
 
-💼 This rule is enabled in the ♿ `a11y` config.
-
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
 <!-- end auto-generated rule header -->
diff --git a/packages/eslint-plugin/docs/rules/do-not-use-role-on-image.md b/packages/eslint-plugin/docs/rules/do-not-use-role-on-image.md
@@ -1,7 +1,5 @@
 # Disallow role prop on Image component (`@bam.tech/do-not-use-role-on-image`)
 
-💼 This rule is enabled in the ♿ `a11y` config.
-
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
 <!-- end auto-generated rule header -->
diff --git a/packages/eslint-plugin/docs/rules/image-requires-accessible-prop.md b/packages/eslint-plugin/docs/rules/image-requires-accessible-prop.md
@@ -1,7 +1,5 @@
 # Require accessible prop on image components (`@bam.tech/image-requires-accessible-prop`)
 
-💼 This rule is enabled in the ♿ `a11y` config.
-
 🔧💡 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
 
 <!-- end auto-generated rule header -->
diff --git a/packages/eslint-plugin/docs/rules/requires-accessibility-label.md b/packages/eslint-plugin/docs/rules/requires-accessibility-label.md
@@ -1,7 +1,5 @@
 # Enforces label when component accessible (`@bam.tech/requires-accessibility-label`)
 
-💼 This rule is enabled in the ♿ `a11y` config.
-
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
 
 <!-- end auto-generated rule header -->
diff --git a/packages/eslint-plugin/docs/rules/requires-accessibility-role-when-accessible.md b/packages/eslint-plugin/docs/rules/requires-accessibility-role-when-accessible.md
@@ -1,7 +1,5 @@
 # Enforces accessibilityRole or role when component is accessible (`@bam.tech/requires-accessibility-role-when-accessible`)
 
-💼 This rule is enabled in the ♿ `a11y` config.
-
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
 
 <!-- end auto-generated rule header -->
diff --git a/packages/eslint-plugin/lib/configs/a11y.js b/packages/eslint-plugin/lib/configs/a11y.js
@@ -7,10 +7,5 @@ module.exports = defineConfig({
   extends: ["plugin:react-native-a11y/all"],
   rules: {
     "react-native-a11y/has-accessibility-hint": "off",
-    "@bam.tech/image-requires-accessible-prop": "error",
-    "@bam.tech/do-not-use-role-on-image": "error",
-    "@bam.tech/accessibility-props-require-accessible": "error",
-    "@bam.tech/requires-accessibility-role-when-accessible": "error",
-    "@bam.tech/requires-accessibility-label": "error",
   },
 });

Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,5 @@`
`6`	`6`	`"files": ["*.test.tsx"],`
`7`	`7`	`"extends": "plugin:@bam.tech/tests"`
`8`	`8`	`}`
`9`		`- ],`
`10`		`- "rules": {`
`11`		`- "@bam.tech/require-named-effect": "error"`
`12`		`- }`
	`9`	`+ ]`
`13`	`10`	`}`